Class: TAbstractGCoordinateParagraphStyle

Declaration: TextParagraphStyles.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TAbstractParagraphStyle

Inherited By:

TLeadingMarginParagraphStyle TTrailingMarginParagraphStyle

Purpose:

TAbstractGCoordinateParagraphStyle is an abstract class used to build paragraph styles containing a GCoordinate value.

Instantiation:

Abstract class; do not instantiate directly.

Deriving Classes:

Derive a paragraph style class from TAbstractGCoordinateParagraphStyle when the class needs to contain a value of type GCoordinate. Two such classes are provided by CommonPoint: TLeadingMarginParagraphStyle and TTrailingMarginParagraphStyle.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TAbstractGCoordinateParagraphStyle::Value

virtual GCoordinate Value () const

Interface Category:

API.

Purpose:

Access function that returns the value of type GCoordinate that is stored by this class.

Calling Context:

Called to check the value.

Parameters:

Return Value:

The value of type GCoordinate that is stored by this class.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAbstractGCoordinateParagraphStyle::operator==

bool operator ==(const TStyle & style) const

Interface Category:

API.

Purpose:

Tests whether this object is equivalent to the argument object.

Calling Context:

Called to test equivalence of the two objects on either side of the ==symbol.

Parameters:

Return Value:

Returns true if the objects are equivalent.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

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

Not multithread safe.

Other Considerations:

None.

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

Not multithread safe.

Other Considerations:

None.

Member Function: TAbstractGCoordinateParagraphStyle::TAbstractGCoordinateParagraphStyle

  1. TAbstractGCoordinateParagraphStyle (const TAbstractGCoordinateParagraphStyle & that)
  2. TAbstractGCoordinateParagraphStyle (GCoordinate value)
  3. TAbstractGCoordinateParagraphStyle ()

Interface Category:

API.

Purpose:

  1. Copy constructor. This constructor is protected.
  2. Constructor for creating a TAbstractGCoordinateParagraphStyle with the specified GCoordinate value. This constructor is protected.
  3. Default constructor. This constructor is protected.

Calling Context:

  1. Called to copy an object.
  2. Called to create a TAbstractGCoordinateParagraphStyle with the specified GCoordinate value.
  3. Called by the stream-in operators.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAbstractGCoordinateParagraphStyle::~TAbstractGCoordinateParagraphStyle

virtual ~ TAbstractGCoordinateParagraphStyle ()

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:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TAbstractGCoordinateParagraphStyle::operator=

TAbstractGCoordinateParagraphStyle & operator =(const TAbstractGCoordinateParagraphStyle &)

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:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TAbstractGCoordinateParagraphStyle::GetName

virtual const TStyleName & GetName () const

Interface Category:

API.

Purpose:

Returns the style name.

Calling Context:

Called to determine the name of this style.

Parameters:

Return Value:

The style name.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This is a protected pure virtual function and needs to be overridden.

Member Function: TAbstractGCoordinateParagraphStyle::Set

virtual void Set (GCoordinate)

Interface Category:

API.

Purpose:

Sets the GCoordinate value stored by this object to the specified value.

Calling Context:

Protected member function: to be called only by derived classes to initialize or change the value.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not 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.