TChar Class Reference

#include <e32cmn.h>

class TChar

Nested Classes and Structures

Public Member Enumerations
enumanonymous { EFoldCase, EFoldAccents, EFoldDigits, EFoldSpaces, ..., EFoldAll }
enumTBdCategory { ELeftToRight, ELeftToRightEmbedding, ELeftToRightOverride, ERightToLeft, ..., EOtherNeutral }
enumTCategory { EAlphaGroup, ELetterOtherGroup, ELetterModifierGroup, EMarkGroup, ..., ECnCategory }
enumTCjkWidth { ENeutralWidth, EHalfWidth, EFullWidth, ENarrow, EWide }
enumTEncoding { EUnicode, EShiftJIS }
Public Member Functions
TChar()
TChar(TUint)
IMPORT_C TBoolCompose(TUint &, const TDesC16 &)
IMPORT_C TBoolDecompose(TPtrC16 &)
TBool Eos()
voidFold()
voidFold(TInt)
IMPORT_C TBdCategoryGetBdCategory()
IMPORT_C TCategoryGetCategory()
IMPORT_C TCjkWidthGetCjkWidth()
IMPORT_C TIntGetCombiningClass()
TText16 GetHighSurrogate(TUint)
IMPORT_C voidGetInfo(TCharInfo &)
TText16 GetLowSurrogate(TUint)
IMPORT_C TUintGetLowerCase()
IMPORT_C TIntGetNumericValue()
IMPORT_C TUintGetTitleCase()
IMPORT_C TUintGetUpperCase()
IMPORT_C TBoolIsAlpha()
IMPORT_C TBoolIsAlphaDigit()
IMPORT_C TBoolIsAssigned()
IMPORT_C TBoolIsControl()
IMPORT_C TBoolIsDigit()
IMPORT_C TBoolIsGraph()
IMPORT_C TBoolIsHexDigit()
TBool IsHighSurrogate(TText16)
TBool IsLowSurrogate(TText16)
IMPORT_C TBoolIsLower()
IMPORT_C TBoolIsMirrored()
IMPORT_C TBoolIsPrint()
IMPORT_C TBoolIsPunctuation()
IMPORT_C TBoolIsSpace()
TBool IsSupplementary(TUint)
TBool IsSurrogate(TText16)
IMPORT_C TBoolIsTitle()
IMPORT_C TBoolIsUpper()
TUint JoinSurrogate(TText16, TText16)
voidLowerCase()
voidTitleCase()
voidUpperCase()
operator TUint()
TChar operator+(TUint)
TChar &operator+=(TUint)
TChar operator-(TUint)
TChar &operator-=(TUint)
Protected Member Functions
voidSetChar(TUint)

Detailed Description

Holds a character value and provides a number of utility functions to manipulate it and test its properties.

For example, there are functions to convert the character to uppercase and test whether or not it is a control character.

The character value is stored as a 32-bit unsigned integer. The shorthand "TChar value" is used to describe the character value wrapped by a TChar object.

TChar can be used to represent Unicode values outside plane 0 (that is, the extended Unicode range from 0x10000 to 0xFFFFF). This differentiates it from TText which can only be used for 16-bit Unicode character values.

See also: TText

Member Enumeration Documentation

Enum anonymous

Flags defining operations to be performed using TChar::Fold().

The flag values are passed to the Fold() funtion.

See also: TChar::Fold

EnumeratorValueDescription
EFoldCase1

Convert characters to their lower case form if any.

EFoldAccents2

Strip accents

EFoldDigits4

Convert digits representing values 0..9 to characters '0'..'9'

EFoldSpaces8

Convert all spaces (ordinary, fixed-width, ideographic, etc.) to ' '

EFoldKana16

Convert hiragana to katakana.

EFoldWidth32

Fold fullwidth and halfwidth variants to their standard forms

EFoldStandardEFoldCase | EFoldAccents | EFoldDigits | EFoldSpaces

Perform standard folding operations, i.e.those done by Fold() with no argument

EFoldAll-1

Perform all possible folding operations

Enum TBdCategory

The bi-directional Unicode character category.

For more information on the bi-directional algorithm, see Unicode Technical Report No. 9 available at: http://www.unicode.org/unicode/reports/tr9.

EnumeratorValueDescription
ELeftToRight

Left to right.

ELeftToRightEmbedding

Left to right embedding.

ELeftToRightOverride

Left-to-Right Override.

ERightToLeft

Right to left.

ERightToLeftArabic

Right to left Arabic.

ERightToLeftEmbedding

Right to left embedding.

ERightToLeftOverride

Right-to-Left Override.

EPopDirectionalFormat

Pop Directional Format.

EEuropeanNumber

European number.

EEuropeanNumberSeparator

European number separator.

EEuropeanNumberTerminator

European number terminator.

EArabicNumber

Arabic number.

ECommonNumberSeparator

Common number separator.

ENonSpacingMark

Non Spacing Mark.

EBoundaryNeutral

Boundary Neutral.

EParagraphSeparator

Paragraph Separator.

ESegmentSeparator

Segment separator.

EWhitespace

Whitespace

EOtherNeutral

Other neutrals; all other characters: punctuation, symbols.

Enum TCategory

General Unicode character category.

The high nibble encodes the major category (Mark, Number, etc.) and a low nibble encodes the subdivisions of that category.

The category codes can be used in three ways:

(i) as unique constants: there is one for each Unicode category, with a name of the form
    E<XX>Category
where
    <XX>
is the category name given by the Unicode database (e.g., the constant ELuCategory is used for lowercase letters, category Lu);

(ii) as numbers in certain ranges: letter categories are all <= EMaxLetterCategory;

(iii) as codes in which the upper nibble gives the category group (e.g., punctuation categories all yield TRUE for the test (category & 0xF0) ==EPunctuationGroup).

EnumeratorValueDescription
EAlphaGroup0x00

Alphabetic letters.

Includes ELuCategory, ELlCategory and ELtCategory.

ELetterOtherGroup0x10

Other letters.

Includes ELoCategory.

ELetterModifierGroup0x20

Letter modifiers.

Includes ELmCategory.

EMarkGroup0x30

Marks group.

Includes EMnCategory, EMcCategory and EMeCategory.

ENumberGroup0x40

Numbers group.

Includes ENdCategory, ENlCategory and ENoCategory.

EPunctuationGroup0x50

Punctuation group.

IncludesEPcCategory, PdCategory, EpeCategory, EPsCategory and EPoCategory.

ESymbolGroup0x60

Symbols group.

Includes ESmCategory, EScCategory, ESkCategory and ESoCategory.

ESeparatorGroup0x70

Separators group.

Includes EZsCategory, EZlCategory and EZlpCategory.

EControlGroup0x80

Control, format, private use, unassigned.

Includes ECcCategory, ECtCategory, ECsCategory, ECoCategory and ECnCategory.

EMaxAssignedGroup0xE0

The highest possible groups category.

EUnassignedGroup0xF0

Unassigned to any other group.

ELuCategoryEAlphaGroup | 0

Letter, Uppercase.

ELlCategoryEAlphaGroup | 1

Letter, Lowercase.

ELtCategoryEAlphaGroup | 2

Letter, Titlecase.

ELoCategoryELetterOtherGroup | 0

Letter, Other.

EMaxLetterCategoryELetterOtherGroup | 0x0F

The highest possible (non-modifier) letter category.

ELmCategoryELetterModifierGroup | 0

Letter, Modifier.

EMaxLetterOrLetterModifierCategoryELetterModifierGroup | 0x0F

The highest possible letter category.

EMnCategoryEMarkGroup | 0

Mark, Non-Spacing

EMcCategoryEMarkGroup | 1

Mark, Combining.

EMeCategoryEMarkGroup | 2

Mark, Enclosing.

ENdCategoryENumberGroup | 0

Number, Decimal Digit.

ENlCategoryENumberGroup | 1

Number, Letter.

ENoCategoryENumberGroup | 2

Number, Other.

EPcCategoryEPunctuationGroup | 0

Punctuation, Connector.

EPdCategoryEPunctuationGroup | 1

Punctuation, Dash.

EPsCategoryEPunctuationGroup | 2

Punctuation, Open.

EPeCategoryEPunctuationGroup | 3

Punctuation, Close.

EPiCategoryEPunctuationGroup | 4

Punctuation, Initial Quote

EPfCategoryEPunctuationGroup | 5

Punctuation, Final Quote

EPoCategoryEPunctuationGroup | 6

Punctuation, Other.

ESmCategoryESymbolGroup | 0

Symbol, Math.

EScCategoryESymbolGroup | 1

Symbol, Currency.

ESkCategoryESymbolGroup | 2

Symbol, Modifier.

ESoCategoryESymbolGroup | 3

Symbol, Other.

EMaxGraphicCategoryESymbolGroup | 0x0F

The highest possible graphic character category.

EZsCategoryESeparatorGroup | 0

Separator, Space.

EMaxPrintableCategoryEZsCategory

The highest possible printable character category.

EZlCategoryESeparatorGroup | 1

Separator, Line.

EZpCategoryESeparatorGroup | 2

Separator, Paragraph.

ECcCategoryEControlGroup | 0

Other, Control.

ECfCategoryEControlGroup | 1

Other, Format.

EMaxAssignedCategoryEMaxAssignedGroup | 0x0F

The highest possible category for assigned 16-bit characters; does not include surrogates, which are interpreted as pairs and have no meaning on their own.

ECsCategoryEUnassignedGroup | 0

Other, Surrogate.

ECoCategoryEUnassignedGroup | 1

Other, Private Use.

ECnCategoryEUnassignedGroup | 2

Other, Not Assigned.

Enum TCjkWidth

Notional character width as known to East Asian (Chinese, Japanese, Korean(CJK)) coding systems.

EnumeratorValueDescription
ENeutralWidth

Includes 'ambiguous width' defined in Unicode Technical Report 11: East Asian Width

EHalfWidth

Character which occupies a single cell.

EFullWidth

Character which occupies 2 cells.

ENarrow

Characters that are always narrow and have explicit full-width counterparts. All of ASCII is an example of East Asian Narrow characters.

EWide

Characters that are always wide. This category includes characters that have explicit half-width counterparts.

Enum TEncoding

Deprecated

Encoding systems used by the translation functions.

EnumeratorValueDescription
EUnicode

The Unicode encoding.

EShiftJIS

The shift-JIS encoding (used in Japan).

Constructor & Destructor Documentation

TChar ( )

TChar()[inline]

Default constructor.

Constructs this character object with an undefined value.

TChar ( TUint )

TChar(TUintaChar)[inline]

Constructs this character object and initialises it with the specified value.

Parameters
aCharThe initialisation value.

Member Function Documentation

Compose ( TUint &, const TDesC16 & )

IMPORT_C TBoolCompose(TUint &aResult,
const TDesC16 &aSource
)[static]

Composes a string of Unicode characters to produce a single character result.

For example, 0061 ('a') and 030A (combining ring above) compose to give 00E5 ('a' with ring above).

A canonical decomposition is a relationship between a string of characters - usually a base character and one or more diacritics - and a composed character. The Unicode standard requires that compliant software treats composed characters identically with their canonical decompositions. The mappings used by these functions are fixed and cannot be overridden for particular locales.

Parameters
aResultIf successful, the composed character value. If unsuccessful, this value contains 0xFFFF.
aSourceString of source Unicode characters.
Return Value
True, if the compose operation is successful in combining the entire sequence of characters in the descriptor into a single compound character; false, otherwise.

Decompose ( TPtrC16 & )

IMPORT_C TBoolDecompose(TPtrC16 &aResult)const

Maps this character to its maximal canonical decomposition.

For example, 01E1 ('a' with dot above and macron) decomposes into 0061 ('a') 0307 (dot) and 0304 (macron).

Note that this function is used during collation, as performed by the Mem::CompareC() function, to convert the compared strings to their maximal canonical decompositions.

See also: Mem::CompareC() TChar::Compose()

Parameters
aResultIf successful, the descriptor represents the canonical decomposition of this character. If unsuccessful, the descriptor is empty.
Return Value
True if decomposition is successful; false, otherwise.

Eos ( )

TBool Eos()const [inline]

Tests whether the character is the C/C++ end-of-string character - 0.

Return Value
True, if the character is 0; false, otherwise.

Fold ( )

voidFold()[inline]

Converts the character to a form which can be used in tolerant comparisons without control over the operations performed.

Tolerant comparisons are those which ignore character differences like case and accents.

This function can be used when searching for a string in a text file or a file in a directory. Folding performs the following conversions: converts to lowercase, strips accents, converts all digits representing the values 0..9 to the ordinary digit characters '0'..'9', converts all spaces (standard, non-break, fixed-width, ideographic, etc.) to the ordinary space character (0x0020), converts Japanese characters in the hiragana syllabary to katakana, and converts East Asian halfwidth and fullwidth variants to their ordinary forms. You can choose to perform any subset of these operations by using the other function overload.

See also: User::Fold

Fold ( TInt )

voidFold(TIntaFlags)[inline]

Converts the character to a form which can be used in tolerant comparisons allowing selection of the specific fold operations to be performed.

See also: TChar::EFoldCase User::Fold

Parameters
aFlagsFlags which define the operations to be performed. The values are defined in the enum beginning with EFoldCase.

GetBdCategory ( )

IMPORT_C TBdCategoryGetBdCategory()const

Gets the bi-directional category of a character.

For more information on the bi-directional algorithm, see Unicode Technical Report No. 9 available at: http://www.unicode.org/unicode/reports/tr9/.

Return Value
The character's bi-directional category.

GetCategory ( )

IMPORT_C TCategoryGetCategory()const

Gets this character's Unicode category.

Return Value
This character's Unicode category.

GetCjkWidth ( )

IMPORT_C TCjkWidthGetCjkWidth()const

Gets the Chinese, Japanese, Korean (CJK) notional width.

Some display systems used in East Asia display characters on a grid of fixed-width character cells like the standard MSDOS display mode.

Some characters, e.g. the Japanese katakana syllabary, take up a single character cell and some characters, e.g., kanji, Chinese characters used in Japanese, take up two. These are called half-width and full-width characters. This property is fixed and cannot be overridden for particular locales.

For more information on returned widths, see Unicode Technical Report 11 on East Asian Width available at: http://www.unicode.org/unicode/reports/tr11/

Return Value
The notional width of an east Asian character.

GetCombiningClass ( )

IMPORT_C TIntGetCombiningClass()const

Gets this character's combining class.

Note that diacritics and other combining characters have non-zero combining classes.

Return Value
The combining class.

GetHighSurrogate ( TUint )

TText16 GetHighSurrogate(TUintaChar)[static, inline]

Retrieve the high surrogate of a supplementary character.

See also: TChar::GetLowSurrogate

Parameters
aCharThe 32-bit code point value of a Unicode character.
Return Value
High surrogate of aChar, if aChar is a supplementary character; aChar itself, if aChar is not a supplementary character.

GetInfo ( TCharInfo & )

IMPORT_C voidGetInfo(TCharInfo &aInfo)const

Gets this character;s standard category information.

This includes everything except its CJK width and decomposition, if any.

Parameters
aInfoOn return, contains the character's standard category information.

GetLowSurrogate ( TUint )

TText16 GetLowSurrogate(TUintaChar)[static, inline]

Retrieve the low surrogate of a supplementary character.

See also: TChar::GetHighSurrogate

Parameters
aCharThe 32-bit code point value of a Unicode character.
Return Value
Low surrogate of aChar, if aChar is a supplementary character; zero, if aChar is not a supplementary character.

GetLowerCase ( )

IMPORT_C TUintGetLowerCase()const

Gets the character value after conversion to lowercase or the character's own value, if no lowercase form exists.

The character object itself is not changed.

Return Value
The character value after conversion to lowercase.

GetNumericValue ( )

IMPORT_C TIntGetNumericValue()const

Gets the integer numeric value of this character.

Numeric values need not be in the range 0..9; the Unicode character set includes various other numeric characters such as the Roman and Tamil numerals for 500, 1000, etc.

Return Value
The numeric value: -1 if the character has no integer numeric value,-2 if the character has a fractional numeric value.

GetTitleCase ( )

IMPORT_C TUintGetTitleCase()const

Gets the character value after conversion to titlecase or the character's own value, if no titlecase form exists.

The titlecase form of a character is identical to its uppercase form unless a specific titlecase form exists.

Return Value
The value of the character value after conversion to titlecase form.

GetUpperCase ( )

IMPORT_C TUintGetUpperCase()const

Gets the character value after conversion to uppercase or the character's own value, if no uppercase form exists.

The character object itself is not changed.

Return Value
The character value after conversion to uppercase.

IsAlpha ( )

IMPORT_C TBoolIsAlpha()const

Tests whether the character is alphabetic.

For Unicode, the function returns TRUE for all letters, including those from syllabaries and ideographic scripts. The function returns FALSE for letter-like characters that are in fact diacritics. Specifically, the function returns TRUE for categories: ELuCategory, ELtCategory, ELlCategory, and ELoCategory; it returns FALSE for all other categories including ELmCategory.

See also: TChar::IsAlphaDigit() TChar::TCategory

Return Value
True, if the character is alphabetic; false, otherwise.

IsAlphaDigit ( )

IMPORT_C TBoolIsAlphaDigit()const

Tests whether the character is alphabetic or a decimal digit.

It is identical to (IsAlpha()||IsDigit()).

See also: TChar::IsAlpha() TChar::IsDigit()

Return Value
True, if the character is alphabetic or a decimal digit; false, otherwise.

IsAssigned ( )

IMPORT_C TBoolIsAssigned()const

Tests whether this character has an assigned meaning in the Unicode encoding.

All characters outside the range 0x0000 - 0xFFFF are unassigned and there are also many unassigned characters within the Unicode range.

Locales can change the assigned/unassigned status of characters. This means that the precise behaviour of this function is locale-dependent.

Return Value
True, if this character has an assigned meaning; false, otherwise.

IsControl ( )

IMPORT_C TBoolIsControl()const

Tests whether the character is a control character.

For Unicode, the function returns TRUE for all characters in the categories: ECcCategory, ECfCategory, ECsCategory, ECoCategory and ECnCategoryCc.

See also: TChar::TCategory

Return Value
True, if the character is a control character; false, otherwise.

IsDigit ( )

IMPORT_C TBoolIsDigit()const

Tests whether the character is a standard decimal digit.

For Unicode, this function returns TRUE only for the digits '0'...'9' (U+0030...U+0039), not for other digits in scripts like Arabic, Tamil, etc.

See also: TChar::GetCategory() TChar::GetNumericValue

Return Value
True, if the character is a standard decimal digit; false, otherwise.

IsGraph ( )

IMPORT_C TBoolIsGraph()const

Tests whether the character is a graphic character.

For Unicode, graphic characters include printable characters but not the space character. Specifically, graphic characters are any character except those in categories: EZsCategory,EZlCategory,EZpCategory, ECcCategory,ECfCategory, ECsCategory, ECoCategory, and ,ECnCategory.

Note that for ISO Latin-1, all alphanumeric and punctuation characters are graphic.

See also: TChar::TCategory

Return Value
True, if the character is a graphic character; false, otherwise.

IsHexDigit ( )

IMPORT_C TBoolIsHexDigit()const

Tests whether the character is a hexadecimal digit (0-9, a-f, A-F).

Return Value
True, if the character is a hexadecimal digit; false, otherwise.

IsHighSurrogate ( TText16 )

TBool IsHighSurrogate(TText16aInt16)[static, inline]

Return Value
True, if aText16 is high surrogate; false, otherwise.

IsLowSurrogate ( TText16 )

TBool IsLowSurrogate(TText16aInt16)[static, inline]

Return Value
True, if aText16 is low surrogate; false, otherwise.

IsLower ( )

IMPORT_C TBoolIsLower()const

Tests whether the character is lowercase.

Return Value
True, if the character is lowercase; false, otherwise.

IsMirrored ( )

IMPORT_C TBoolIsMirrored()const

Tests whether this character has the mirrored property.

Mirrored characters, like ( ) [ ] < >, change direction according to the directionality of the surrounding characters. For example, an opening parenthesis 'faces right' in Hebrew or Arabic, and to say that 2 < 3 you would have to say that 3 > 2, where the '>' is, in this example, a less-than sign to be read right-to-left.

Return Value
True, if this character has the mirrored property; false, otherwise.

IsPrint ( )

IMPORT_C TBoolIsPrint()const

Tests whether the character is a printable character.

For Unicode, printable characters are any character except those in categories: ECcCategory, ECfCategory, ECsCategory, ECoCategory and ECnCategory.

Note that for ISO Latin-1, all alphanumeric and punctuation characters, plus space, are printable.

See also: TChar::TCategory

Return Value
True, if the character is printable; false, otherwise.

IsPunctuation ( )

IMPORT_C TBoolIsPunctuation()const

Tests whether the character is a punctuation character.

For Unicode, punctuation characters are any character in the categories: EPcCategory, EPdCategory, EPsCategory, EPeCategory, EPiCategory, EPfCategory, EPoCategory.

See also: TChar::TCategory

Return Value
True, if the character is punctuation; false, otherwise.

IsSpace ( )

IMPORT_C TBoolIsSpace()const

Tests whether the character is a white space character.

White space includes spaces, tabs and separators.

For Unicode, the function returns TRUE for all characters in the categories: EZsCategory, EZlCategory and EZpCategory, and also for the characters 0x0009 (horizontal tab), 0x000A (linefeed), 0x000B (vertical tab), 0x000C (form feed), and 0x000D (carriage return).

See also: TChar::TCategory

Return Value
True, if the character is white space; false, otherwise.

IsSupplementary ( TUint )

TBool IsSupplementary(TUintaChar)[static, inline]

Parameters
aCharThe 32-bit code point value of a Unicode character.
Return Value
True, if aChar is supplementary character; false, otherwise.

IsSurrogate ( TText16 )

TBool IsSurrogate(TText16aInt16)[static, inline]

Return Value
True, if aText16 is high surrogate or low surrogate; false, otherwise.

IsTitle ( )

IMPORT_C TBoolIsTitle()const

Tests whether this character is in titlecase.

Return Value
True, if this character is in titlecase; false, otherwise.

IsUpper ( )

IMPORT_C TBoolIsUpper()const

Tests whether the character is uppercase.

Return Value
True, if the character is uppercase; false, otherwise.

JoinSurrogate ( TText16, TText16 )

TUint JoinSurrogate(TText16aHighSurrogate,
TText16aLowSurrogate
)[static, inline]

Combine a high surrogate and a low surrogate into a supplementary character.

Return Value
The 32-bit code point value of the generated Unicode supplementary character.

LowerCase ( )

voidLowerCase()[inline]

Converts the character to its lowercase form.

Characters lacking a lowercase form are unchanged.

See also: User::LowerCase

SetChar ( TUint )

voidSetChar(TUintaChar)[protected, inline]

TitleCase ( )

voidTitleCase()[inline]

Converts the character to its titlecase form.

The titlecase form of a character is identical to its uppercase form unless a specific titlecase form exists. Characters lacking a titlecase form are unchanged.

UpperCase ( )

voidUpperCase()[inline]

Converts the character to its uppercase form.

Characters lacking an uppercase form are unchanged.

See also: User::UpperCase

operator TUint ( )

operator TUint()const [inline]

Gets the value of the character as an unsigned integer.

The operator casts a TChar to a TUint, returning the TUint value wrapped by this character object.

operator+ ( TUint )

TChar operator+(TUintaChar)[inline]

Gets the result of adding an unsigned integer value to this character object.

This character object is not changed.

Parameters
aCharThe value to be added.
Return Value
A character object whose value is the result of the addition operation.

operator+= ( TUint )

TChar &operator+=(TUintaChar)[inline]

Adds an unsigned integer value to this character object.

This character object is changed by the operation.

Parameters
aCharThe value to be added.
Return Value
A reference to this character object.

operator- ( TUint )

TChar operator-(TUintaChar)[inline]

Gets the result of subtracting an unsigned integer value from this character object.

This character object is not changed.

Parameters
aCharThe value to be subtracted.
Return Value
A character object whose value is the result of the subtraction operation.

operator-= ( TUint )

TChar &operator-=(TUintaChar)[inline]

Subtracts an unsigned integer value from this character object.

This character object is changed by the operation.

Parameters
aCharThe value to be subtracted.
Return Value
A reference to this character object.