#include <txtfrmat.h>
| class TCharFormatMask |
| Public Member Functions | |
|---|---|
| TCharFormatMask() | |
| TBool | AttribIsSet(TTextFormatAttribute) |
| IMPORT_C void | ClearAll() |
| void | ClearAttrib(TTextFormatAttribute) |
| TBool | IsNull() |
| IMPORT_C void | SetAll() |
| void | SetAttrib(TTextFormatAttribute) |
| TBool | operator!=(const TCharFormatMask &) |
| IMPORT_C TBool | operator==(const 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.
| TCharFormatMask | ( | ) | [inline] |
The default C++ constructor constructs a character format mask, initialising all bits to zero.
| TBool | AttribIsSet | ( | TTextFormatAttribute | aAttribute | ) | const [inline] |
Tests whether an attribute flag is set.
| Parameter | Description |
|---|---|
| aAttribute | The character format attribute to test for. |
Returns: ETrue if the flag is set, EFalse if not.
| void | ClearAttrib | ( | TTextFormatAttribute | aAttribute | ) | [inline] |
Clears a single attribute flag in the character format mask.
| Parameter | Description |
|---|---|
| aAttribute | The attribute flag to clear. |
| TBool | IsNull | ( | ) | const [inline] |
Tests whether the mask is NULL, indicating that no flags have been set.
Returns: ETrue if mask is NULL, EFalse if not NULL.
| void | SetAttrib | ( | TTextFormatAttribute | aAttribute | ) | [inline] |
Sets a single attribute flag in the character format mask.
| Parameter | Description |
|---|---|
| aAttribute | The attribute flag to set. |
| TBool | operator!= | ( | const TCharFormatMask & | aMask | ) | const [inline] |
Compares two paragraph format masks for inequality.
| Parameter | Description |
|---|---|
| aMask | The mask to compare. |
Returns: ETrue if any flags are different. EFalse if all flags are the same.
| IMPORT_C TBool | operator== | ( | const TCharFormatMask & | aMask | ) | const |
Compares two character format masks for equality.
| Parameter | Description |
|---|---|
| aMask | The mask to compare. |
Returns: ETrue if all flags are the same in both masks. EFalse if any differ.