ICU 74.2: i18n/unicode/selfmt.h Source File

ICU 74.2 74.2

selfmt.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 * COPYRIGHT:
5 * Copyright (c) 1997-2011, International Business Machines Corporation and
6 * others. All Rights Reserved.
7 * Copyright (C) 2010 , Yahoo! Inc.
8 ********************************************************************
9 *
10 * File SELFMT.H
11 *
12 * Modification History:
13 *
14 * Date Name Description
15 * 11/11/09 kirtig Finished first cut of implementation.
16 ********************************************************************/
17
18#ifndef SELFMT
19#define SELFMT
20
21#include "unicode/utypes.h"
22
23#if U_SHOW_CPLUSPLUS_API
24
25#include "unicode/messagepattern.h"
26#include "unicode/numfmt.h"
27
33#if !UCONFIG_NO_FORMATTING
34
35U_NAMESPACE_BEGIN
36
37class MessageFormat;
38
188 class U_I18N_API SelectFormat : public Format {
189public:
190
199 SelectFormat(const UnicodeString& pattern, UErrorCode& status);
200
205 SelectFormat(const SelectFormat& other);
206
211 virtual ~SelectFormat();
212
224 void applyPattern(const UnicodeString& pattern, UErrorCode& status);
225
226
227 using Format::format;
228
242 UnicodeString& format(const UnicodeString& keyword,
243 UnicodeString& appendTo,
244 FieldPosition& pos,
245 UErrorCode& status) const;
246
253 SelectFormat& operator=(const SelectFormat& other);
254
262 virtual bool operator==(const Format& other) const override;
263
271 virtual bool operator!=(const Format& other) const;
272
278 virtual SelectFormat* clone() const override;
279
295 UnicodeString& format(const Formattable& obj,
296 UnicodeString& appendTo,
297 FieldPosition& pos,
298 UErrorCode& status) const override;
299
308 UnicodeString& toPattern(UnicodeString& appendTo);
309
332 virtual void parseObject(const UnicodeString& source,
333 Formattable& result,
334 ParsePosition& parse_pos) const override;
335
340 static UClassID U_EXPORT2 getStaticClassID(void);
341
346 virtual UClassID getDynamicClassID() const override;
347
348private:
349 friend class MessageFormat;
350
351 SelectFormat() = delete; // default constructor not implemented.
352
361 static int32_t findSubMessage(const MessagePattern& pattern, int32_t partIndex,
362 const UnicodeString& keyword, UErrorCode& ec);
363
364 MessagePattern msgPattern;
365};
366
367U_NAMESPACE_END
368
369#endif /* #if !UCONFIG_NO_FORMATTING */
370
371#endif /* U_SHOW_CPLUSPLUS_API */
372
373#endif // _SELFMT
374//eof
icu::FieldPosition
FieldPosition is a simple class used by Format and its subclasses to identify fields in formatted out...
Definition fieldpos.h:110
icu::Format
Base class for all formats.
Definition format.h:98
icu::Formattable
Formattable objects can be passed to the Format class or its subclasses for formatting.
Definition fmtable.h:64
icu::MessageFormat
Definition msgfmt.h:345
icu::MessagePattern
Parses and represents ICU MessageFormat patterns.
Definition messagepattern.h:362
icu::ParsePosition
ParsePosition is a simple class used by Format and its subclasses to keep track of the current positi...
Definition parsepos.h:52
icu::SelectFormat
Definition selfmt.h:188
icu::SelectFormat::clone
virtual SelectFormat * clone() const override
Clones this Format object polymorphically.
icu::SelectFormat::operator!=
virtual bool operator!=(const Format &other) const
Return true if another object is semantically unequal to this one.
icu::SelectFormat::SelectFormat
SelectFormat(const SelectFormat &other)
copy constructor.
icu::SelectFormat::getStaticClassID
static UClassID getStaticClassID(void)
ICU "poor man's RTTI", returns a UClassID for this class.
icu::SelectFormat::parseObject
virtual void parseObject(const UnicodeString &source, Formattable &result, ParsePosition &parse_pos) const override
This method is not yet supported by SelectFormat.
icu::SelectFormat::getDynamicClassID
virtual UClassID getDynamicClassID() const override
ICU "poor man's RTTI", returns a UClassID for the actual class.
icu::SelectFormat::format
UnicodeString & format(const UnicodeString &keyword, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const
Selects the phrase for the given keyword.
icu::SelectFormat::operator==
virtual bool operator==(const Format &other) const override
Return true if another object is semantically equal to this one.
icu::SelectFormat::~SelectFormat
virtual ~SelectFormat()
Destructor.
icu::SelectFormat::toPattern
UnicodeString & toPattern(UnicodeString &appendTo)
Returns the pattern from applyPattern() or constructor.
icu::SelectFormat::applyPattern
void applyPattern(const UnicodeString &pattern, UErrorCode &status)
Sets the pattern used by this select format.
icu::SelectFormat::format
UnicodeString & format(const Formattable &obj, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const override
Format an object to produce a string.
icu::SelectFormat::SelectFormat
SelectFormat(const UnicodeString &pattern, UErrorCode &status)
Creates a new SelectFormat for a given pattern string.
icu::SelectFormat::operator=
SelectFormat & operator=(const SelectFormat &other)
Assignment operator.
icu::UnicodeString
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition unistr.h:296
messagepattern.h
C++ API: MessagePattern class: Parses and represents ICU MessageFormat patterns.
numfmt.h
C++ API: Compatibility APIs for number formatting.
UClassID
void * UClassID
UClassID is used to identify classes without using the compiler's RTTI.
Definition uobject.h:96
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition utypes.h:415
U_I18N_API
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside.
Definition utypes.h:301