TParaFormatMask Class Reference

#include <txtfrmat.h>

Link against: etext.lib

class TParaFormatMask

Public Member Functions
	TParaFormatMask()
TBool	AttribIsSet(TTextFormatAttribute)
IMPORT_C void	ClearAll()
void	ClearAttrib(TTextFormatAttribute)
TBool	IsNull()
IMPORT_C void	SetAll()
void	SetAttrib(TTextFormatAttribute)
TBool	operator!=(const TParaFormatMask &)
IMPORT_C TBool	operator==(const TParaFormatMask &)

Detailed Description

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

Used in conjunction with an object of class CParaFormat. When setting formatting, only the attributes which are set in the mask will 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

TParaFormatMask ( )

TParaFormatMask

(

)

[inline]

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

Member Function Documentation

AttribIsSet ( TTextFormatAttribute )

TBool

AttribIsSet

(

TTextFormatAttribute

aAttribute

)

const [inline]

Tests whether an attribute flag is set.

Parameter	Description
aAttribute	The paragraph format attribute to test for.

Returns: ETrue if the flag is set, EFalse if not.

ClearAll ( )

IMPORT_C void

ClearAll

(

)

Clears all attribute flags in the paragraph format mask.

ClearAttrib ( TTextFormatAttribute )

void

ClearAttrib

(

TTextFormatAttribute

aAttribute

)

[inline]

Clears a single attribute flag in the paragraph format mask.

Parameter	Description
aAttribute	The attribute flag to clear.

IsNull ( )

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.

SetAll ( )

IMPORT_C void

SetAll

(

)

Sets all attribute flags in the paragraph format mask.

SetAttrib ( TTextFormatAttribute )

void

SetAttrib

(

TTextFormatAttribute

aAttribute

)

[inline]

Sets a single attribute flag in the paragraph format mask.

Parameter	Description
aAttribute	The attribute flag to set.

operator!= ( const TParaFormatMask & )

TBool

operator!=

(

const TParaFormatMask &

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.

operator== ( const TParaFormatMask & )

IMPORT_C TBool

operator==

(

const TParaFormatMask &

aMask

)

const

Compares two paragraph 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.