Class: TMultiLineOrientation

Declaration: LineOrientation.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TSingleLineOrientation

Inherited By:

None.

Purpose:

TMultiLineOrientation, derived from TSingleLineOrientation, defines additional control of text positioning as needed for multi-line text.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derive to provide additional controls for the orientation and placement of text.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Member Function: TMultiLineOrientation::~TMultiLineOrientation

virtual ~ TMultiLineOrientation ()

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:

Multithread safe.

Other Considerations:

None.

Member Function: TMultiLineOrientation::SetHorizontalSequenceOfLines

virtual void SetHorizontalSequenceOfLines (EHorizontalSequence sequence)

Interface Category:

API.

Purpose:

Sets the horizontal sequence of lines for a block of text lines.

Calling Context:

Used (for example, by editable text) to set the horizontal sequence of lines for a block of text lines.

Parameters:

EHorizontalSequence sequence -The horizontal sequence of lines.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMultiLineOrientation::GetHorizontalSequenceOfLines

virtual EHorizontalSequence GetHorizontalSequenceOfLines () const

Interface Category:

API.

Purpose:

Returns the horizontal sequence of lines for a block of lines.

Calling Context:

Called by Line Layout when laying out multiple lines of text.

Parameters:

Takes no parameters.

Return Value:

The horizontal sequence of lines.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMultiLineOrientation::SetVerticalSequenceOfLines

virtual void SetVerticalSequenceOfLines (EVerticalSequence sequence)

Interface Category:

API.

Purpose:

Sets the vertical sequence of lines for a block of text lines.

Calling Context:

Used (for example, by editable text) to set the vertical sequence of lines for a block of text.

Parameters:

EVerticalSequence sequence -The vertical sequence of lines.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMultiLineOrientation::GetVerticalSequenceOfLines

virtual EVerticalSequence GetVerticalSequenceOfLines () const

Interface Category:

API.

Purpose:

Returns the vertical sequence of lines for a block of text lines.

Calling Context:

Called by Line Layout when laying out multiple lines of text.

Parameters:

Takes no parameters.

Return Value:

The vertical sequence of lines.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMultiLineOrientation::SetLinePlacement

virtual void SetLinePlacement (ESequencePlacement placement)

Interface Category:

API.

Purpose:

Sets the line placement for each line in a block of lines.

Calling Context:

Called by Line Layout when laying out multiple lines of text.

Parameters:

ESequencePlacement placement -The line placement.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMultiLineOrientation::GetLinePlacement

virtual ESequencePlacement GetLinePlacement () const

Interface Category:

API.

Purpose:

Returns the line placement for each line in a block of lines.

Calling Context:

Called by Line Layout when laying out multiple lines of text.

Parameters:

Takes no parameters.

Return Value:

The line placement.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMultiLineOrientation::operator=

TMultiLineOrientation & operator =(const TMultiLineOrientation &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TMultiLineOrientation & -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:

Multithread safe.

Other Considerations:

None.

Member Function: TMultiLineOrientation::operator==

bool operator ==(const TMultiLineOrientation &) const

Interface Category:

API.

Purpose:

Equality operator.

Calling Context:

Call to compare two objects.

Parameters:

const TMultiLineOrientation & -The object to compare to this object.

Return Value:

Returns true if the objects are equal.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMultiLineOrientation::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:

Multithread safe.

Other Considerations:

None.

Member Function: TMultiLineOrientation::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:

Multithread safe.

Other Considerations:

None.

Member Function: TMultiLineOrientation::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Overrides inherited MCollectible function.

Calling Context:

Same as for base class.

Parameters:

Takes no parameters.

Return Value:

The numeric value of the hash.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TMultiLineOrientation::TMultiLineOrientation

TMultiLineOrientation ()
TMultiLineOrientation (const TMultiLineOrientation &)
TMultiLineOrientation (const TSingleLineOrientation &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.
Creates a TMultiLineOrientation object from a TSingleLineOrientation object, supplying default values for the additional information.

Calling Context:

Called by the stream-in operators and to create a TMultiLineOrientation with default values for all its information.
Called to copy an object.
Called to create a TMultiLineOrientation from a TSingleLineOrientation.

Parameters:

Takes no parameters.
const TMultiLineOrientation & -The object to copy.
const TSingleLineOrientation & -The object to use in construction.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

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