Class: TSpaceBeforeParagraphStyle

Declaration: TextParagraphStyles.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TAbstractSpacingParagraphStyle

Inherited By:

None.

Purpose:

TSpaceBeforeParagraphStyle, derived from TAbstractSpacingParagraphStyle, is a style applied to a text paragraph for setting the spacing before the paragraph. It specifies the spacing before each of the following: (1) the paragraph when it begins at the top of a column, (2) the paragraph when it follows another paragraph within a column, and (3) the portion of the paragraph that begins a new column, when the paragraph is split across two or more columns.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This class is designed to be used directly.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TSpaceBeforeParagraphStyle::TSpaceBeforeParagraphStyle

TSpaceBeforeParagraphStyle (GTextCoordinate interparagraphToSumBefore, GTextCoordinate interparagraphMinBefore =0.0, GTextCoordinate startAmount =0.0, GTextCoordinate startSplitAmount =0.0, TAbstractSpacingParagraphStyle :: EDesignLineHorizontal startDesignLineHorizontal =kUpperAccent, TAbstractSpacingParagraphStyle :: EDesignLineVertical startDesignLineVertical =kLeadingAccent)
TSpaceBeforeParagraphStyle (const TSpaceBeforeParagraphStyle &)
TSpaceBeforeParagraphStyle ()

Interface Category:

API.

Purpose:

Constructor for creating a TSpaceBeforeParagraphStyle with the specified values.
Copy constructor.
Default constructor.

Calling Context:

Called to construct a TSpaceBeforeParagraphStyle with the specified values.
Called to copy an object.
Called by the stream-in operators.

Parameters:

GTextCoordinate interparagraphToSumBefore -The InterparagraphToSumBefore value for the paragraph, in units of 1/72 of an inch. Note that interparagraph space is determined from the maximum of the following: (1) InterparagraphMinAfter for the prior paragraph, (2) InterparagraphMinBefore for the current paragraph, and (3) the sum of InterparagraphToSumAfter for the prior paragraph and InterparagraphToSumBefore for the current paragraph.
GTextCoordinate interparagraphMinBefore =0.0 -The minimum spacing required before the paragraph, in units of 1/72 of an inch (default: 0.0).
GTextCoordinate startAmount =0.0 -The amount of space before the paragraph, if it starts a column, in units of 1/72 of an inch (default: 0.0).
GTextCoordinate startSplitAmount =0.0 -The amount of space before the portion of the paragraph that begins a column, when the paragraph is split across two or more columns, in units of 1/72 of an inch (default: 0.0).
TAbstractSpacingParagraphStyle :: EDesignLineHorizontal startDesignLineHorizontal =kUpperAccent -The font design line to which the space before values are measured, if text is set in horizontal lines (default: kUpperAccent).
TAbstractSpacingParagraphStyle :: EDesignLineVertical startDesignLineVertical =kLeadingAccent -The font design line to which the space before values are measured, if text is set in vertical lines (default: kLeadingAccent).
const TSpaceBeforeParagraphStyle & -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: TSpaceBeforeParagraphStyle::~TSpaceBeforeParagraphStyle

virtual ~ TSpaceBeforeParagraphStyle ()

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: TSpaceBeforeParagraphStyle::GetName

virtual const TStyleName & GetName () const

Interface Category:

API.

Purpose:

Returns the paragraph style name, which is a token created from the class name TSpaceBeforeParagraphStyle.

Calling Context:

Called to determine the name of this style.

Parameters:

Takes no parameters.

Return Value:

A constant reference to the paragraph style name, which is a token created from the class name TSpaceBeforeParagraphStyle.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Overrides inherited TAbstractParagraphStyle function.

Member Function: TSpaceBeforeParagraphStyle::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: TSpaceBeforeParagraphStyle::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.