TParaBorder Class Reference

#include <txtfrmat.h>

Link against: etext.lib

class TParaBorder
Public Attributes
TBool iAutoColor
TLogicalRgb iColor
TLineStyle iLineStyle
TInt iThickness
Public Member Enumerations
enumTLineStyle { ENullLineStyle, ESolid, EDouble, EDotted, ..., EDotDotDash }
Public Member Functions
TParaBorder()
TBool operator!=(const TParaBorder &)
IMPORT_C TBooloperator==(const TParaBorder &)

Detailed 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.

Member Attribute Documentation

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.

iColor

TLogicalRgb iColor

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

iLineStyle

TLineStyle iLineStyle

The line style. By default, ENullLineStyle.

iThickness

TInt iThickness

The line thickness in twips. By default, zero.

Member Enumeration Documentation

Enum TLineStyle

Line styles.

EnumeratorValueDescription
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.

Constructor & Destructor Documentation

TParaBorder ( )

IMPORT_CTParaBorder()

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 Function Documentation

operator!= ( const TParaBorder & )

TBool operator!=(const TParaBorder &aParaBorder)const [inline]

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

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

operator== ( const TParaBorder & )

IMPORT_C TBooloperator==(const TParaBorder &aParaBorder)const

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

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