TTabStop Class Reference

#include <txtfrmat.h>

Link against: etext.lib

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

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

Member Attribute Documentation

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.

iType

TTabType iType

Text alignment at the tab stop.

Member Enumeration Documentation

Enum TTabType

Text alignment at the tab stop.

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

Constructor & Destructor Documentation

TTabStop ( )

IMPORT_CTTabStop()

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

TTabStop ( const TTabStop & )

IMPORT_CTTabStop(const TTabStop &aTabStop)

Member Function 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.

ParameterDescription
aTabStopThe tab stop to compare with the current tab stop

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

operator= ( const TTabStop & )

IMPORT_C TTabStop &operator=(const TTabStop &aTabStop)

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

ParameterDescription
aTabStopThe tab stop to assign to the current tab stop.

Returns: The current tab stop.

operator== ( const TTabStop & )

IMPORT_C TBooloperator==(const TTabStop &aTabStop)const

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

ParameterDescription
aTabStopThe tab stop to compare with the current tab stop.

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