Class: TRootAttributeState

Declaration: AttributeState.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TAttributeState

Inherited By:

None.

Purpose:

TRootAttributeState is a concrete class, derived from TAttributeState, that is ideal for the root 2-D attribute state of a graphic hierarchy. The class supplies the default attributes. The TRootGrafState class uses a TRootAttributeState to represent the default 2-D attribute state. To create a hierarchy, link TLinkableAttributeState objects to a TRootAttributeState object by passing it as an argument to their LinkTo member functions.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TRootAttributeState::TRootAttributeState

  1. TRootAttributeState ()
  2. TRootAttributeState (const TRootAttributeState &)

Interface Category:

API.

Purpose:

  1. Default constructor.
  2. Copy constructor.

Calling Context:

  1. Call to create a root attribute state object.
  2. Called to copy an object.

Parameters:

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootAttributeState::~TRootAttributeState

virtual ~ TRootAttributeState ()

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:

None.

Member Function: TRootAttributeState::GetFillPaint

virtual const TPaint * GetFillPaint () const

Interface Category:

API.

Purpose:

Returns the default paint used for the surface fill operations.

Calling Context:

Call this function directly.

Parameters:

Return Value:

A constant pointer to a default fill paint object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootAttributeState::GetFramePaint

virtual const TPaint * GetFramePaint () const

Interface Category:

API.

Purpose:

Returns the default paint used for the surface frame operations.

Calling Context:

Call this function directly.

Parameters:

Return Value:

A constant pointer to the default frame paint object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootAttributeState::GetFillTransferMode

virtual const TTransferMode * GetFillTransferMode () const

Interface Category:

API.

Purpose:

Returns the default transfer mode used for the surface fill operations.

Calling Context:

Call this function directly.

Parameters:

Return Value:

A constant pointer to the default fill transfer mode object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootAttributeState::GetFrameTransferMode

virtual const TTransferMode * GetFrameTransferMode () const

Interface Category:

API.

Purpose:

Returns the default transfer mode used for the surface frame operations.

Calling Context:

Call this function directly.

Parameters:

Return Value:

A constant pointer to the default frame transfer mode object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootAttributeState::GetFrameJoint

virtual const TJoint * GetFrameJoint () const

Interface Category:

API.

Purpose:

Returns the default frame joint.

Calling Context:

Call this function directly.

Parameters:

Return Value:

A constant pointer to the default frame joint object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootAttributeState::GetFrameEndCap

virtual const TCap * GetFrameEndCap () const

Interface Category:

API.

Purpose:

Returns the default frame end cap.

Calling Context:

Call this function directly.

Parameters:

Return Value:

A constant pointer to the default frame end cap object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootAttributeState::GetFrameStartCap

virtual const TCap * GetFrameStartCap () const

Interface Category:

API.

Purpose:

Returns the default frame start cap.

Calling Context:

Call this function directly.

Parameters:

Return Value:

A constant pointer to the default frame start cap object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootAttributeState::GetFramePen

virtual const TPen * GetFramePen () const

Interface Category:

API.

Purpose:

Returns the default frame pen.

Calling Context:

Call this function directly.

Parameters:

Return Value:

A constant pointer to the default frame pen object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootAttributeState::GetDrawingOperation

virtual EDrawOperation GetDrawingOperation () const

Interface Category:

API.

Purpose:

Returns the default drawing operation.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns the default drawing operation.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootAttributeState::GetImageSampling

virtual const TImageSamplingControl * GetImageSampling () const

Interface Category:

API.

Purpose:

Returns the default image sampling.

Calling Context:

Call this function directly.

Parameters:

Return Value:

A constant pointer to the default image sampling object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootAttributeState::GetImageTransferMode

virtual const TTransferMode * GetImageTransferMode () const

Interface Category:

API.

Purpose:

Returns the default image transfer mode.

Calling Context:

Call this function directly.

Parameters:

Return Value:

A constant pointer to the default image transfer mode.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootAttributeState::GetGrafAttribute

virtual const TGrafAttribute * GetGrafAttribute (const TToken & key) const

Interface Category:

API.

Purpose:

Returns the custom attribute associated with the specified name. Returns NIL if there is no such attribute.

Calling Context:

Call this function directly.

Parameters:

Return Value:

A constant pointer to the custom attribute object, or NIL if it doesn't exist.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TRootAttributeState::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data. This is a protected member function designed to be called from a derived class' operator <<= function.

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

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data. This is a protected member function designed to be called from a derived class' operator >>=function.

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: TRootAttributeState::GetPrimaryDitherHint

virtual const TDitherHint * GetPrimaryDitherHint () const

Interface Category:

API.

Purpose:

Returns a pointer to the current dither hint for this attribute bundle.

Calling Context:

Call this function directly.

Parameters:

Return Value:

Returns the pointer to this attribute bundle's primary dither hint.

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.