Class: TSingleLineOrientation

Declaration: LineOrientation.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

TMultiLineOrientation

Purpose:

Defines the orientation of a single line of text elements within specific rectangular bounds.

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

TSingleLineOrientation ()
TSingleLineOrientation (const TSingleLineOrientation &)

Interface Category:

API.

Purpose:

Default constructor.
Copy constructor.

Calling Context:

Called by the stream-in operators.
Called to copy an object.

Parameters:

Takes no parameters.
const TSingleLineOrientation & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TSingleLineOrientation::~TSingleLineOrientation

virtual ~ TSingleLineOrientation ()

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: TSingleLineOrientation::SetLineOrientation

virtual void SetLineOrientation (ELineOrientation orientation)

Interface Category:

API.

Purpose:

Sets the orientation of the line, vertical or horizontal.

Calling Context:

Call to set the orientation of the line.

Parameters:

ELineOrientation orientation -The orientation of the line.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TSingleLineOrientation::GetLineOrientation

virtual ELineOrientation GetLineOrientation () const

Interface Category:

API.

Purpose:

Returns the orientation of the line, vertical or horizontal.

Calling Context:

Called by Line Layout to get the orientation of the line.

Parameters:

Takes no parameters.

Return Value:

The orientation of the line.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TSingleLineOrientation::SetHorizontalSequenceOfSegments

virtual void SetHorizontalSequenceOfSegments (EHorizontalSequence sequence)

Interface Category:

API.

Purpose:

Sets the horizontal sequence of segments for the line, left-to-right or right-to-left.

Calling Context:

Call to set the horizontal sequence of segments.

Parameters:

EHorizontalSequence sequence -The horizontal sequence of segments for the line.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TSingleLineOrientation::GetHorizontalSequenceOfSegments

virtual EHorizontalSequence GetHorizontalSequenceOfSegments () const

Interface Category:

API.

Purpose:

Returns the horizontal sequence of segments for the line, left-to-right or right-to-left.

Calling Context:

Called by Line Layout to get the horizontal sequence of segments.

Parameters:

Takes no parameters.

Return Value:

The horizontal sequence of segments.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TSingleLineOrientation::SetVerticalSequenceOfSegments

virtual void SetVerticalSequenceOfSegments (EVerticalSequence sequence)

Interface Category:

API.

Purpose:

Sets the vertical sequence of segments for the line, top-to-bottom or bottom-to-top.

Calling Context:

Call to set the vertical sequence of segments.

Parameters:

EVerticalSequence sequence -The vertical sequence of segments.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TSingleLineOrientation::GetVerticalSequenceOfSegments

virtual EVerticalSequence GetVerticalSequenceOfSegments () const

Interface Category:

API.

Purpose:

Returns the vertical sequence of segments for the line, top-to-bottom or bottom-to-top.

Calling Context:

Called by Line Layout to get the vertical sequence of segments.

Parameters:

Takes no parameters.

Return Value:

The vertical sequence of segments.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TSingleLineOrientation::SetSegmentPlacement

virtual void SetSegmentPlacement (ESequencePlacement placement)

Interface Category:

API.

Purpose:

Sets the segment placement for this line: at the start, at the middle, at the end, or spread evenly.

Calling Context:

Call to set the segment placement for this line.

Parameters:

ESequencePlacement placement -The segment placement for this line.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TSingleLineOrientation::GetSegmentPlacement

virtual ESequencePlacement GetSegmentPlacement () const

Interface Category:

API.

Purpose:

Returns the segment placement for this line: at the start, at the middle, at the end, or spread evenly.

Calling Context:

Called by Line Layout to get the segment placement.

Parameters:

Takes no parameters.

Return Value:

The segment placement for the line.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TSingleLineOrientation::operator=

TSingleLineOrientation & operator =(const TSingleLineOrientation &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TSingleLineOrientation & -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: TSingleLineOrientation::operator==

bool operator ==(const TSingleLineOrientation &) const

Interface Category:

API.

Purpose:

Equality operator.

Calling Context:

Called to compare two objects.

Parameters:

const TSingleLineOrientation & -The object to compare with 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: TSingleLineOrientation::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: TSingleLineOrientation::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: TSingleLineOrientation::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.

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