Class: TLineLayoutStyle

Declaration: LineLayoutStyles.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStyle

Inherited By:

TBiDirectionalStyle TBooleanStyle TColorStyle TFontFeatureTagStyle TFontKerningTableStyle TGCoordinateStyle TGraphicObjectStyle TGraphicOverlay THiddenStyle TJustificationRuleStyle TLineDirectionStyle TLongStyle TManualKernStyle TSuperSubStyle TTabBarStyle TTextLayerStyle

Purpose:

Derived from TStyle, it provides the abstract base protocol for many of the style classes used by line layout.

Instantiation:

Abstract class; do not instantiate directly.

Deriving Classes:

Any style class whose main focus is on line layout (as opposed, for example, to applying to entire paragraphs) might be a derived class of TLineLayoutStyle.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Member Function: TLineLayoutStyle::GetCategory

virtual const TStyleCategory & GetCategory () const

Interface Category:

API.

Purpose:

Obtains the category of a line layout style.

Calling Context:

Called to obtain the category of a line layout style.

Parameters:

Return Value:

The category of a line layout style.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TLineLayoutStyle::GetStyleCategory

static const TStyleCategory & GetStyleCategory ()

Interface Category:

API.

Purpose:

Obtains the category of all line layout styles.

Calling Context:

Called to obtain the category of all line layout styles.

Parameters:

Return Value:

The category of all line layout styles.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TLineLayoutStyle::operator=

TLineLayoutStyle & operator =(const TLineLayoutStyle &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

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

virtual TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

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

virtual TStream & operator >>=(TStream & toWhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

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

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

Interface Category:

API.

Purpose:

Equality operator.

Calling Context:

Call to compare two objects.

Parameters:

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: TLineLayoutStyle::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Overrides inherited MCollectible function.

Calling Context:

Same as for base class.

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

Return Value:

The TToken for the associated name.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TLineLayoutStyle::~TLineLayoutStyle

virtual ~ TLineLayoutStyle ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TLineLayoutStyle::TLineLayoutStyle

  1. TLineLayoutStyle ()
  2. TLineLayoutStyle (const TLineLayoutStyle &)

Interface Category:

API.

Purpose:

  1. Default constructor.
  2. Copy constructor.

Calling Context:

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

Parameters:

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.
Copyright©1995 Taligent,Inc. All rights reserved.