CartoType API
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes
CartoType::TChar Class Reference

#include <cartotype_char.h>

List of all members.

Public Types

enum  { EMaxCaseVariantLength = 2 }
enum  { KFirstFontSelector = 0xF000, KDefaultFontSelector = KFirstFontSelector + 256, KLastFontSelector = KDefaultFontSelector }

Public Member Functions

 TChar (int32 aCode)
CT_IMPORT void GetLowerCase (int32 *aText, int32 &aTextLength) const
CT_IMPORT void GetTitleCase (int32 *aText, int32 &aTextLength) const
CT_IMPORT void GetUpperCase (int32 *aText, int32 &aTextLength) const
CT_IMPORT TCharCategory Category () const
CT_IMPORT TBidiType BidiType () const
CT_IMPORT int32 Mirrored () const

Static Public Member Functions

static bool InWord (int32 aCode)

Public Attributes

int32 iCode

Detailed Description

A class to provide Unicode character properties. A TChar object holds a single character encoded using its Unicode code point. Surrogates have no meaning in this context. All signed 32-bit values are valid but not all are defined as characters. Non-character values give consistent default values: for example, the uppercase version of a non-character value is the same value.


Member Enumeration Documentation

anonymous enum
Enumerator:
EMaxCaseVariantLength 

A case variant can be no longer than this number of UTF32 characters. For example, the upper-case variant of U+00DF is 'SS' and is two characters long.

anonymous enum
Enumerator:
KFirstFontSelector 

The start of a range of private use characters to select fonts.

KDefaultFontSelector 

A private use character to select the default font.

KLastFontSelector 

The end of a range of private use characters to select fonts.


Constructor & Destructor Documentation

CartoType::TChar::TChar ( int32  aCode) [inline]

Construct a TChar from a Unicode code point (without checking its validity as such).


Member Function Documentation

CT_EXPORT TBidiType TChar::BidiType ( ) const

Return the bidirectional type of a character as defined in the Unicode Standard. For characters outside the Basic Multilingual Plane (U+0000...U+FFFF) return EONBidiType (other neutral).

CT_EXPORT TCharCategory TChar::Category ( ) const

Return the general category of a character as defined in the Unicode Standard. For characters outside the Basic Multilingual Plane (U+0000...U+FFFF) return ECnCategory (other, not assigned).

CT_EXPORT void TChar::GetLowerCase ( int32 *  aText,
int32 &  aTextLength 
) const

Return the lower-case version of a character as a sequence of one or more characters. If there is no lower-case variant return the original character. For characters outside the Basic Multilingual Plane (U+0000...U+FFFF) return the orginal character.

CT_EXPORT void TChar::GetTitleCase ( int32 *  aText,
int32 &  aTextLength 
) const

Return the title-case version of a character as a sequence of one or more characters. If there is no title-case variant return the original character. For characters outside the Basic Multilingual Plane (U+0000...U+FFFF) return the orginal character.

CT_EXPORT void TChar::GetUpperCase ( int32 *  aText,
int32 &  aTextLength 
) const

Return the upper-case (capital) version of a character as a sequence of one or more characters. If there is no upper-case variant return the original character. For characters outside the Basic Multilingual Plane (U+0000...U+FFFF) return the orginal character.

static bool CartoType::TChar::InWord ( int32  aCode) [inline, static]

Return true if a character code is in a word. Words are defined as sequences of letters and combining marks.

CT_EXPORT int32 TChar::Mirrored ( ) const

Return the mirrored version of the character; that is, the character to be displayed if the text is drawn from right to left. For example, the mirrored version of '[' is ']'. For characters outside the Basic Multilingual Plane (U+0000...U+FFFF) return the original character.


Member Data Documentation

The Unicode code point of the character.


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