Class TParaBorder

TParaBorder

Support

Supported from 5.0

Description

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.

Defined in TParaBorder:
EDashed, EDotDash, EDotDotDash, EDotted, EDouble, ENullLineStyle, ESolid, TLineStyle, TParaBorder(), iAutoColor, iColor, iLineStyle, iThickness, operator!=(), operator==()

TParaBorder();

Description

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.

TBool operator==(const TParaBorder& aBorder)const;

Description

Compares two paragraph border sides for equality. For two paragraph border sides to be equal, all data members must be equal.

Parameters

const TParaBorder& aBorder The paragraph border to compare with the current border.

Return value

TBool ETrue if the two paragraph border sides are equal, EFalse if not.

TBool operator!=(const TParaBorder& aBorder)const;

Description

Compares two paragraph border sides for inequality. Two paragraph border sides are different if any of their data members are different.

Parameters

const TParaBorder& aBorder The paragraph border to compare with the current border.

Return value

TBool ETrue if the two paragraph border sides are different, EFalse if not.

TLineStyle iLineStyle

Description

The line style. By default, ENullLineStyle.

TInt iThickness

Description

The line thickness in twips. By default, zero.

TRgb iColor

Support

Withdrawn in 6.0

Description

The line colour. By default, black.

TLogicalRgb iColor

Support

Supported from 6.0

Description

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

TBool iAutoColor

Description

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.

TLineStyle

Description

Line styles.

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.