MFormCustomInvisibleCharacterRemapper Class Reference

#include <frmtlay.h>

class MFormCustomInvisibleCharacterRemapper

Public Member Functions
IMPORT_C TUint	DefaultMapping(TUint, const TNonPrintingCharVisibility, const TLayDocTextSource &)
pure virtual TUint	Remap(TUint, const TNonPrintingCharVisibility, const TLayDocTextSource &)

Detailed Description

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

See also: CTextView::SetCustomInvisibleCharacterRemapper()

Member Function Documentation

DefaultMapping ( TUint, const TNonPrintingCharVisibility, const TLayDocTextSource & )

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

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
aChar	Invisible character to be remapped
aNonPrintingCharVisibility	Current state of flags showing visibility of invisible characters
aLayDoc	Const ref to the calling CLayDocTextSource

Return Value: The replacement character if remapping has taken place, else return original character

Remap ( TUint, const TNonPrintingCharVisibility, const TLayDocTextSource & )

TUint	Remap	(	TUint	aChar,
			const TNonPrintingCharVisibility	aNonPrintingCharVisibility,
			const TLayDocTextSource &	aLayDoc
		)	[pure virtual]

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
aChar	Invisible character to be remapped
aLayDoc	Const ref to the calling CLayDocTextSource

Return Value: The replacement character if remapping has taken place, else return original character