Mako 8.1.0 API
Loading...
Searching...
No Matches
JawsMako::IUnicodeHelper Class Referenceabstract

An interface into language specific unicode helpers. More...

#include <text.h>

Inheritance diagram for JawsMako::IUnicodeHelper:

Public Member Functions

virtual bool isCombiningCharacter (const wchar_t wchar) const =0
 Returns true is wchar is within the language's combining character ranges.
 
virtual wchar_t getNonContextualCharacter (const wchar_t ch) const =0
 Performs a reverse mapping on a contextual character and returns the original.
 
virtual bool hasContextualForms () const =0
 Returns true if the language has contextual forms.
 
virtual String constructStringFromRuns (CTextRunVect &runs) const =0
 Creates a string from a CTextRunVect by applying diacritic fixes and contextual substitution, if required. The supplied runs collection must be contain unicode strings of length one. Basically the glyphs need to be in their single character form.
 
virtual void applyDiacriticFixes (CTextRunVect &runs) const =0
 Checks and attempts to fix diacritic characters that are incorrectly ordered.
 
virtual void applyContextualSubstitution (String &input) const =0
 Applies the language's contextual substitution rules, in place.
 
- Public Member Functions inherited from IRCObject
virtual void addRef () const =0
 Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
 
virtual bool decRef () const =0
 Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.
 
virtual int32 getRefCount () const =0
 Retrieve the current reference count of the actual object pointed to.
 

Static Public Member Functions

static JAWSMAKO_API IUnicodeHelperPtr create (eLanguageType language)
 Creates a unicode helper for the specified language.
 
static JAWSMAKO_API bool isSpaceCharacter (wchar_t ch)
 Returns true if ch is a unicode space character.
 

Additional Inherited Members

- Protected Member Functions inherited from IRCObject
virtual ~IRCObject ()
 Virtual destructor.
 

Detailed Description

An interface into language specific unicode helpers.

Member Function Documentation

◆ applyContextualSubstitution()

virtual void JawsMako::IUnicodeHelper::applyContextualSubstitution ( String & input) const
pure virtual

Applies the language's contextual substitution rules, in place.

Parameters
inputThe string to apply the contextual substitution to.

◆ applyDiacriticFixes()

virtual void JawsMako::IUnicodeHelper::applyDiacriticFixes ( CTextRunVect & runs) const
pure virtual

Checks and attempts to fix diacritic characters that are incorrectly ordered.

Parameters
runsThe collection of text runs to apply the fixes to.

◆ constructStringFromRuns()

virtual String JawsMako::IUnicodeHelper::constructStringFromRuns ( CTextRunVect & runs) const
pure virtual

Creates a string from a CTextRunVect by applying diacritic fixes and contextual substitution, if required. The supplied runs collection must be contain unicode strings of length one. Basically the glyphs need to be in their single character form.

Parameters
runsThe collection of text runs to construct the string from.
Returns
String The constructed string.

◆ create()

static JAWSMAKO_API IUnicodeHelperPtr JawsMako::IUnicodeHelper::create ( eLanguageType language)
static

Creates a unicode helper for the specified language.

Parameters
languageThe language type for which the helper should be created.
Returns
IUnicodeHelperPtr A smart pointer to the unicode helper for the specified language.

◆ getNonContextualCharacter()

virtual wchar_t JawsMako::IUnicodeHelper::getNonContextualCharacter ( const wchar_t ch) const
pure virtual

Performs a reverse mapping on a contextual character and returns the original.

Parameters
chThe contextual character to reverse.
Returns
wchar_t The original character.

◆ hasContextualForms()

virtual bool JawsMako::IUnicodeHelper::hasContextualForms ( ) const
pure virtual

Returns true if the language has contextual forms.

Returns
bool True if the language has contextual forms, false otherwise.

◆ isCombiningCharacter()

virtual bool JawsMako::IUnicodeHelper::isCombiningCharacter ( const wchar_t wchar) const
pure virtual

Returns true is wchar is within the language's combining character ranges.

Parameters
wcharThe character to check.
Returns
bool True if the character is a combining character, false otherwise.

◆ isSpaceCharacter()

static JAWSMAKO_API bool JawsMako::IUnicodeHelper::isSpaceCharacter ( wchar_t ch)
static

Returns true if ch is a unicode space character.

Parameters
chThe character to check.
Returns
bool True if the character is a space character, false otherwise.

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