Class MFormCustomInvisibleCharacterRemapper

class MFormCustomInvisibleCharacterRemapper;

Description

Mixin class used to customize visible appearance of invisible characters such as a paragraph mark or a tab.

Members

Defined in MFormCustomInvisibleCharacterRemapper:
DefaultMapping(), Remap()

static IMPORT_C TUint DefaultMapping(TUint aChar, const TNonPrintingCharVisibility aNonPrintingCharVisibility, const TLayDocTextSource &aLayDoc);

Description

Default implementation of mapping invisible character to its specified alternate.

Called by TLayDocTextSource::Map() unless overidden by custom mapping class. May be called by custom mapping class

Parameters

TUint aChar Invisible character to be remapped const TNonPrintingCharVisibility aNonPrintingCharVisibility Current state of flags showing visibility of invisible characters const TLayDocTextSource &aLayDoc Const ref to the calling CLayDocTextSource

Return value

TUint The replacement character if remapping has taken place, else return original character

virtual TUint Remap(TUint aChar, const TNonPrintingCharVisibility aNonPrintingCharVisibility, const TLayDocTextSource &aLayDoc)=0;

Description

Allows custom remapping of invisible characters.

Called by TLayDocTextSource::Map() if it has been created and registered with TLayDocTextSource using CTextLayout::SetInvisibleCharacterRemapper().

Unless there is a specific reason for doing otherwise it is recommended that where this function has not remapped a given character it should pass it to DefaultMapping() to let it try.

Parameters

TUint aChar Invisible character to be remapped const TNonPrintingCharVisibility aNonPrintingCharVisibility const TLayDocTextSource &aLayDoc Const ref to the calling CLayDocTextSource

Return value

TUint The replacement character if remapping has taken place, else return original character