TCharFormatMask Class Reference

class TCharFormatMask

Masks the character format attributes which are involved when setting and sensing character formatting.

Used in conjunction with an object of class TCharFormat .

When setting formatting, only the attributes which are set in the mask should participate in the relevant function. When sensing formatting, on return, the mask indicates which attributes were sensed from the format layer, and were not taken from the default values.

Constructor & Destructor Documentation

TCharFormatMask()

TCharFormatMask ( ) [inline]

The default C++ constructor constructs a character format mask, initialising all bits to zero.

Member Functions Documentation

AttribIsSet(TTextFormatAttribute)

TBool AttribIsSet ( TTextFormatAttribute aAttribute ) const [inline]

Tests whether an attribute flag is set.

Parameters

TTextFormatAttribute aAttribute The character format attribute to test for.

ClearAll()

IMPORT_C void ClearAll ( )

ClearAttrib(TTextFormatAttribute)

void ClearAttrib ( TTextFormatAttribute aAttribute ) [inline]

Clears a single attribute flag in the character format mask.

Parameters

TTextFormatAttribute aAttribute The attribute flag to clear.

IsNull()

TBool IsNull ( ) const [inline]

Tests whether the mask is NULL, indicating that no flags have been set.

SetAll()

IMPORT_C void SetAll ( )

SetAttrib(TTextFormatAttribute)

void SetAttrib ( TTextFormatAttribute aAttribute ) [inline]

Sets a single attribute flag in the character format mask.

Parameters

TTextFormatAttribute aAttribute The attribute flag to set.

operator!=(const TCharFormatMask &)

TBool operator!= ( const TCharFormatMask & aMask ) const [inline]

Compares two paragraph format masks for inequality.

Parameters

const TCharFormatMask & aMask The mask to compare.

operator==(const TCharFormatMask &)

IMPORT_C TBool operator== ( const TCharFormatMask & aMask ) const

Parameters

const TCharFormatMask & aMask

Member Data Documentation

TUint32 iGuard

TUint32 iGuard [private]