Class TCharFormatMask

TCharFormatMask

Support

Supported from 5.0

Description

Used in conjunction with an object of class TCharFormat to mask the character format attributes which are involved when setting and sensing character formatting. 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.

Defined in TCharFormatMask:
AttribIsSet(), ClearAll(), ClearAttrib(), IsNull(), SetAll(), SetAttrib(), TCharFormatMask(), operator!=(), operator==()

TCharFormatMask();

Description

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

void SetAttrib(TTextFormatAttribute aAttribute);

Description

Sets a single attribute flag in the character format mask.

Parameters

TTextFormatAttribute aAttribute The attribute flag to set.

void ClearAttrib(TTextFormatAttribute aAttribute);

Description

Clears a single attribute flag in the character format mask.

Parameters

TTextFormatAttribute aAttribute The attribute flag to clear.

void SetAll();

Description

Sets all attribute flags in the character format mask.

void ClearAll();

Description

Clears all attribute flags in the character format mask.

TBool AttribIsSet(TTextFormatAttribute aAttribute)const;

Description

Tests whether an attribute flag is set.

Parameters

TTextFormatAttribute aAttribute The character format attribute to test for.

Return value

TBool ETrue if the flag is set, EFalse if not.

TBool IsNull()const;

Description

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

Return value

TBool ETrue if mask is NULL, EFalse if not NULL.

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

Description

Compares two character format masks for equality.

Parameters

const TCharFormatMask& aMask The mask to compare.

Return value

TBool ETrue if all flags are the same in both masks. EFalse if any differ.

TBool operator!=(const TCharFormatMask& aMask)const;

Description

Compares two paragraph format masks for inequality.

Parameters

const TCharFormatMask& aMask The mask to compare.

Return value

TBool ETrue if any flags are different. EFalse if all flags are the same.