Class: TMarginAndIndentDirectionParagraphStyle

Declaration: TextParagraphStyles.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TAbstractParagraphStyle

Inherited By:

None.

Purpose:

TMarginAndIndentDirectionParagraphStyle, derived from TAbstractParagraphStyle, is used to specify whether TLeadingMarginParagraphStyle, TTrailingMarginParagraphStyle, and TIndentParagraphStyle use absolute or relative line direction. In relative sequencing (the default), leading and trailing are defined using the panel's line orientation and the paragraph's TSegmentHorizontalSequenceParagraphStyle (left-to-right or right-to-left) or TSegmentVerticalSequenceParagraphStyle (top-to-bottom or bottom-to-top). In absolute sequencing, leading is interpreted as left-to-right for horizontal lines, and top-to-bottom for vertical lines, and trailing is interpreted as right-to-left for horizontal lines, and bottom-to-top for vertical lines.

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

TMarginAndIndentDirectionParagraphStyle (TSingleLineOrientation :: ESequenceRelativity marginAndIndentDirectionOption)
TMarginAndIndentDirectionParagraphStyle (const TMarginAndIndentDirectionParagraphStyle &)
TMarginAndIndentDirectionParagraphStyle ()

Interface Category:

API.

Purpose:

Constructor for creating a TMarginAndIndentDirectionParagraphStyle with the specified direction option (kUseRelativeSequence or kUseAbsoluteSequence).
Copy constructor.
Default constructor.

Calling Context:

Called to construct a TMarginAndIndentDirectionParagraphStyle with the specified direction option (kUseRelativeSequence or kUseAbsoluteSequence).
Called to copy an object.
Called by the stream-in operators.

Parameters:

TSingleLineOrientation :: ESequenceRelativity marginAndIndentDirectionOption -The direction option (kUseRelativeSequence or kUseAbsoluteSequence). If it's kUseRelativeSequence, leading and trailing are defined using the panel's line orientation and the paragraph's TSegmentHorizontalSequenceParagraphStyle (left-to-right or right-to-left) or TSegmentVerticalSequenceParagraphStyle (top-to-bottom or bottom-to-top). If it's kUseAbsoluteSequence, leading is interpreted as left-to-right for horizontal lines, and top-to-bottom for vertical lines, and trailing is interpreted as right-to-left for horizontal lines, and bottom-to-top for vertical lines.
const TMarginAndIndentDirectionParagraphStyle & -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: TMarginAndIndentDirectionParagraphStyle::~TMarginAndIndentDirectionParagraphStyle

virtual ~ TMarginAndIndentDirectionParagraphStyle ()

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

virtual const TStyleName & GetName () const

Interface Category:

API.

Purpose:

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

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Overrides inherited TAbstractParagraphStyle function.

Member Function: TMarginAndIndentDirectionParagraphStyle::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: TMarginAndIndentDirectionParagraphStyle::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: TMarginAndIndentDirectionParagraphStyle::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: TMarginAndIndentDirectionParagraphStyle::GetMarginAndIndentDirectionOption

virtual TSingleLineOrientation::ESequenceRelativity GetMarginAndIndentDirectionOption () const

Interface Category:

API.

Purpose:

Returns the margin and indent direction option.

Calling Context:

May be called directly by client.

Parameters:

Takes no parameters.

Return Value:

The margin and indent direction option, either kUseRelativeSequence or kUseAbsoluteSequence. If it's kUseRelativeSequence, leading and trailing are defined using the panel's line orientation and the paragraph's TSegmentHorizontalSequenceParagraphStyle (left-to-right or right-to-left) or TSegmentVerticalSequenceParagraphStyle (top-to-bottom or bottom-to-top). If it's kUseAbsoluteSequence, leading is interpreted as left-to-right for horizontal lines, and top-to-bottom for vertical lines, and trailing is interpreted as right-to-left for horizontal lines, and bottom-to-top for vertical lines.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Overrides inherited TAbstractParagraphStyle function.

Member Function: TMarginAndIndentDirectionParagraphStyle::SetMarginAndIndentDirectionOption

virtual void SetMarginAndIndentDirectionOption (TSingleLineOrientation :: ESequenceRelativity marginAndIndentDirectionOption)

Interface Category:

API.

Purpose:

Sets the margin and indent direction option.

Calling Context:

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

Parameters:

TSingleLineOrientation :: ESequenceRelativity marginAndIndentDirectionOption -The margin and indent direction option, either kUseRelativeSequence or kUseAbsoluteSequence. If it's kUseRelativeSequence, leading and trailing are defined using the panel's line orientation and the paragraph's TSegmentHorizontalSequenceParagraphStyle (left-to-right or right-to-left) or TSegmentVerticalSequenceParagraphStyle (top-to-bottom or bottom-to-top). If it's kUseAbsoluteSequence, leading is interpreted as left-to-right for horizontal lines, and top-to-bottom for vertical lines, and trailing is interpreted as right-to-left for horizontal lines, and bottom-to-top for vertical lines.

Return Value:

None.

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.