tzfmt.h File Reference

C++ API: TimeZoneFormat. More...

#include "unicode/utypes.h"
#include "unicode/format.h"
#include "unicode/timezone.h"
#include "unicode/tznames.h"

Go to the source code of this file.

Data Structures
class	TimeZoneFormat
	TimeZoneFormat supports time zone display name formatting and parsing. More...

Typedefs
typedef enum UTimeZoneFormatStyle	UTimeZoneFormatStyle
	Constants for time zone display format style used by format/parse APIs in TimeZoneFormat.
typedef enum UTimeZoneFormatGMTOffsetPatternType	UTimeZoneFormatGMTOffsetPatternType
	Constants for GMT offset pattern types.
typedef enum UTimeZoneFormatTimeType	UTimeZoneFormatTimeType
	Constants for time types used by TimeZoneFormat APIs for receiving time type (standard time, daylight time or unknown).
typedef enum UTimeZoneFormatParseOption	UTimeZoneFormatParseOption
	Constants for parse option flags, used for specifying optional parse behavior.

Enumerations
enum	UTimeZoneFormatStyle {   UTZFMT_STYLE_GENERIC_LOCATION , UTZFMT_STYLE_GENERIC_LONG , UTZFMT_STYLE_GENERIC_SHORT , UTZFMT_STYLE_SPECIFIC_LONG ,   UTZFMT_STYLE_SPECIFIC_SHORT , UTZFMT_STYLE_RFC822 , UTZFMT_STYLE_LOCALIZED_GMT , UTZFMT_STYLE_ISO8601 }
	Constants for time zone display format style used by format/parse APIs in TimeZoneFormat. More...
enum	UTimeZoneFormatGMTOffsetPatternType { UTZFMT_PAT_POSITIVE_HM , UTZFMT_PAT_POSITIVE_HMS , UTZFMT_PAT_NEGATIVE_HM , UTZFMT_PAT_NEGATIVE_HMS }
	Constants for GMT offset pattern types. More...
enum	UTimeZoneFormatTimeType { UTZFMT_TIME_TYPE_UNKNOWN , UTZFMT_TIME_TYPE_STANDARD , UTZFMT_TIME_TYPE_DAYLIGHT }
	Constants for time types used by TimeZoneFormat APIs for receiving time type (standard time, daylight time or unknown). More...
enum	UTimeZoneFormatParseOption { UTZFMT_PARSE_OPTION_NONE = 0x00 , UTZFMT_PARSE_OPTION_ALL_STYLES = 0x01 }
	Constants for parse option flags, used for specifying optional parse behavior. More...

Detailed Description

C++ API: TimeZoneFormat.

Definition in file tzfmt.h.

Typedef Documentation

UTimeZoneFormatGMTOffsetPatternType

typedef enum UTimeZoneFormatGMTOffsetPatternType UTimeZoneFormatGMTOffsetPatternType

Constants for GMT offset pattern types.

Draft

This API may be changed in the future versions and was introduced in ICU 50

UTimeZoneFormatParseOption

typedef enum UTimeZoneFormatParseOption UTimeZoneFormatParseOption

Constants for parse option flags, used for specifying optional parse behavior.

Draft

This API may be changed in the future versions and was introduced in ICU 50

UTimeZoneFormatStyle

typedef enum UTimeZoneFormatStyle UTimeZoneFormatStyle

Constants for time zone display format style used by format/parse APIs in TimeZoneFormat.

Draft

This API may be changed in the future versions and was introduced in ICU 50

UTimeZoneFormatTimeType

typedef enum UTimeZoneFormatTimeType UTimeZoneFormatTimeType

Constants for time types used by TimeZoneFormat APIs for receiving time type (standard time, daylight time or unknown).

Draft

This API may be changed in the future versions and was introduced in ICU 50

Enumeration Type Documentation

UTimeZoneFormatGMTOffsetPatternType

enum UTimeZoneFormatGMTOffsetPatternType

Constants for GMT offset pattern types.

Draft

This API may be changed in the future versions and was introduced in ICU 50

Enumerator
UTZFMT_PAT_POSITIVE_HM	Positive offset with hour and minute fields. Draft This API may be changed in the future versions and was introduced in ICU 50
UTZFMT_PAT_POSITIVE_HMS	Positive offset with hour, minute and second fields. Draft This API may be changed in the future versions and was introduced in ICU 50
UTZFMT_PAT_NEGATIVE_HM	Negative offset with hour and minute fields. Draft This API may be changed in the future versions and was introduced in ICU 50
UTZFMT_PAT_NEGATIVE_HMS	Negative offset with hour, minute and second fields. Draft This API may be changed in the future versions and was introduced in ICU 50

Definition at line 77 of file tzfmt.h.

UTimeZoneFormatParseOption

enum UTimeZoneFormatParseOption

Constants for parse option flags, used for specifying optional parse behavior.

Draft

This API may be changed in the future versions and was introduced in ICU 50

Enumerator
UTZFMT_PARSE_OPTION_NONE	No option. Draft This API may be changed in the future versions and was introduced in ICU 50
UTZFMT_PARSE_OPTION_ALL_STYLES	When a time zone display name is not found within a set of display names used for the specified style, look for the name from display names used by other styles. Draft This API may be changed in the future versions and was introduced in ICU 50

Definition at line 127 of file tzfmt.h.

UTimeZoneFormatStyle

enum UTimeZoneFormatStyle

Constants for time zone display format style used by format/parse APIs in TimeZoneFormat.

Draft

This API may be changed in the future versions and was introduced in ICU 50

Enumerator
UTZFMT_STYLE_GENERIC_LOCATION	Generic location format, such as "United States Time (New York)", "Italy Time". Draft This API may be changed in the future versions and was introduced in ICU 50
UTZFMT_STYLE_GENERIC_LONG	Generic long non-location format, such as "Eastern Time". Draft This API may be changed in the future versions and was introduced in ICU 50
UTZFMT_STYLE_GENERIC_SHORT	Generic short non-location format, such as "ET". Draft This API may be changed in the future versions and was introduced in ICU 50
UTZFMT_STYLE_SPECIFIC_LONG	Specific long format, such as "Eastern Standard Time". Draft This API may be changed in the future versions and was introduced in ICU 50
UTZFMT_STYLE_SPECIFIC_SHORT	Specific short format, such as "EST", "PDT". Draft This API may be changed in the future versions and was introduced in ICU 50
UTZFMT_STYLE_RFC822	RFC822 format, such as "-0500". Draft This API may be changed in the future versions and was introduced in ICU 50
UTZFMT_STYLE_LOCALIZED_GMT	Localized GMT offset format, such as "GMT-05:00", "UTC+0100". Draft This API may be changed in the future versions and was introduced in ICU 50
UTZFMT_STYLE_ISO8601	ISO 8601 format (extended), such as "-05:00", "Z"(UTC) Draft This API may be changed in the future versions and was introduced in ICU 50

Definition at line 30 of file tzfmt.h.

UTimeZoneFormatTimeType

enum UTimeZoneFormatTimeType

Constants for time types used by TimeZoneFormat APIs for receiving time type (standard time, daylight time or unknown).

Draft

This API may be changed in the future versions and was introduced in ICU 50

Enumerator
UTZFMT_TIME_TYPE_UNKNOWN	Unknown. Draft This API may be changed in the future versions and was introduced in ICU 50
UTZFMT_TIME_TYPE_STANDARD	Standard time. Draft This API may be changed in the future versions and was introduced in ICU 50
UTZFMT_TIME_TYPE_DAYLIGHT	Daylight saving time. Draft This API may be changed in the future versions and was introduced in ICU 50

Definition at line 105 of file tzfmt.h.