Class: TSingleLineOrientationStyle

Declaration: LineLayoutStyles.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStyle

Inherited By:

None.

Purpose:

Derived from TStyle, it encapsulates an instance of TSingleLineOrientation that defines the orientation of a line of text.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Member Function: TSingleLineOrientationStyle::TSingleLineOrientationStyle

TSingleLineOrientationStyle ()
TSingleLineOrientationStyle (const TSingleLineOrientation & orientation)
TSingleLineOrientationStyle (const TSingleLineOrientationStyle &)

Interface Category:

API.

Purpose:

Default constructor.
Constructs a line orientation style object with a specific TSingleLineOrientation instance.
Copy constructor.

Calling Context:

Called by the stream-in operators.
Call directly to instantiate this class.
Called to copy an object.

Parameters:

Takes no parameters.
const TSingleLineOrientation & orientation -The orientation of the line.
const TSingleLineOrientationStyle & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TSingleLineOrientationStyle::~TSingleLineOrientationStyle

virtual ~ TSingleLineOrientationStyle ()

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: TSingleLineOrientationStyle::GetOrientation

virtual void GetOrientation (TSingleLineOrientation &) const

Interface Category:

API.

Purpose:

Returns the orientation object used by this style object.

Calling Context:

Call to get the orientation object used by this style object.

Parameters:

TSingleLineOrientation & -Receives the orientation object used by this style object.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TSingleLineOrientationStyle::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: TSingleLineOrientationStyle::operator==

virtual bool operator ==(const TStyle & thatStyle) const

Interface Category:

API.

Purpose:

Equality operator.

Calling Context:

Called to compare two objects.

Parameters:

const TStyle & thatStyle -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: TSingleLineOrientationStyle::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: TSingleLineOrientationStyle::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: TSingleLineOrientationStyle::GetName

virtual const TStyleName & GetName () const

Interface Category:

API.

Purpose:

Returns the style's internal name. This is not necessarily the class name. For example, there are related underlining styles that are each separate derived classes. However, because they are mutually exclusive, they share the same internal name.

Calling Context:

Called when the name associated with an object is needed; for example, when comparing objects.

Parameters:

Takes no parameters.

Return Value:

The TToken for the associated name.

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.