Class TTmDocPos

class TTmDocPos;

Description

A structure for holding a raw document position that can be converted to or from an x-y position and compared ordinally, which cannot be done with the more abstract TTmDocPosSpec class. Leading edges are distinguished from trailing edges so that bidirectional hit testing and cursor positioning can distinguish between 'after character N', and 'before character N + 1', which may be some distance apart if N and N + 1 are in runs of opposite directionality.

Members

Defined in TTmDocPos:
TTmDocPos(), TTmDocPos(), iLeadingEdge, iPos, operator!=(), operator>(), operator>=(), operator<(), operator<=(), operator==()

inline TTmDocPos();

Description

Constructs a TTmDocPos object, setting iPos to 0 and iLeadingEdge to false. This is the lowest legal value for a TTmDocPos object. A trailing edge comes before a leading edge because it is the trailing edge of the character before the position, while the leading edge is that of the character after the position. ('Leading' means the first to be encountered when traversing the document in logical order).

inline TTmDocPos(TInt aPos, TBool aLeadingEdge);

Description

Constructs a TTmDocPos object, setting iPos to aPos and iLeadingEdge to aLeadingEdge.

Parameters

TInt aPos TBool aLeadingEdge

IMPORT_C TBool operator==(const TTmDocPos &aPos) const;

Description

The equality operator.

Parameters

const TTmDocPos &aPos

Return value

TBool True if both sides are identical.

inline TBool operator!=(const TTmDocPos &aPos) const;

Description

The not equal operator.

Parameters

const TTmDocPos &aPos

Return value

TBool True if both sides have different values.

IMPORT_C TBool operator>(const TTmDocPos &aPos) const;

Description

Greater than operator.

Parameters

const TTmDocPos &aPos

Return value

TBool True if the left side of the operator is further on in the document than the right hand side.

IMPORT_C TBool operator>=(const TTmDocPos &aPos) const;

Description

Greater than or equal to operator.

Parameters

const TTmDocPos &aPos

Return value

TBool True if the left side of the operator is further on in the document than the right hand side or if both sides are identical.

inline TBool operator<(const TTmDocPos &aPos) const;

Description

Smaller than operator.

Parameters

const TTmDocPos &aPos

Return value

TBool True if the right side of the operator is further on in the document than the left hand side.

inline TBool operator<=(const TTmDocPos &aPos) const;

Description

Smaller than or equal to operator.

Parameters

const TTmDocPos &aPos

Return value

TBool True if the right side of the operator is further on in the document than the left hand side or if both sides are identical.

TInt iPos;

Description

the edge position in the document; 0 ... document length

TBool iLeadingEdge;

Description

true if the position is a leading edge