TTmLineInfo Class Reference

#include <tagma.h>

class TTmLineInfo

Detailed Description

A structure for returning information about a line. One of these is returned by all hit-detection functions. Typically, after finding the position in the document that corresponds to given x-y coordinates, you will want some more information like the line's bounding rectangle. When you call, for example, CTmTextLayout::FindXyPos you will receive a TTmLineInfo object that will tell you this, and much more.

Member Attribute Documentation

iBaseline

TInt iBaseline

y coordinate of the baseline

iEnd

TInt iEnd

End document position

iFlags

TUint iFlags

Start of paragraph, end of paragraph, etc.

iInnerRect

TRect iInnerRect

Inner enclosing rectangle: the text only

iLineInPar

TInt iLineInPar

Line number in the paragraph

iLineNumber

TInt iLineNumber

Line number

iOuterRect

TRect iOuterRect

Outer enclosing rectangle including margins

iParNumber

TInt iParNumber

Paragraph number

iParTop

TInt iParTop

y coordinate of the top of the paragraph

iStart

TInt iStart

Start document position

Member Enumeration Documentation

Enum anonymous

EnumeratorValueDescription
EParStart1
EParEnd2
EParRightToLeft4
ELineEndsInForcedLineBreak8
EPictureButtsLowerEdge16
Deprecated
  • no effect, present for compatibility only

Deprecated
  • no effect, present for compatibility only

EPictureButtsUpperEdge32
Deprecated
  • no effect, present for compatibility only

Deprecated
  • no effect, present for compatibility only

Constructor & Destructor Documentation

TTmLineInfo ( )

TTmLineInfo()[inline]

Constructs a TTmLineInfo object, setting all data members to 0.