TTabStop Class Reference

class TTabStop

A tab stop.

This is a position on a page used to align columns of text. It has a twips position and an alignment. The twips position is the width in twips (1/1440th of an inch) of the tab stop, i.e. the number of twips from the start of the line at which text can be inserted. It uniquely identifies the tab stop. The alignment (left, right, or centre) indicates how text inserted at the tab stop should be aligned.

Tab stops are paragraph format attributes. They are owned by the CParaFormat class, through which tab stops can be added and removed.

Public Member Functions
TTabStop()
TTabStop(const TTabStop &)
TBool operator!=(const TTabStop &)
IMPORT_C TTabStop &operator=(const TTabStop &)
IMPORT_C TBooloperator==(const TTabStop &)
Public Member Enumerations
enumTTabType { ENullTab, ELeftTab, ECenteredTab, ERightTab }
Public Attributes
TUint32 iTwipsPosition
TTabType iType

Constructor & Destructor Documentation

TTabStop()

IMPORT_CTTabStop()

TTabStop(const TTabStop &)

IMPORT_CTTabStop(const TTabStop &aTabStop)

Parameters

const TTabStop & aTabStop

Member Functions Documentation

operator!=(const TTabStop &)

TBool operator!=(const TTabStop &aTabStop)const [inline]

Compares two tab stops for inequality. They are different if the twips position or alignment is different.

ETrue if the objects' twips position or alignment differs. EFalse if equal.

Parameters

const TTabStop & aTabStopThe tab stop to compare with the current tab stop

operator=(const TTabStop &)

IMPORT_C TTabStop &operator=(const TTabStop &aTabStop)

Parameters

const TTabStop & aTabStop

operator==(const TTabStop &)

IMPORT_C TBooloperator==(const TTabStop &aTabStop)const

Parameters

const TTabStop & aTabStop

Member Enumerations Documentation

Enum TTabType

Text alignment at the tab stop.

Enumerators

ENullTab

No tab.

ELeftTab

Text is aligned to the tab stop's leading edge (left for left-to-right paragraphs, right for right-to-left paragraphs).

ECenteredTab

Text is aligned to the tab stop's trailing edge (right for left-to-right paragraphs, left for right-to-left paragraphs).

ERightTab

Text is right aligned at the tab stop.

Member Data Documentation

TUint32 iTwipsPosition

TUint32 iTwipsPosition

The twips position. This is the width in twips of the tab stop, i.e. the number of twips from the start of the line at which text can be inserted.

TTabType iType

TTabType iType

Text alignment at the tab stop.