ICU4C 79
Loading...
Searching...
No Matches
icu::message2::FunctionContext Class Reference

Class implementing data from contextual options. More...

#include <messageformat2_function_registry.h>

Inheritance diagram for icu::message2::FunctionContext:
icu::UObject icu::UMemory

Public Member Functions

U_I18N_API const Locale & getLocale () const
 Returns the locale from this context.
U_I18N_API UMFBidiOption getDirection () const
 Returns the text direction from this context.
U_I18N_API const UnicodeString & getID () const
 Returns the ID from this context.
U_I18N_API const FunctionName & getCalledFunctionName () const
 Returns the original called function name from this context.
U_I18N_API FunctionContext withLocale (const Locale &loc) const
 Returns a new context with the specified locale.
Public Member Functions inherited from icu::UObject
virtual ~UObject ()
 Destructor.
virtual UClassID getDynamicClassID () const
 ICU4C "poor man's RTTI", returns a UClassID for the actual ICU class.

Friends

class MessageFormatter

Detailed Description

Class implementing data from contextual options.

See https://github.com/unicode-org/message-format-wg/pull/846

Internal
Do not use. This API is for internal use only. ICU 79 technology preview
Deprecated
This API is for technology preview only.

Definition at line 250 of file messageformat2_function_registry.h.

Member Function Documentation

◆ getCalledFunctionName()

U_I18N_API const FunctionName & icu::message2::FunctionContext::getCalledFunctionName ( ) const
inline

Returns the original called function name from this context.

Returns
The function name, as registered, used for this function
Internal
Do not use. This API is for internal use only. ICU 79 technology preview
Deprecated
This API is for technology preview only.

Definition at line 289 of file messageformat2_function_registry.h.

References U_I18N_API.

Referenced by withLocale().

◆ getDirection()

U_I18N_API UMFBidiOption icu::message2::FunctionContext::getDirection ( ) const
inline

Returns the text direction from this context.

Returns
A UMFBidiOption indicating the text direction.
Internal
Do not use. This API is for internal use only. ICU 79 technology preview
Deprecated
This API is for technology preview only.

Definition at line 269 of file messageformat2_function_registry.h.

References U_I18N_API.

Referenced by withLocale().

◆ getID()

U_I18N_API const UnicodeString & icu::message2::FunctionContext::getID ( ) const
inline

Returns the ID from this context.

Returns
A string to be used in formatting to parts. (Formatting to parts is not yet implemented.)
Internal
Do not use. This API is for internal use only. ICU 79 technology preview
Deprecated
This API is for technology preview only.

Definition at line 279 of file messageformat2_function_registry.h.

References U_I18N_API.

Referenced by withLocale().

◆ getLocale()

U_I18N_API const Locale & icu::message2::FunctionContext::getLocale ( ) const
inline

Returns the locale from this context.

Returns
Locale the context was created with.
Internal
Do not use. This API is for internal use only. ICU 79 technology preview
Deprecated
This API is for technology preview only.

Definition at line 260 of file messageformat2_function_registry.h.

References U_I18N_API.

◆ withLocale()

U_I18N_API FunctionContext icu::message2::FunctionContext::withLocale ( const Locale & loc) const
inline

Returns a new context with the specified locale.

Returns
a new locale
Internal
Do not use. This API is for internal use only. ICU 79 technology preview
Deprecated
This API is for technology preview only.

Definition at line 299 of file messageformat2_function_registry.h.

References getCalledFunctionName(), getDirection(), getID(), and U_I18N_API.

◆ MessageFormatter

friend class MessageFormatter
friend

Definition at line 304 of file messageformat2_function_registry.h.


The documentation for this class was generated from the following file: