Class: TLeadingMarginParagraphStyle

Declaration: TextParagraphStyles.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TAbstractGCoordinateParagraphStyle

Inherited By:

None.

Purpose:

TLeadingMarginParagraphStyle, derived from TAbstractGCoordinateParagraphStyle, is used to set the margin on the leading side of a paragraph, where leading is interpreted according to TMarginAndIndentDirectionParagraphStyle.

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: TLeadingMarginParagraphStyle::TLeadingMarginParagraphStyle

TLeadingMarginParagraphStyle (const GTextCoordinate leadingMargin)
TLeadingMarginParagraphStyle (const TLeadingMarginParagraphStyle &)
TLeadingMarginParagraphStyle ()

Interface Category:

API.

Purpose:

Constructor for creating a TLeadingMarginParagraphStyle with the specified leading margin.
Copy constructor.
Default constructor. This sets the leading margin to 0.0.

Calling Context:

Called to construct a TLeadingMarginParagraphStyle with the specified leading margin.
Called to copy an object.
Called by the stream-in operators.

Parameters:

const GTextCoordinate leadingMargin -The leading margin. A positive amount is the distance inward from the panel margin nearest to the leading edge of the paragraph, in units of 1/72 of an inch.
const TLeadingMarginParagraphStyle & -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: TLeadingMarginParagraphStyle::~TLeadingMarginParagraphStyle

virtual ~ TLeadingMarginParagraphStyle ()

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

virtual const TStyleName & GetName () const

Interface Category:

API.

Purpose:

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

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Overrides inherited TAbstractParagraphStyle function.

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