Movatterモバイル変換

Copy constructor.

Stable:

ICU 50

Destructor.

Stable:

ICU 50

Constructs aTimeZoneFormat object for the specified locale.

Parameters

locale	the locale
status	receives the status.

Stable:

ICU 50

Sets the time zone display name data to this format instance.

The caller should not delete the TimeZoenNames object after it is adopted by this call.

Parameters

tznames

TimeZoneNames object to be adopted.

Stable:

ICU 50

Clone this object polymorphically.

The caller is responsible for deleting the result when done.

Returns

A copy of the object

Stable:

ICU 50

Implementsicu::Format.

Creates an instance ofTimeZoneFormat for the given locale.

Parameters

locale	The locale.
status	Receives the status.

Returns

An instance ofTimeZoneFormat for the given locale, owned by the caller.

Stable:

ICU 50

Format an object to produce a time zone display string using localized GMT offset format.

This method handlesFormattable objects with aTimeZone. If a theFormattable object type is not aTimeZone, then it returns a failing UErrorCode.

Parameters

obj	The object to format. Must be aTimeZone.
appendTo	Output parameter to receive result. Result is appended to existing contents.
pos	On input: an alignment field, if desired. On output: the offsets of the alignment field.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 50

Implementsicu::Format.

Format an object to produce a string.

This is a pure virtual method which subclasses must implement. This method allows polymorphic formatting ofFormattable objects. If a subclass ofFormat receives aFormattable object type it doesn't handle (e.g., if a numericFormattable is passed to aDateFormat object) then it returns a failing UErrorCode.

Parameters

obj	The object to format.
appendTo	Output parameter to receive result. Result is appended to existing contents.
pos	On input: an alignment field, if desired. On output: the offsets of the alignment field.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.0

Format an object to produce a string.

Subclasses should override this method. This method allows polymorphic formatting ofFormattable objects. If a subclass ofFormat receives aFormattable object type it doesn't handle (e.g., if a numericFormattable is passed to aDateFormat object) then it returns a failing UErrorCode.

Parameters

obj	The object to format.
appendTo	Output parameter to receive result. Result is appended to existing contents.
posIter	On return, can be used to iterate over positions of fields generated by this format call.
status	Output param filled with success/failure status.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 4.4

Formats an object to produce a string.

Parameters

obj	The object to format.
appendTo	Output parameter to receive result. Result is appended to existing contents.
status	Output parameter filled in with success or failure status.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.0

Returns the display name of the time zone at the given date for the style.

Parameters

style	The style (e.g.UTZFMT_STYLE_GENERIC_LONG,UTZFMT_STYLE_LOCALIZED_GMT...)
tz	The time zone.
date	The date.
name	Receives the display name.
timeType	the output argument for receiving the time type (standard/daylight/unknown) used for the display name, or nullptr if the information is not necessary.

Returns

A reference to the result

See also

UTimeZoneFormatStyle

UTimeZoneFormatTimeType

Stable:

ICU 50

Returns the ISO 8601 basic time zone string for the given offset.

For example, "-08", "-0830" and "Z"

Parameters

offset	the offset from GMT(UTC) in milliseconds.
useUtcIndicator	true if ISO 8601 UTC indicator "Z" is used when the offset is 0.
isShort	true if shortest form is used.
ignoreSeconds	true if non-zero offset seconds is appended.
result	Receives the ISO format string.
status	Receives the status

Returns

the ISO 8601 basic format.

See also

formatOffsetISO8601Extended

parseOffsetISO8601

Stable:

ICU 51

Returns the ISO 8601 extended time zone string for the given offset.

For example, "-08:00", "-08:30" and "Z"

Parameters

offset	the offset from GMT(UTC) in milliseconds.
useUtcIndicator	true if ISO 8601 UTC indicator "Z" is used when the offset is 0.
isShort	true if shortest form is used.
ignoreSeconds	true if non-zero offset seconds is appended.
result	Receives the ISO format string.
status	Receives the status

Returns

the ISO 8601 basic format.

See also

formatOffsetISO8601Extended

parseOffsetISO8601

Stable:

ICU 51

Returns the localized GMT(UTC) offset format for the given offset.

The localized GMT offset is defined by;

• GMT format pattern (e.g. "GMT {0}" - seegetGMTPattern)
• Offset time pattern (e.g. "+HH:mm" - seegetGMTOffsetPattern)
• Offset digits (e.g. "0123456789" - seegetGMTOffsetDigits)
• GMT zero format (e.g. "GMT" - seegetGMTZeroFormat)

This format always uses 2 digit hours and minutes. When the given offset has non-zero seconds, 2 digit seconds field will be appended. For example, GMT+05:00 and GMT+05:28:06.

Parameters

offset	the offset from GMT(UTC) in milliseconds.
status	Receives the status
result	Receives the localized GMT format string.

Returns

A reference to the result.

See also

parseOffsetLocalizedGMT

Stable:

ICU 50

Returns the short localized GMT(UTC) offset format for the given offset.

The short localized GMT offset is defined by;

• GMT format pattern (e.g. "GMT {0}" - seegetGMTPattern)
• Offset time pattern (e.g. "+HH:mm" - seegetGMTOffsetPattern)
• Offset digits (e.g. "0123456789" - seegetGMTOffsetDigits)
• GMT zero format (e.g. "GMT" - seegetGMTZeroFormat)

This format uses the shortest representation of offset. The hours field does not have leading zero and lower fields with zero will be truncated. For example, GMT+5 and GMT+530.

Parameters

offset	the offset from GMT(UTC) in milliseconds.
status	Receives the status
result	Receives the short localized GMT format string.

Returns

A reference to the result.

See also

parseOffsetShortLocalizedGMT

Stable:

ICU 51

Returns the bitwise flags of UTimeZoneFormatParseOption representing the default parse options used by this object.

Returns

the default parse options.

See also

ParseOption

Stable:

ICU 50

ICU "poor man's RTTI", returns a UClassID for the actual class.

Stable:

ICU 50

Reimplemented fromicu::UObject.

Returns the decimal digit characters used for localized GMT format.

The return string contains exactly 10 code points (may include Unicode supplementary character) representing digit 0 to digit 9 in the ascending order.

Parameters

digits

Receives the decimal digits used for localized GMT format.

See also

setGMTOffsetDigits

Stable:

ICU 50

Returns the offset pattern used for localized GMT format.

Parameters

type	The offset pattern type enum.
pattern	Receives the offset pattern.

Returns

A reference to the result pattern.

See also

setGMTOffsetPattern

Stable:

ICU 50

Returns the localized GMT format pattern.

Parameters

pattern

Receives the localized GMT format pattern.

Returns

A reference to the result pattern.

See also

setGMTPattern

Stable:

ICU 50

Returns the localized GMT format string for GMT(UTC) itself (GMT offset is 0).

Parameters

gmtZeroFormat

Receives the localized GMT string string for GMT(UTC) itself.

Returns

A reference to the result GMT string.

See also

setGMTZeroFormat

Stable:

ICU 50

ICU "poor man's RTTI", returns a UClassID for this class.

Stable:

ICU 50

Returns the time zone display name data used by this instance.

Returns

The time zone display name data.

Stable:

ICU 50

Assignment operator.

Stable:

ICU 50

Return true if the givenFormat objects are semantically equal.

Objects of different subclasses are considered unequal.

Parameters

other

The object to be compared with.

Returns

Return true if the givenFormat objects are semantically equal. Objects of different subclasses are considered unequal.

Stable:

ICU 50

Implementsicu::Format.

Returns aTimeZone by parsing the time zone string according to the given parse position, the specified format style and parse options.

Parameters

text	The text contains a time zone string at the position.
style	The format style
pos	The position.
parseOptions	The parse options represented by bitwise flags of UTimeZoneFormatParseOption.
timeType	The output argument for receiving the time type (standard/daylight/unknown), or nullptr if the information is not necessary.

Returns

ATimeZone, or null if the input could not be parsed.

See also

UTimeZoneFormatStyle

UTimeZoneFormatParseOption

UTimeZoneFormatTimeType

Stable:

ICU 50

Returns aTimeZone by parsing the time zone string according to the given parse position, the specified format style and the default parse options.

Parameters

text	The text contains a time zone string at the position.
style	The format style
pos	The position.
timeType	The output argument for receiving the time type (standard/daylight/unknown), or nullptr if the information is not necessary.

Returns

ATimeZone, or null if the input could not be parsed.

See also

UTimeZoneFormatStyle

UTimeZoneFormatParseOption

UTimeZoneFormatTimeType

Stable:

ICU 50

Parse a string to produce an object.

This methods handles parsing of time zone display strings intoFormattable objects withTimeZone.

Parameters

source	The string to be parsed into an object.
result	Formattable to be set to the parse result. If parse fails, return contents are undefined.
parse_pos	The position to start parsing at. Upon return this param is set to the position after the last character successfully parsed. If the source is not parsed successfully, this param will remain unchanged.

Returns

A newly created Formattable* object, or nullptr on failure. The caller owns this and should delete it when done.

Stable:

ICU 50

Implementsicu::Format.

Returns offset from GMT(UTC) in milliseconds for the given ISO 8601 style time zone string.

When the given string is not an ISO 8601 time zone string, this method sets the current position as the error index toParsePosition pos and returns 0.

Parameters

text	The text contains ISO8601 style time zone string (e.g. "-08:00", "Z") at the position.
pos	TheParsePosition object.

Returns

The offset from GMT(UTC) in milliseconds for the given ISO 8601 style time zone string.

See also

formatOffsetISO8601Basic

formatOffsetISO8601Extended

Stable:

ICU 50

Returns offset from GMT(UTC) in milliseconds for the given localized GMT offset format string.

When the given string cannot be parsed, this method sets the current position as the error index toParsePosition pos and returns 0.

Parameters

text	The text contains a localized GMT offset string at the position.
pos	TheParsePosition object.

Returns

The offset from GMT(UTC) in milliseconds for the given localized GMT offset format string.

See also

formatOffsetLocalizedGMT

Stable:

ICU 50

Returns offset from GMT(UTC) in milliseconds for the given short localized GMT offset format string.

When the given string cannot be parsed, this method sets the current position as the error index toParsePosition pos and returns 0.

Parameters

text	The text contains a short localized GMT offset string at the position.
pos	TheParsePosition object.

Returns

The offset from GMT(UTC) in milliseconds for the given short localized GMT offset format string.

See also

formatOffsetShortLocalizedGMT

Stable:

ICU 51

Sets the default parse options.

Note: By default, an instance ofTimeZoneFormat created bycreateInstance has no parse options set (UTZFMT_PARSE_OPTION_NONE). To specify multiple options, use bitwise flags of UTimeZoneFormatParseOption.

See also

UTimeZoneFormatParseOption

Stable:

ICU 50

Sets the decimal digit characters used for localized GMT format.

The inputdigits must contain exactly 10 code points (Unicode supplementary characters are also allowed) representing digit 0 to digit 9 in the ascending order. When the inputdigits does not satisfy the condition,U_ILLEGAL_ARGUMENT_ERROR will be set to the return status.

Parameters

digits	The decimal digits used for localized GMT format.
status	Receives the status.

See also

getGMTOffsetDigits

Stable:

ICU 50

Sets the offset pattern for the given offset type.

Parameters

type	The offset pattern type enum.
pattern	The offset pattern used for localized GMT format for the type.
status	Receives the status.

See also

getGMTOffsetPattern

Stable:

ICU 50

Sets the localized GMT format pattern.

The pattern must contain a single argument {0}, for example "GMT {0}".

Parameters

pattern	The localized GMT format pattern to be used by this object.
status	Receives the status.

See also

getGMTPattern

Stable:

ICU 50

Sets the localized GMT format string for GMT(UTC) itself (GMT offset is 0).

Parameters

gmtZeroFormat	The localized GMT format string for GMT(UTC).
status	Receives the status.

See also

getGMTZeroFormat

Stable:

ICU 50

Sets the time zone display name data to this format instance.

Parameters

tznames

TimeZoneNames object to be set.

Stable:

ICU 50