Class TTabStop

class TTabStop;

Description

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.

Members

Defined in TTabStop:
ECenteredTab, ELeftTab, ENullTab, ERightTab, TTabStop(), TTabStop(), TTabType, iTwipsPosition, iType, operator!=(), operator=(), operator==()

IMPORT_C TTabStop();

Description

The default C++ constructor constructs a TTabStop. The twips position is initialised to zero and the alignment to ELeftTab.

IMPORT_C TTabStop(const TTabStop &aTabStop);

Description

Parameters

const TTabStop &aTabStop

IMPORT_C TTabStop &operator=(const TTabStop &aTabStop);

Description

Assigns the twips position and alignment of aTabStop to the current TTabStop.

Parameters

const TTabStop &aTabStop The tab stop to assign to the current tab stop.

Return value

TTabStop & The current tab stop.

IMPORT_C TBool operator==(const TTabStop &aTabStop) const;

Description

Compares two tab stops for equality. To be equal, they must have the same twips position and alignment.

Parameters

const TTabStop &aTabStop The tab stop to compare with the current tab stop.

Return value

TBool ETrue if both tab stops have the same twips position and alignment. EFalse if not.

inline TBool operator!=(const TTabStop &aTabStop) const;

Description

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

Parameters

const TTabStop &aTabStop The tab stop to compare with the current tab stop

Return value

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

TTabType

Description

Text alignment at the tab stop.

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.

TUint32 iTwipsPosition;

Description

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;

Description

Text alignment at the tab stop.