Class TBullet

class TBullet;

Description

A bullet point.

This 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.

Members

Defined in TBullet:
EArabicNumberStyle, EBulletStyle, ECapitalLetterStyle, ECapitalRomanNumberStyle, ECenterAlign, ELeftAlign, ENullStyle, ERightAlign, ESmallLetterStyle, ESmallRomanNumberStyle, TAlignment, TBullet(), TStyle, iAlignment, iCharacterCode, iColor, iHangingIndent, iHeightInTwips, iStartNumber, iStyle, iTypeface, operator!=(), operator==()

IMPORT_C 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.

IMPORT_C 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.

inline 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.

TStyle

Description

Identifies the bullet style.

Note: Styles other than ENullStyle and EBulletStyle are not currently supported. They have the same effect as the EBulletStyle.

ENullStyle No bullet. Used for style layers that override a bullet with the absence of a bullet. EBulletStyle A bullet point. Character with code 0x2022 is used by default. EArabicNumberStyle ESmallRomanNumberStyle ECapitalRomanNumberStyle ESmallLetterStyle ECapitalLetterStyle

TAlignment

Description

Paragraph alignment

ELeftAlign Paragraph left aligned. ECenterAlign Paragraph centre aligned. ERightAlign Paragraph right aligned.

TChar iCharacterCode;

Description

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

TUint 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.

TLogicalRgb iColor;

Description

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

TStyle iStyle;

Description

TInt iStartNumber;

Description

TAlignment iAlignment;

Description