Class: TAbstractParagraphStyle

Declaration: TextParagraphStyles.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStyle

Inherited By:

TAbstractBooleanParagraphStyle TAbstractGCoordinateParagraphStyle TAbstractLongParagraphStyle TAbstractSpacingParagraphStyle TFlushParagraphStyle TIndentParagraphStyle TJustifyParagraphStyle TMarginAndIndentDirectionParagraphStyle TSegmentHorizontalSequenceParagraphStyle TSegmentVerticalSequenceParagraphStyle TSpaceWithinParagraphStyle

Purpose:

TAbstractParagraphStyle is the abstract base class that should be used (directly or indirectly) to build all other paragraph style classes.

Instantiation:

Abstract class; do not instantiate directly.

Deriving Classes:

TAbstractParagraphStyle should be used to build all other paragraph style classes. Numerous derived classes are provided by CommonPoint, including TFlushParagraphStyle, TJustifyParagraphStyle, and TMarginAndIndentDirectionParagraphStyle.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TAbstractParagraphStyle::GetCategory

virtual const TStyleCategory & GetCategory () const

Interface Category:

API.

Purpose:

Returns the style category of this object. Currently this indicates that the style is a paragraph style. In the future, there may be different style categories for different types of paragraph styles.

Calling Context:

Called to determine what style category this object is.

Parameters:

Takes no parameters.

Return Value:

The style category.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAbstractParagraphStyle::GetKind

virtual const TStyleKind & GetKind () const

Interface Category:

API.

Purpose:

Returns a reference to an object that indicates to the style manager what kind of style object this is. The style kind determines various behaviors for the style, such as how it is to be stored. There currently is one style kind for all paragraph styles (and another for character styles).

Calling Context:

Called by the style manager to tell what kind of style this object represents.

Parameters:

Takes no parameters.

Return Value:

The style kind.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAbstractParagraphStyle::TAbstractParagraphStyle

TAbstractParagraphStyle (const TAbstractParagraphStyle & that)
TAbstractParagraphStyle ()

Interface Category:

API.

Purpose:

Copy constructor. This constructor is protected.
Default constructor. This constructor is protected.

Calling Context:

Called to copy an object.
Called by the stream-in operators.

Parameters:

const TAbstractParagraphStyle & that -The object to copy.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAbstractParagraphStyle::~TAbstractParagraphStyle

virtual ~ TAbstractParagraphStyle ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAbstractParagraphStyle::GetName

virtual const TStyleName & GetName () const

Interface Category:

API.

Purpose:

Returns the style name.

Calling Context:

Called to determine the name of this style.

Parameters:

Takes no parameters.

Return Value:

The style name.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This is a pure virtual function and needs to be overridden.

Member Function: TAbstractParagraphStyle::operator=

TAbstractParagraphStyle & operator =(const TAbstractParagraphStyle & that)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TAbstractParagraphStyle & that -The source object for the assignment.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAbstractParagraphStyle::operator>>=

virtual TStream & operator >>=(TStream & toWhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & toWhere -The stream the object streams itself out to.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAbstractParagraphStyle::operator<<=

virtual TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromWhere -The stream the object streams itself in from.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.