CharacterRange Class Reference

#include <ICompositeFont.h>

Public Types
typedef base_type	data_type

Public Member Functions
void	SetRange (UTF32TextChar firstChar, UTF32TextChar lastChar, UTF32TextChar destChar, int32 script=-1)
bool16	SetFirstAndDest (UTF32TextChar firstChar)
bool16	SetLast (UTF32TextChar lastChar)
void	SetDest (UTF32TextChar destChar)
UTF32TextChar	GetFirst () const
UTF32TextChar	GetLast () const
UTF32TextChar	GetDest () const
UTF32TextChar	GetRemappedChar (UTF32TextChar originalChar) const
void	ReadWrite (IPMStream *s)
bool16	operator== (const CharacterRange &charRange) const
void	SetRange (PlatformChar firstChar, PlatformChar lastChar, PlatformChar destChar, int32 script=-1)
int32	GetScript () const

Detailed Description

CharacterRange. Used in CharRangeCollection.

See Also

SetCharRanges

Member Function Documentation

UTF32TextChar CharacterRange::GetDest ( ) const

inline

Get Unicode value that first character maps to in component font.

Returns

UTF32TextChar destination character in component font.

UTF32TextChar CharacterRange::GetFirst ( ) const

inline

Get Unicode value of first character in composite font.

Returns

UTF32TextChar first character in composite font.

UTF32TextChar CharacterRange::GetLast ( ) const

inline

Get Unicode value of last character in composite font.

Returns

UTF32TextChar last character in composite font.

UTF32TextChar CharacterRange::GetRemappedChar ( UTF32TextChar  originalChar ) const

inline

Get Unicode value that input character maps to in composite font.

Returns

UTF32TextChar character in composite font.

int32 CharacterRange::GetScript ( ) const

inline

OBSOLETE. do not use.

bool16 CharacterRange::operator== ( const CharacterRange &  charRange ) const

inline

comparison operator.

void CharacterRange::ReadWrite ( IPMStream *  s )

inline

Read or Write values.

Parameters

s	stream to read/write to.

void CharacterRange::SetDest ( UTF32TextChar  destChar )

inline

Reset destination of range.

Parameters

destChar

new Unicode value for what first character maps to in component font.

bool16 CharacterRange::SetFirstAndDest ( UTF32TextChar  firstChar )

inline

Reset beginning of range. Call updates destchar to remapped value of new firstChar.

Parameters

firstChar

new Unicode value for first character in composite font.

Returns

bool16 kFalse if firstchar is greater than lastchar.

bool16 CharacterRange::SetLast ( UTF32TextChar  lastChar )

inline

Reset end of range.

Parameters

lastChar

new Unicode value for last character in composite font.

Returns

bool16 kFalse if lastchar is less than firstchar.

void CharacterRange::SetRange ( UTF32TextChar  firstChar, UTF32TextChar  lastChar, UTF32TextChar  destChar, int32  script = -1  )

inline

Set range with unicode values.

Parameters

firstChar	Unicode value of first character in composite font.
lastChar	Unicode value of last character in composite font.
destChar	Unicode value that first character maps to in component font. In most cases destChar == firstChar. If you want to map a component font to a different area in the composite font you will want to use this value.
script	OBSOLETE.

void CharacterRange::SetRange ( PlatformChar  firstChar, PlatformChar  lastChar, PlatformChar  destChar, int32  script = -1  )

inline

OBSOLETE. Use SetRange(UTF32TextChar...