Class: TTextLayerStyle

Declaration: LineLayoutStyles.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TLineLayoutStyle

Inherited By:

None.

Purpose:

TTextLayerStyle, derived from TLineLayoutStyle, is used to control the layering of overlapping glyphs. The default layer is at level 0, and text with smaller level numbers is painted before text with higher level numbers. This style is most useful in ad-copy where the layering of characters is used to achieve graphic effects.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derive classes to provide a more sophisticated implementation of layered text.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Member Function: TTextLayerStyle::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.

Member Function: TTextLayerStyle::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: TTextLayerStyle::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: TTextLayerStyle::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: TTextLayerStyle::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: TTextLayerStyle::LayerLevel

virtual signed long LayerLevel () const

Interface Category:

API.

Purpose:

Returns the level of the layer defined by this style object.

Calling Context:

Called when drawing to get the layer level.

Parameters:

Takes no parameters.

Return Value:

The layer level.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TTextLayerStyle::~TTextLayerStyle

virtual ~ TTextLayerStyle ()

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

TTextLayerStyle ()
TTextLayerStyle (signed long layerLevel)
TTextLayerStyle (const TTextLayerStyle &)

Interface Category:

API.

Purpose:

Default constructor.
Constructs a layer style object with a specified value.
Copy constructor.

Calling Context:

Called by the stream-in operators.
Call to construct a layer style object with a particular value.
Called to copy an object.

Parameters:

Takes no parameters.
signed long layerLevel -The layer level value for this style object.
const TTextLayerStyle & -The object to copy.

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.