Symbian^3 Product Developer Library >

RTmParFormat Class Reference

class RTmParFormat

WARNING: this Class is for internal use ONLY. Compatibility is not guaranteed in future releases. Paragraph format; all dimensions are in twips unless otherwise specified.

Public Member Functions
RTmParFormat()
const TTmParBorder *Border(TBorderIndex)
const TTmBullet *Bullet()
IMPORT_C voidClose()
IMPORT_C voidCopyL(const RTmParFormat &)
IMPORT_C voidCopyL(const CParaFormat &)
IMPORT_C voidGetCParaFormatL(CParaFormat &)
IMPORT_C TBoolHaveBorders()
TBool RightToLeft()
const TTmTab &Tab(TInt)
IMPORT_C TIntTabs()
TBool operator!=(const RTmParFormat &)
IMPORT_C TBooloperator==(const RTmParFormat &)
Private Member Functions
RTmParFormat(const RTmParFormat &)
voidoperator=(const RTmParFormat &)
Public Member Enumerations
enumanonymous {
ERightToLeft = 1, EKeepTogether = 2, EKeepWithNext = 4, EStartNewPage = 8, EWidowOrphan = 16, ENoWrap = 32, EExactLineSpacing = 64, EPixelLineSpacing = 128, EDirectionalityFromText = 256
}
enumTAlignment {
EAlignNormalBidirectional, EAlignNormal = EAlignNormalBidirectional, EAlignCenter, EAlignReverseBidirectional, EAlignReverse = EAlignReverseBidirectional, EAlignJustify, EAlignAbsoluteLeft, EAlignAbsoluteRight
}
enumTBorderIndex { ETopBorder = 0, EBottomBorder = 1, ELeadingBorder = 2, ETrailingBorder = 3 }
Public Attributes
TAlignment iAlignment
TLogicalRgb iBackgroundColor
TInt iBorderMargin
TInt iFirstLineIndent
TUint iFlags
TInt iLeadingMargin
TInt iLineSpacing
TInt iSpaceAbove
TInt iSpaceBelow
TInt iTabSize
TInt iTrailingMargin
Private Attributes
TTmParBorder *iBorder
TTmBullet *iBullet
RArray< TTmTab > *iTabList

Constructor & Destructor Documentation

RTmParFormat()

IMPORT_CRTmParFormat()

RTmParFormat(const RTmParFormat &)

RTmParFormat(const RTmParFormat &aFormat)[private]

Parameters

const RTmParFormat & aFormat

Member Functions Documentation

Border(TBorderIndex)

const TTmParBorder *Border(TBorderIndexaIndex)const [inline]

Returns a pointer to the border selected by aIndex. Returns null if the selected border is not present.

Parameters

TBorderIndex aIndex

Bullet()

const TTmBullet *Bullet()const [inline]

Returns a pointer to the TTmBullet object if any. Returns null if the RTmParFormat does not contain a TTmBullet.

Close()

IMPORT_C voidClose()

CopyL(const RTmParFormat &)

IMPORT_C voidCopyL(const RTmParFormat &aFormat)

Parameters

const RTmParFormat & aFormat

CopyL(const CParaFormat &)

IMPORT_C voidCopyL(const CParaFormat &aFormat)

Parameters

const CParaFormat & aFormat

GetCParaFormatL(CParaFormat &)

IMPORT_C voidGetCParaFormatL(CParaFormat &aFormat)const

Parameters

CParaFormat & aFormat

HaveBorders()

IMPORT_C TBoolHaveBorders()const

Return TRUE if the paragraph has any borders.

RightToLeft()

TBool RightToLeft()const [inline]

Returns true if the paragraph's base direction is right-to-left.

Tab(TInt)

const TTmTab &Tab(TIntaIndex)const [inline]

Returns a reference to the tab selected by aIndex.

Parameters

TInt aIndex

Tabs()

IMPORT_C TIntTabs()const

Return the number of tab stops stored in the object.

operator!=(const RTmParFormat &)

TBool operator!=(const RTmParFormat &aFormat)const [inline]

The inequality operator. Returns true if this object and aFormat differ in any way.

Parameters

const RTmParFormat & aFormat

operator=(const RTmParFormat &)

voidoperator=(const RTmParFormat &aFormat)[private]

Parameters

const RTmParFormat & aFormat

operator==(const RTmParFormat &)

IMPORT_C TBooloperator==(const RTmParFormat &aFormat)const

Parameters

const RTmParFormat & aFormat

Member Enumerations Documentation

Enum anonymous

Bit assignments for RTmParFormat::iFlags.

Enumerators

ERightToLeft = 1

Base direction of paragraph is right-to-left (as for Arabic)

EKeepTogether = 2

Do not allow paragraph to straddle page boundaries.

EKeepWithNext = 4

Put this paragraph on the same page as the next.

EStartNewPage = 8

Put this paragraph at the start of a new page.

EWidowOrphan = 16

Suppress widows and orphans.

ENoWrap = 32

Suppresses line breaking.

EExactLineSpacing = 64

Force line spacing distance to be respected even on lines that are taller than the specified height.

EPixelLineSpacing = 128

Line spaceing is in pixels, not twips.

EDirectionalityFromText = 256

Work out paragraph directionality from the text.

Enum TAlignment

Paragraph alignment

Enumerators

EAlignNormalBidirectional
EAlignNormal = EAlignNormalBidirectional
EAlignCenter

in 7.0s

EAlignReverseBidirectional
EAlignReverse = EAlignReverseBidirectional
EAlignJustify

in 7.0s

EAlignAbsoluteLeft
EAlignAbsoluteRight

Enum TBorderIndex

Index used to select one of the four borders of a paragraph

Enumerators

ETopBorder = 0
EBottomBorder = 1
ELeadingBorder = 2
ETrailingBorder = 3

Member Data Documentation

TAlignment iAlignment

TAlignment iAlignment

TLogicalRgb iBackgroundColor

TLogicalRgb iBackgroundColor

TTmParBorder * iBorder

TTmParBorder *iBorder[private]

TInt iBorderMargin

TInt iBorderMargin

TTmBullet * iBullet

TTmBullet *iBullet[private]

TInt iFirstLineIndent

TInt iFirstLineIndent

TUint iFlags

TUint iFlags

TInt iLeadingMargin

TInt iLeadingMargin

TInt iLineSpacing

TInt iLineSpacing

TInt iSpaceAbove

TInt iSpaceAbove

TInt iSpaceBelow

TInt iSpaceBelow

RArray< TTmTab > * iTabList

RArray< TTmTab > *iTabList[private]

TInt iTabSize

TInt iTabSize

TInt iTrailingMargin

TInt iTrailingMargin

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.