Folds a specified character and provides functions to fold additional characters after construction of the object. More...

#include <e32std.h>

Inheritance diagram for TCharF:

Public Member Functions
	TCharF (TUint aChar)
	Constructs this 'fold character' object and initialises it with the specified value.

	TCharF (const TChar &aChar)
	Constructs this 'fold character' object and initialises it with the value of the TChar object aChar.

TCharF &	operator= (TUint aChar)
	Assigns an unsigned integer value to the 'fold character' object.

TCharF &	operator= (const TChar &aChar)
	Assigns the specified character object to this 'fold character' object.

Public Member Functions inherited from TChar
	TChar ()
	Default constructor.

	TChar (TUint aChar)
	Constructs this character object and initialises it with the specified value.

TChar &	operator-= (TUint aChar)
	Subtracts an unsigned integer value from this character object.

TChar &	operator+= (TUint aChar)
	Adds an unsigned integer value to this character object.

TChar	operator- (TUint aChar)
	Gets the result of subtracting an unsigned integer value from this character object.

TChar	operator+ (TUint aChar)
	Gets the result of adding an unsigned integer value to this character object.

	operator TUint () const
	Gets the value of the character as an unsigned integer.

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

void	LowerCase ()
	Converts the character to its lowercase form.

void	UpperCase ()
	Converts the character to its uppercase form.

TBool	Eos () const
	Tests whether the character is the C/C++ end-of-string character - 0.

IMPORT_C TUint	GetUpperCase () const
	Gets the character value after conversion to uppercase or the character's own value, if no uppercase form exists.

IMPORT_C TUint	GetLowerCase () const
	Gets the character value after conversion to lowercase or the character's own value, if no lowercase form exists.

IMPORT_C TBool	IsLower () const
	Tests whether the character is lowercase.

IMPORT_C TBool	IsUpper () const
	Tests whether the character is uppercase.

IMPORT_C TBool	IsAlpha () const
	Tests whether the character is alphabetic.

IMPORT_C TBool	IsDigit () const
	Tests whether the character is a standard decimal digit.

IMPORT_C TBool	IsAlphaDigit () const
	Tests whether the character is alphabetic or a decimal digit.

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

IMPORT_C TBool	IsSpace () const
	Tests whether the character is a white space character.

IMPORT_C TBool	IsPunctuation () const
	Tests whether the character is a punctuation character.

IMPORT_C TBool	IsGraph () const
	Tests whether the character is a graphic character.

IMPORT_C TBool	IsPrint () const
	Tests whether the character is a printable character.

IMPORT_C TBool	IsControl () const
	Tests whether the character is a control character.

void	Fold (TInt aFlags)
	Converts the character to a form which can be used in tolerant comparisons allowing selection of the specific fold operations to be performed.

void	TitleCase ()
	Converts the character to its titlecase form.

IMPORT_C TUint	GetTitleCase () const
	Gets the character value after conversion to titlecase or the character's own value, if no titlecase form exists.

IMPORT_C TBool	IsTitle () const
	Tests whether this character is in titlecase.

IMPORT_C TBool	IsAssigned () const
	Tests whether this character has an assigned meaning in the Unicode encoding.

IMPORT_C void	GetInfo (TCharInfo &aInfo) const
	Gets this character;s standard category information.

IMPORT_C TCategory	GetCategory () const
	Gets this character's Unicode category.

IMPORT_C TBdCategory	GetBdCategory () const
	Gets the bi-directional category of a character.

IMPORT_C TInt	GetCombiningClass () const
	Gets this character's combining class.

IMPORT_C TBool	IsMirrored () const
	Tests whether this character has the mirrored property.

IMPORT_C TInt	GetNumericValue () const
	Gets the integer numeric value of this character.

IMPORT_C TCjkWidth	GetCjkWidth () const
	Gets the Chinese, Japanese, Korean (CJK) notional width.

IMPORT_C TBool	Decompose (TPtrC16 &aResult) const
	Maps this character to its maximal canonical decomposition.

Additional Inherited Members
Public Types inherited from TChar
enum	TCategory { EAlphaGroup = 0x00 , ELetterOtherGroup = 0x10 , ELetterModifierGroup = 0x20 , EMarkGroup = 0x30 , ENumberGroup = 0x40 , EPunctuationGroup = 0x50 , ESymbolGroup = 0x60 , ESeparatorGroup = 0x70 , EControlGroup = 0x80 , EMaxAssignedGroup = 0xE0 , EUnassignedGroup = 0xF0 , ELuCategory = EAlphaGroup \| 0 , ELlCategory = EAlphaGroup \| 1 , ELtCategory = EAlphaGroup \| 2 , ELoCategory = ELetterOtherGroup \| 0 , EMaxLetterCategory = ELetterOtherGroup \| 0x0F , ELmCategory = ELetterModifierGroup \| 0 , EMaxLetterOrLetterModifierCategory = ELetterModifierGroup \| 0x0F , EMnCategory = EMarkGroup \| 0 , EMcCategory = EMarkGroup \| 1 , EMeCategory = EMarkGroup \| 2 , ENdCategory = ENumberGroup \| 0 , ENlCategory = ENumberGroup \| 1 , ENoCategory = ENumberGroup \| 2 , EPcCategory = EPunctuationGroup \| 0 , EPdCategory = EPunctuationGroup \| 1 , EPsCategory = EPunctuationGroup \| 2 , EPeCategory = EPunctuationGroup \| 3 , EPiCategory = EPunctuationGroup \| 4 , EPfCategory = EPunctuationGroup \| 5 , EPoCategory = EPunctuationGroup \| 6 , ESmCategory = ESymbolGroup \| 0 , EScCategory = ESymbolGroup \| 1 , ESkCategory = ESymbolGroup \| 2 , ESoCategory = ESymbolGroup \| 3 , EMaxGraphicCategory = ESymbolGroup \| 0x0F , EZsCategory = ESeparatorGroup \| 0 , EMaxPrintableCategory = EZsCategory , EZlCategory = ESeparatorGroup \| 1 , EZpCategory = ESeparatorGroup \| 2 , ECcCategory = EControlGroup \| 0 , ECfCategory = EControlGroup \| 1 , EMaxAssignedCategory = EMaxAssignedGroup \| 0x0F , ECsCategory = EUnassignedGroup \| 0 , ECoCategory = EUnassignedGroup \| 1 , ECnCategory = EUnassignedGroup \| 2 }
	General Unicode character category. More...

enum	TBdCategory { ELeftToRight , ELeftToRightEmbedding , ELeftToRightOverride , ERightToLeft , ERightToLeftArabic , ERightToLeftEmbedding , ERightToLeftOverride , EPopDirectionalFormat , EEuropeanNumber , EEuropeanNumberSeparator , EEuropeanNumberTerminator , EArabicNumber , ECommonNumberSeparator , ENonSpacingMark , EBoundaryNeutral , EParagraphSeparator , ESegmentSeparator , EWhitespace , EOtherNeutral }
	The bi-directional Unicode character category. More...

enum	TCjkWidth { ENeutralWidth , EHalfWidth , EFullWidth , ENarrow , EWide }
	Notional character width as known to East Asian (Chinese, Japanese, Korean�(CJK)) coding systems. More...

enum	TEncoding { EUnicode , EShiftJIS }

enum	{ EFoldCase = 1 , EFoldAccents = 2 , EFoldDigits = 4 , EFoldSpaces = 8 , EFoldKana = 16 , EFoldWidth = 32 , EFoldStandard = EFoldCase \| EFoldAccents \| EFoldDigits \| EFoldSpaces , EFoldAll = -1 }
	Flags defining operations to be performed using TChar::Fold(). More...

Static Public Member Functions inherited from TChar
static IMPORT_C TBool	Compose (TUint &aResult, const TDesC16 &aSource)
	Composes a string of Unicode characters to produce a single character result.

static TBool	IsSupplementary (TUint aChar)

static TBool	IsSurrogate (TText16 aInt16)

static TBool	IsHighSurrogate (TText16 aInt16)

static TBool	IsLowSurrogate (TText16 aInt16)

static TUint	JoinSurrogate (TText16 aHighSurrogate, TText16 aLowSurrogate)
	Combine a high surrogate and a low surrogate into a supplementary character.

static TText16	GetHighSurrogate (TUint aChar)
	Retrieve the high surrogate of a supplementary character.

static TText16	GetLowSurrogate (TUint aChar)
	Retrieve the low surrogate of a supplementary character.

Protected Member Functions inherited from TChar
void	SetChar (TUint aChar)

Detailed Description

Folds a specified character and provides functions to fold additional characters after construction of the object.

Folding 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.

Note that folding is locale-independent behaviour. It is also important to note that there can be no guarantee that folding is in any way culturally appropriate, and should not be used for matching characters in natural language.

See also: User::Fold

API status: Published to all clients. Released API.

Definition at line 980 of file e32std.h.

Constructor & Destructor Documentation

◆ TCharF() [1/2]

TCharF::TCharF ( TUint aChar )

inline

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

Parameters

aChar The initialisation value.

(generated from Symbian Developer Library)

◆ TCharF() [2/2]

TCharF::TCharF ( const TChar & aChar )

inline

Constructs this 'fold character' object and initialises it with the value of the TChar object aChar.

Parameters

aChar The character object to use as the initialisation value.

(generated from Symbian Developer Library)

Member Function Documentation

◆ operator=() [1/2]

TCharF & TCharF::operator= ( const TChar & aChar )

inline

Assigns the specified character object to this 'fold character' object.

Parameters

aChar The character object to assign.

(generated from Symbian Developer Library)

◆ operator=() [2/2]

TCharF & TCharF::operator= ( TUint aChar )

inline

Assigns an unsigned integer value to the 'fold character' object.

Parameters

aChar The value to assign.

(generated from Symbian Developer Library)

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

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TCharF() [1/2]

◆ TCharF() [2/2]

Member Function Documentation

◆ operator=() [1/2]

◆ operator=() [2/2]