ICU 62.1 62.1
ureldatefmt.h
Go to the documentation of this file.
1// © 2016 and later: Unicode, Inc. and others.
2// License & terms of use: http://www.unicode.org/copyright.html
3/*
4*****************************************************************************************
5* Copyright (C) 2016, International Business Machines
6* Corporation and others. All Rights Reserved.
7*****************************************************************************************
8*/
9
10#ifndef URELDATEFMT_H
11#define URELDATEFMT_H
12
13#include "unicode/utypes.h"
14
15#if !UCONFIG_NO_FORMATTING && !UCONFIG_NO_BREAK_ITERATION
16
17#include "unicode/unum.h"
20
50
56
62
63#ifndef U_HIDE_DEPRECATED_API
69#endif /* U_HIDE_DEPRECATED_API */
71
176
218ureldatefmt_open( const char* locale,
219 UNumberFormat* nfToAdopt,
221 UDisplayContext capitalizationContext,
222 UErrorCode* status );
223
230U_STABLE void U_EXPORT2
232
233#if U_SHOW_CPLUSPLUS_API
234
236
247
249
250#endif
251
280U_STABLE int32_t U_EXPORT2
282 double offset,
284 UChar* result,
285 int32_t resultCapacity,
286 UErrorCode* status);
287
316U_STABLE int32_t U_EXPORT2
318 double offset,
320 UChar* result,
321 int32_t resultCapacity,
322 UErrorCode* status);
323
353U_STABLE int32_t U_EXPORT2
355 const UChar * relativeDateString,
356 int32_t relativeDateStringLen,
357 const UChar * timeString,
358 int32_t timeStringLen,
359 UChar* result,
360 int32_t resultCapacity,
361 UErrorCode* status );
362
363#endif /* !UCONFIG_NO_FORMATTING && !UCONFIG_NO_BREAK_ITERATION */
364
365#endif
"Smart pointer" class, closes a URelativeDateTimeFormatter via ureldatefmt_close().
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)
"Smart pointer" definition macro, deletes objects via the closeFunction.
C API: Display context types (enum values)
UDisplayContext
Display context settings.
uint16_t UChar
The base type for UTF-16 code units and pointers.
Definition umachine.h:353
#define U_STABLE
This is used to declare a function as a stable public ICU C API.
Definition umachine.h:111
C API: Compatibility APIs for number formatting.
void * UNumberFormat
A number formatter.
Definition unum.h:141
URelativeDateTimeFormatter * ureldatefmt_open(const char *locale, UNumberFormat *nfToAdopt, UDateRelativeDateTimeFormatterStyle width, UDisplayContext capitalizationContext, UErrorCode *status)
Open a new URelativeDateTimeFormatter object for a given locale using the specified width and capital...
UDateRelativeDateTimeFormatterStyle
The formatting style.
Definition ureldatefmt.h:44
@ UDAT_STYLE_COUNT
One more than the highest normal UDateRelativeDateTimeFormatterStyle value.
Definition ureldatefmt.h:68
@ UDAT_STYLE_LONG
Everything spelled out.
Definition ureldatefmt.h:49
@ UDAT_STYLE_NARROW
Use the shortest possible form.
Definition ureldatefmt.h:61
@ UDAT_STYLE_SHORT
Abbreviations used when possible.
Definition ureldatefmt.h:55
int32_t ureldatefmt_combineDateAndTime(const URelativeDateTimeFormatter *reldatefmt, const UChar *relativeDateString, int32_t relativeDateStringLen, const UChar *timeString, int32_t timeStringLen, UChar *result, int32_t resultCapacity, UErrorCode *status)
Combines a relative date string and a time string in this object's locale.
void ureldatefmt_close(URelativeDateTimeFormatter *reldatefmt)
Close a URelativeDateTimeFormatter object.
URelativeDateTimeUnit
Represents the unit for formatting a relative date.
Definition ureldatefmt.h:77
@ UDAT_REL_UNIT_SATURDAY
Specifies that relative unit is Saturday, e.g.
@ UDAT_REL_UNIT_WEEK
Specifies that relative unit is week, e.g.
@ UDAT_REL_UNIT_SECOND
Specifies that relative unit is second, e.g.
@ UDAT_REL_UNIT_FRIDAY
Specifies that relative unit is Friday, e.g.
@ UDAT_REL_UNIT_DAY
Specifies that relative unit is day, e.g.
@ UDAT_REL_UNIT_COUNT
One more than the highest normal URelativeDateTimeUnit value.
@ UDAT_REL_UNIT_MONTH
Specifies that relative unit is month, e.g.
Definition ureldatefmt.h:95
@ UDAT_REL_UNIT_SUNDAY
Specifies that relative unit is Sunday, e.g.
@ UDAT_REL_UNIT_WEDNESDAY
Specifies that relative unit is Wednesday, e.g.
@ UDAT_REL_UNIT_QUARTER
Specifies that relative unit is quarter, e.g.
Definition ureldatefmt.h:89
@ UDAT_REL_UNIT_HOUR
Specifies that relative unit is hour, e.g.
@ UDAT_REL_UNIT_MINUTE
Specifies that relative unit is minute, e.g.
@ UDAT_REL_UNIT_TUESDAY
Specifies that relative unit is Tuesday, e.g.
@ UDAT_REL_UNIT_THURSDAY
Specifies that relative unit is Thursday, e.g.
@ UDAT_REL_UNIT_MONDAY
Specifies that relative unit is Monday, e.g.
@ UDAT_REL_UNIT_YEAR
Specifies that relative unit is year, e.g.
Definition ureldatefmt.h:83
int32_t ureldatefmt_formatNumeric(const URelativeDateTimeFormatter *reldatefmt, double offset, URelativeDateTimeUnit unit, UChar *result, int32_t resultCapacity, UErrorCode *status)
Format a combination of URelativeDateTimeUnit and numeric offset using a numeric style,...
struct URelativeDateTimeFormatter URelativeDateTimeFormatter
C typedef for struct URelativeDateTimeFormatter.
int32_t ureldatefmt_format(const URelativeDateTimeFormatter *reldatefmt, double offset, URelativeDateTimeUnit unit, UChar *result, int32_t resultCapacity, UErrorCode *status)
Format a combination of URelativeDateTimeUnit and numeric offset using a text style if possible,...
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers,...
Definition utypes.h:396
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition uversion.h:138
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition uversion.h:137