Collapse all Symbian^3 Product Developer Library

TParaBorder Class Reference

class TParaBorder

Defines the characteristics of one of the four sides of a paragraph border.

These are the line style, thickness and colour. Paragraph borders are paragraph format attributes. They are owned by the CParaFormat class which allows paragraph borders to be added and removed. The CParaFormat::TParaBorderSide enumeration identifies which side of the paragraph the object applies to.

Public Member Functions
	TParaBorder()
TBool	operator!=(const TParaBorder &)
IMPORT_C TBool	operator==(const TParaBorder &)

Public Member Enumerations
enum	TLineStyle { ENullLineStyle, ESolid, EDouble, EDotted, EDashed, EDotDash, EDotDotDash }

Public Attributes
TBool	iAutoColor
TLogicalRgb	iColor
TLineStyle	iLineStyle
TInt	iThickness

Constructor & Destructor Documentation

TParaBorder()

IMPORT_C

TParaBorder

(

)

The default C++ constructor constructs a TParaBorder, initializing its line style to ENullLineStyle, its line thickness to zero, its colour to KRgbBlack and iAutocolor to ETrue.

Member Functions Documentation

operator!=(const TParaBorder &)

TBool

operator!=

(

const TParaBorder &

aParaBorder

)

const [inline]

Parameters

const TParaBorder & aParaBorder

operator==(const TParaBorder &)

IMPORT_C TBool

operator==

(

const TParaBorder &

aParaBorder

)

const

Parameters

const TParaBorder & aParaBorder

Member Enumerations Documentation

Enum TLineStyle

Line styles.

Enumerators

ENullLineStyle	No line style.
ESolid	Solid line.
EDouble	Double solid line.
EDotted	Dotted line.
EDashed	Dashed line.
EDotDash	Alternating dots and dashes.
EDotDotDash	Alternating sequence of two dots and a dash.

Member Data Documentation

TBool iAutoColor

TBool

iAutoColor

ETrue indicates that the line colour is set to the default or current text colour, overriding iColor. EFalse indicates that the iColor value is used. By default, ETrue.

TLogicalRgb iColor

TLogicalRgb

iColor

The line colour. By default, the system's default foreground colour.

TLineStyle iLineStyle

TLineStyle

iLineStyle

The line style. By default, ENullLineStyle.

TInt iThickness

TInt	iThickness

The line thickness in twips. By default, zero.