Class TBullet

TBullet

Support

Supported from 5.0

Description

A bullet point is a paragraph format attribute, stored as the iBullet member of class CParaFormat. Bullet points have a typeface, height, colour and a character code (defines the symbol displayed). Single level bullets only are supported. Bullets may also have a hanging indent. If set, this means that the rest of the paragraph following the line containing the bullet point is indented. The data members of this class are public.

Defined in TBullet:
TBullet(), iCharacterCode, iColor, iHangingIndent, iHeightInTwips, iTypeface, operator!=(), operator==()

TBullet();

Description

The default C++ constructor constructs a TBullet, initializing the character code to 0x2022, the height to zero, the colour to the system's default foreground colour and the hanging indent to ETrue. The typeface is not initialised.

TBool operator==(const TBullet& aBullet)const;

Description

Compares two bullet points for equality. For two bullet points to be equal, all data members must be equal.

Parameters

const TBullet& aBullet The bullet point to compare.

Return value

TBool ETrue if the two bullet points are equal, EFalse if not.

TBool operator!=(const TBullet& aBullet)const;

Description

Compares two bullet points for inequality. Two bullet points are unequal if any of their data members are different.

Parameters

const TBullet& aBullet The bullet point to compare.

Return value

TBool ETrue if the two bullet points are different, EFalse if not.

TChar iCharacterCode

Description

The Unicode character used to represent the bullet point. By default 0x2022.

TUint32 iHeightInTwips

Description

The height in twips of the font used for the bullet point character. By default, zero.

TTypeface iTypeface

Description

The typeface used for the bullet point character.

TBool iHangingIndent

Description

ETrue to indent the rest of the paragraph from the bullet point. EFalse to align the bullet point character with the rest of the paragraph.

TRgb iColor

Support

Withdrawn in 6.0

Description

The colour of the bullet point character. By default, black.

TLogicalRgb iColor

Support

Supported from 6.0

Description

The colour of the bullet point character. By default, the system's default foreground colour.