Movatterモバイル変換

Enum type for kMaxFormat.

Obsolete:

ICU 3.0. The 10-argument limit was removed as of ICU 2.6, rendering this enum type obsolete.

Definition at line353 of filemsgfmt.h.

Constructs a newMessageFormat using the given pattern and the default locale.

Parameters

pattern	Pattern used to construct object.
status	Input/output error code. If the pattern cannot be parsed, set to failure code.

Stable:

ICU 2.0

Constructs a newMessageFormat using the given pattern and locale.

Parameters

pattern	Pattern used to construct object.
newLocale	The locale to use for formatting dates and numbers.
status	Input/output error code. If the pattern cannot be parsed, set to failure code.

Stable:

ICU 2.0

Constructs a newMessageFormat using the given pattern and locale.

Parameters

pattern	Pattern used to construct object.
newLocale	The locale to use for formatting dates and numbers.
parseError	Struct to receive information on the position of an error within the pattern.
status	Input/output error code. If the pattern cannot be parsed, set to failure code.

Stable:

ICU 2.0

Constructs a newMessageFormat from an existing one.

Stable:

ICU 2.0

Destructor.

Stable:

ICU 2.0

Sets one subformat for given format name.

See the class description about format name. This function supports both named and numbered arguments– if numbered, the formatName is the corresponding UnicodeStrings (e.g. "0", "1", "2"...). If there is no matched formatName or wrong type, the item will be ignored. The caller should not delete theFormat object after this call.

Parameters

formatName	Name of the subformat.
formatToAdopt	Format to be adopted.
status	output param set to success/failure code.

Stable:

ICU 4.0

Sets one subformat.

See the class description about format numbering. The caller should not delete theFormat object after this call. If the number is over the number of formats already set, the item will be deleted and ignored.

If this format uses named arguments, the new format is discarded and this format remains unchanged.

Stable:

ICU 2.0

Parameters

formatNumber	index of the subformat.
formatToAdopt	the format to be adopted.

Sets subformats.

See the class description about format numbering. The caller should not delete theFormat objects after this call.The array formatsToAdopt is not itself adopted. Its ownership is retained by the caller. If the call fails because memory cannot be allocated, then the formats will be deleted by this method, and this object will remain unchanged.

If this format uses named arguments, the new formats are discarded and this format remains unchanged.

Stable:

ICU 2.0

Parameters

formatsToAdopt	the format to be adopted.
count	the size of the array.

Applies the given pattern string to this message format.

Parameters

pattern	The pattern to be applied.
status	Input/output error code. If the pattern cannot be parsed, set to failure code.

Stable:

ICU 2.0

Sets the UMessagePatternApostropheMode and the pattern used by this message format.

Parses the pattern and cachesFormat objects for simple argument types. Patterns and their interpretation are specified in theclass description.

This method is best used only once on a given object to avoid confusion about the mode, and after constructing the object with an empty pattern string to minimize overhead.

Parameters

pattern	The pattern to be applied.
aposMode	The new apostrophe mode.
parseError	Struct to receive information on the position of an error within the pattern. Can be nullptr.
status	Input/output error code. If the pattern cannot be parsed, set to failure code.

Stable:

ICU 4.8

Applies the given pattern string to this message format.

Parameters

pattern	The pattern to be applied.
parseError	Struct to receive information on the position of an error within the pattern.
status	Input/output error code. If the pattern cannot be parsed, set to failure code.

Stable:

ICU 2.0

Convert an 'apostrophe-friendly' pattern into a standard pattern.

Standard patterns treat all apostrophes as quotes, which is problematic in some languages, e.g. French, where apostrophe is commonly used. This utility assumes that only an unpaired apostrophe immediately before a brace is a true quote. Other unpaired apostrophes are paired, and the resulting standard pattern string is returned.

Note it is not guaranteed that the returned pattern is indeed a valid pattern. The only effect is to convert between patterns having different quoting semantics.

Parameters

pattern	the 'apostrophe-friendly' patttern to convert
status	Input/output error code. If the pattern cannot be parsed, the failure code is set.

Returns

the standard equivalent of the original pattern

Stable:

ICU 3.4

Clones thisFormat object polymorphically.

The caller owns the result and should delete it when done.

Stable:

ICU 2.0

Implementsicu::Format.

Compares twoFormat objects.

This is used for constructing the hash tables.

Parameters

left	pointer to aFormat object. Must not be nullptr.
right	pointer to aFormat object. Must not be nullptr.

Returns

whether the two objects are the same

Internal:

Do not use. This API is for internal use only.

Formats the given array of arguments into a user-readable string.

The array must be stored within a singleFormattable object of type kArray. If theFormattable object type is not of type kArray, then returns a failing UErrorCode.

If this format uses named arguments, appendTo is unchanged and status is set to U_ILLEGAL_ARGUMENT_ERROR.

Parameters

obj	AFormattable of type kArray containing arguments to be formatted.
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	Input/output error code. If the pattern cannot be parsed, set to failure code.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.0

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

Formats the given array of arguments into a user-readable string.

Does not take ownership of the Formattable* array or its contents.

If this format uses named arguments, appendTo is unchanged and status is set to U_ILLEGAL_ARGUMENT_ERROR.

Parameters

source	An array of objects to be formatted.
count	The number of elements of 'source'.
appendTo	Output parameter to receive result. Result is appended to existing contents.
ignore	Not used; inherited from base class API.
status	Input/output error code. If the pattern cannot be parsed, set to failure code.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.0

Formats the given array of arguments into a user-readable string using the given pattern.

If this format uses named arguments, appendTo is unchanged and status is set to U_ILLEGAL_ARGUMENT_ERROR.

Parameters

pattern	The pattern.
arguments	An array of objects to be formatted.
count	The number of elements of 'source'.
appendTo	Output parameter to receive result. Result is appended to existing contents.
status	Input/output error code. If the pattern cannot be parsed, set to failure code.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.0

Formats the given array of arguments into a user-defined argument name array.

This function supports both named and numbered arguments– if numbered, the formatName is the corresponding UnicodeStrings (e.g. "0", "1", "2"...).

Parameters

argumentNames	argument name array
arguments	An array of objects to be formatted.
count	The number of elements of 'argumentNames' and arguments. The number of argumentNames and arguments must be the same.
appendTo	Output parameter to receive result. Result is appended to existing contents.
status	Input/output error code. If the pattern cannot be parsed, set to failure code.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 4.0

Returns

this instance's UMessagePatternApostropheMode.

Stable:

ICU 4.8

Definition at line496 of filemsgfmt.h.

This API is for ICU internal use only.

Please do not use it.

Returns argument types count in the parsed pattern. Used to distinguish pattern "{0} d" and "d".

Returns

The number of formattable types in the pattern

Internal:

Do not use. This API is for internal use only.

Returns a unique class ID POLYMORPHICALLY.

Pure virtual override. This method is to implement a simple version of RTTI, since not all C++ compilers support genuine RTTI. Polymorphicoperator==() andclone() methods call this method.

Returns

The class ID for this object. All objects of a given class have the same class ID. Objects of other classes have different class IDs.

Stable:

ICU 2.0

Reimplemented fromicu::UObject.

Gets subformat pointer for given format name.

This function supports both named and numbered arguments. If numbered, the formatName is the corresponding UnicodeStrings (e.g. "0", "1", "2"...). The returnedFormat object should not be deleted by the caller, nor should the pointer of other object . The pointer and its contents remain valid only until the next call to any method of this class is made with this object.

Parameters

formatName	the name or number specifying a format
status	output param set to success/failure code.

Stable:

ICU 4.0

Gets format names.

This function returns formatNames in StringEnumerations which can be used withgetFormat() andsetFormat() to export formattable array from currentMessageFormat to another. It is the caller's responsibility to delete the returned formatNames.

Parameters

status

output param set to success/failure code.

Stable:

ICU 4.0

Gets an array of subformats of this object.

The returned array should not be deleted by the caller, nor should the pointers within the array. The array and its contents remain valid only until the next call to this format. See the class description about format numbering.

Parameters

count

output parameter to receive the size of the array

Returns

an array of count Format* objects, or nullptr if out of memory. Any or all of the array elements may be nullptr.

Stable:

ICU 2.0

Gets the locale used for creating argumentFormat objects.

format information.

Returns

the locale of the object.

Stable:

ICU 2.0

Return the class ID for this class.

This is useful only for comparing to a return value fromgetDynamicClassID(). For example:

.   Base* polymorphic_pointer = createPolymorphicObject();.   if (polymorphic_pointer->getDynamicClassID() ==.      Derived::getStaticClassID()) ...

Returns

The class ID for all objects of this class.

Stable:

ICU 2.0

Assignment operator.

Stable:

ICU 2.0

Returns true if the givenFormat objects are semantically equal.

Objects of different subclasses are considered unequal.

Parameters

other

the object to be compared with.

Returns

true if the givenFormat objects are semantically equal.

Stable:

ICU 2.0

Implementsicu::Format.

Parses the given string into an array of output arguments.

If this format uses named arguments, status is set to U_ARGUMENT_TYPE_MISMATCH.

Parameters

source	String to be parsed.
count	Output param to receive size of returned array.
status	Input/output error code. If the pattern cannot be parsed, set to failure code.

Returns

an array of parsed arguments. The caller owns both the array and its contents. Returns nullptr if status is not U_ZERO_ERROR.

Stable:

ICU 2.0

Parses the given string into an array of output arguments.

Parameters

source	String to be parsed.
pos	On input, starting position for parse. On output, final position after parse. Unchanged if parse fails.
count	Output parameter to receive the number of arguments parsed.

Returns

an array of parsed arguments. The caller owns both the array and its contents.

Stable:

ICU 2.0

Parses the given string into an array of output arguments stored within a singleFormattable of type kArray.

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.
pos	On input, starting position for parse. On output, final position after parse. Unchanged if parse fails.

Stable:

ICU 2.0

Implementsicu::Format.

Sets one subformat for given format name.

See the class description about format name. This function supports both named and numbered arguments– if numbered, the formatName is the corresponding UnicodeStrings (e.g. "0", "1", "2"...). If there is no matched formatName or wrong type, the item will be ignored.

Parameters

formatName	Name of the subformat.
format	the format to be set.
status	output param set to success/failure code.

Stable:

ICU 4.0

Sets one subformat.

See the class description about format numbering. If the number is over the number of formats already set, the item will be ignored.

Parameters

formatNumber	index of the subformat.
format	the format to be set.

Stable:

ICU 2.0

Sets subformats.

See the class description about format numbering. Each item in the array is cloned into the internal array. If the call fails because memory cannot be allocated, then this object will remain unchanged.

If this format uses named arguments, the new formats are discarded and this format remains unchanged.

Stable:

ICU 2.0

Parameters

newFormats	the new format to be set.
cnt	the size of the array.

Sets the locale to be used for creating argumentFormat objects.

Parameters

theLocale

the new locale value to be set.

Stable:

ICU 2.0

Returns a pattern that can be used to recreate this object.

Parameters

appendTo

Output parameter to receive the pattern. Result is appended to existing contents.

Returns

Reference to 'appendTo' parameter.

Stable:

ICU 2.0

Returns true if thisMessageFormat uses named arguments, and false otherwise.

See class description.

Returns

true if named arguments are used.

Stable:

ICU 4.0