Class: TSegmentVerticalSequenceParagraphStyle

Declaration: TextParagraphStyles.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TAbstractParagraphStyle

Inherited By:

None.

Purpose:

TSegmentVerticalSequenceParagraphStyle describes the reading sequence of the words in each line of text of the paragraphs to which this style is applied, when the lineOrientation is kVertical. This defines both the direction sequence for tab stops and the default direction sequence for characters in the line. Character direction may be overridden by the language character style or by explicit character styles.

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

TSegmentVerticalSequenceParagraphStyle ()
TSegmentVerticalSequenceParagraphStyle (TSingleLineOrientation :: EVerticalSequence value)
TSegmentVerticalSequenceParagraphStyle (const TSegmentVerticalSequenceParagraphStyle & value)

Interface Category:

API.

Purpose:

Default constructor.
Constructor for creating a TSegmentVerticalSequenceParagraphStyle with the specified reading sequence of words in each line.
Copy constructor.

Calling Context:

Called by the stream-in operators.
Called to construct a TSegmentVerticalSequenceParagraphStyle with the specified reading sequence of words in each line.
Called to copy an object.

Parameters:

Takes no parameters.
TSingleLineOrientation :: EVerticalSequence value -The vertical reading sequence of words in each line, either kTopToBottom or kBottomToTop.
const TSegmentVerticalSequenceParagraphStyle & value -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TSegmentVerticalSequenceParagraphStyle::~TSegmentVerticalSequenceParagraphStyle

virtual ~ TSegmentVerticalSequenceParagraphStyle ()

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: TSegmentVerticalSequenceParagraphStyle::operator==

bool operator ==(const TStyle & thatStyle) 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: TSegmentVerticalSequenceParagraphStyle::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: TSegmentVerticalSequenceParagraphStyle::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: TSegmentVerticalSequenceParagraphStyle::GetName

virtual const TStyleName & GetName () const

Interface Category:

API.

Purpose:

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

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Overrides inherited TAbstractParagraphStyle function.

Member Function: TSegmentVerticalSequenceParagraphStyle::GetSegmentVerticalSequence

virtual const TSingleLineOrientation::EVerticalSequence GetSegmentVerticalSequence () const

Interface Category:

API.

Purpose:

Returns the vertical reading sequence of words in each line, either kTopToBottom or kBottomToTop.

Calling Context:

May be called directly by client.

Parameters:

Takes no parameters.

Return Value:

The vertical reading sequence of words in each line, either kTopToBottom or kBottomToTop.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Overrides inherited TAbstractParagraphStyle function.

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