TBullet Class Reference

#include <txtfrmat.h>

Link against: etext.lib

class TBullet

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

Member Attribute Documentation

iAlignment

TAlignment iAlignment

iCharacterCode

TChar iCharacterCode

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

iColor

TLogicalRgb iColor

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

iHangingIndent

TBool iHangingIndent

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.

iHeightInTwips

TUint iHeightInTwips

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

iStartNumber

TInt iStartNumber

iStyle

TStyle iStyle

iTypeface

TTypeface iTypeface

The typeface used for the bullet point character.

Member Enumeration Documentation

Enum TAlignment

Paragraph alignment

EnumeratorValueDescription
ELeftAlign

Paragraph left aligned.

ECenterAlign

Paragraph centre aligned.

ERightAlign

Paragraph right aligned.

Enum TStyle

Identifies the bullet style.

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

EnumeratorValueDescription
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

Constructor & Destructor Documentation

TBullet ( )

IMPORT_CTBullet()

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.

Member Function Documentation

operator!= ( const TBullet & )

TBool operator!=(const TBullet &aBullet)const [inline]

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

ParameterDescription
aBulletThe bullet point to compare.

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

operator== ( const TBullet & )

IMPORT_C TBooloperator==(const TBullet &aBullet)const

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

ParameterDescription
aBulletThe bullet point to compare.

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