Class: TAbstractSpacingParagraphStyle

Declaration: TextParagraphStyles.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TAbstractParagraphStyle

Inherited By:

TSpaceAfterParagraphStyle TSpaceBeforeParagraphStyle

Purpose:

TAbstractSpacingParagraphStyle is an abstract class used to construct TSpaceBeforeParagraphStyle and TSpaceAfterParagraphStyle. It maintains values that are interpreted as space before values for TSpaceBeforeParagraphStyle objects, and as space after values for TSpaceAfterParagraphStyle objects.

Instantiation:

Abstract class; do not instantiate directly.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TAbstractSpacingParagraphStyle::operator==

bool operator ==(const TStyle & style) const

Interface Category:

API.

Purpose:

Tests whether this object is equivalent to the argument object.

Calling Context:

Called to test equivalence of the two objects on either side of the ==symbol.

Parameters:

const TStyle & style -The style object to be compared to this object.

Return Value:

Returns true if the objects are equivalent.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

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

Member Function: TAbstractSpacingParagraphStyle::GetSplitAmount

virtual GTextCoordinate GetSplitAmount () const

Interface Category:

API.

Purpose:

Returns the space before/after the portion of the paragraph that begins/ends a column, when the paragraph is split across two or more columns.

Calling Context:

Needed for the portion of a paragraph that begins/ends a new column.

Parameters:

Takes no parameters.

Return Value:

The GTextCoordinate specifying the space before/after the portion of the paragraph that begins/ends a column, when the paragraph is split across two or more columns.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAbstractSpacingParagraphStyle::GetAmount

virtual GTextCoordinate GetAmount () const

Interface Category:

API.

Purpose:

Returns the space before/after the paragraph, when the paragraph starts/ends a column.

Calling Context:

Needed for a paragraph when it begins/ends a column.

Parameters:

Takes no parameters.

Return Value:

The GTextCoordinate specifying the space above/below the paragraph, when the paragraph starts/ends a column.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAbstractSpacingParagraphStyle::GetDesignLineHorizontal

virtual EDesignLineHorizontal GetDesignLineHorizontal () const

Interface Category:

API.

Purpose:

Returns the font design line to which the space before/after values are measured, if text is set in horizontal lines.

Calling Context:

May be called directly by client.

Parameters:

Takes no parameters.

Return Value:

The EDesignLineHorizontal value that specifies the font design line to which the space before/after values are measured, if text is set in horizontal lines.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAbstractSpacingParagraphStyle::GetDesignLineVertical

virtual EDesignLineVertical GetDesignLineVertical () const

Interface Category:

API.

Purpose:

Returns the font design line to which the space before/after values are measured, if text is set in vertical lines.

Calling Context:

May be called directly by client.

Parameters:

Takes no parameters.

Return Value:

The EDesignLineVertical value that specifies the font design line to which the space before/after values are measured, if text is set in vertical lines.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAbstractSpacingParagraphStyle::GetInterparagraphMin

virtual GTextCoordinate GetInterparagraphMin () const

Interface Category:

API.

Purpose:

Returns the minimum interparagraph space required before/after the paragraph.

Calling Context:

May be called directly by client.

Parameters:

Takes no parameters.

Return Value:

The minimum interparagraph space required before/after the paragraph, in units of 1/72 of an inch.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAbstractSpacingParagraphStyle::GetInterparagraphToSum

virtual GTextCoordinate GetInterparagraphToSum () const

Interface Category:

API.

Purpose:

Returns the InterparagraphToSumBefore/After value for the paragraph. 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.

Calling Context:

May be called directly by client.

Parameters:

Takes no parameters.

Return Value:

The InterparagraphToSumBefore/After value for the paragraph, in units of 1/72 of an inch.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAbstractSpacingParagraphStyle::TAbstractSpacingParagraphStyle

TAbstractSpacingParagraphStyle (GTextCoordinate interparagraphToSum, GTextCoordinate interparagraphMin =0.0, GTextCoordinate amount =0.0, GTextCoordinate splitAmount =0.0, EDesignLineHorizontal designLineHorizontal =kUpperAccent, EDesignLineVertical designLineVertical =kLeadingAccent)
TAbstractSpacingParagraphStyle (const TAbstractSpacingParagraphStyle &)
TAbstractSpacingParagraphStyle ()

Interface Category:

API.

Purpose:

Constructor for creating a TAbstractSpacingParagraphStyle with the specified values. This constructor is protected.
Copy constructor. This constructor is protected.
Default constructor. This constructor is protected.

Calling Context:

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

Parameters:

GTextCoordinate interparagraphToSum -The InterparagraphToSumBefore/After 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 interparagraphMin =0.0 -The minimum spacing required before/after the paragraph, in units of 1/72 of an inch (default: 0.0).
GTextCoordinate amount =0.0 -The amount of space before/after the paragraph, if it starts/ends a column, in units of 1/72 of an inch (default: 0.0).
GTextCoordinate splitAmount =0.0 -The amount of space before/after the portion of the paragraph that begins/ends a column, when the paragraph is split across two or more columns, in units of 1/72 of an inch (default: 0.0).
EDesignLineHorizontal designLineHorizontal =kUpperAccent -The font design line to which the space before/after values are measured, if text is set in horizontal lines (default: kUpperAccent).
EDesignLineVertical designLineVertical =kLeadingAccent -The font design line to which the space before/after values are measured, if text is set in vertical lines (default: kLeadingAccent).
const TAbstractSpacingParagraphStyle & -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: TAbstractSpacingParagraphStyle::~TAbstractSpacingParagraphStyle

virtual ~ TAbstractSpacingParagraphStyle ()

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:

This function is protected.

Member Function: TAbstractSpacingParagraphStyle::operator=

TAbstractSpacingParagraphStyle & operator =(const TAbstractSpacingParagraphStyle &)

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:

This function is protected.

Member Function: TAbstractSpacingParagraphStyle::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 protected pure virtual function and needs to be overridden.

Member Function: TAbstractSpacingParagraphStyle::SetSplitAmount

virtual void SetSplitAmount (GTextCoordinate splitAmount)

Interface Category:

API.

Purpose:

Sets the amount of space to be used before/after the portion of the paragraph that begins/ends a column, when the paragraph is split across two or more columns.

Calling Context:

Protected member function: to be called only by derived classes.

Parameters:

GTextCoordinate splitAmount -The amount of space to be used before/after the portion of the paragraph that begins/ends a column, when the paragraph is split across two or more columns, in units of 1/72 of an inch.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TAbstractSpacingParagraphStyle::SetAmount

virtual void SetAmount (GTextCoordinate amount)

Interface Category:

API.

Purpose:

Sets the space to be used before/after the paragraph, when the paragraph starts/ends a column.

Calling Context:

Protected member function: to be called only by derived classes.

Parameters:

GTextCoordinate amount -The space to be used before/after the paragraph, when the paragraph starts/ends a column, in units of 1/72 of an inch.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TAbstractSpacingParagraphStyle::SetDesignLineHorizontal

virtual void SetDesignLineHorizontal (EDesignLineHorizontal designLineHorizontal)

Interface Category:

API.

Purpose:

Sets the font design line to which the space before/after values are measured, if text is set in horizontal lines.

Calling Context:

Protected member function: to be called only by derived classes.

Parameters:

EDesignLineHorizontal designLineHorizontal -The value that specifies the font design line to which the space before/after values are measured, if text is set in horizontal lines.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TAbstractSpacingParagraphStyle::SetDesignLineVertical

virtual void SetDesignLineVertical (EDesignLineVertical designLineVertical)

Interface Category:

API.

Purpose:

Sets the font design line to which the space before/after values are measured, if text is set in vertical lines.

Calling Context:

Protected member function: to be called only by derived classes.

Parameters:

EDesignLineVertical designLineVertical -The value that specifies the font design line to which the space before/after values are measured, if text is set in vertical lines.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TAbstractSpacingParagraphStyle::SetInterparagraphMin

virtual void SetInterparagraphMin (GTextCoordinate interparagraphMin)

Interface Category:

API.

Purpose:

Sets the minimum interparagraph space required before/after the paragraph.

Calling Context:

Protected member function: to be called only by derived classes.

Parameters:

GTextCoordinate interparagraphMin -The minimum interparagraph space required before/after the paragraph, in units of 1/72 of an inch.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TAbstractSpacingParagraphStyle::SetInterparagraphToSum

virtual void SetInterparagraphToSum (GTextCoordinate interparagraphToSum)

Interface Category:

API.

Purpose:

Sets the InterparagraphToSumBefore/After value for the paragraph (depending on whether the style applied is a TSpaceBeforeParagraphStyle or TSpaceAfterParagraphStyle). 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.

Calling Context:

Protected member function: to be called only by derived classes.

Parameters:

GTextCoordinate interparagraphToSum -The InterparagraphToSumBefore/After value for the paragraph, in units of 1/72 of an inch.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

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