Class: TLinkedClipGrafState

Declaration: GrafState.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TLinkedGrafState

Inherited By:

None.

Purpose:

Derived from TLinkedGrafState, TLinkedClipGrafState links a TGArea object (or a TLinkableClipState, or TLinkableTransformedClipState object) to a parent TGrafState object. This class is used internally by TLinkedClipPort. Most programmers who want to link a clip area or clip state into a graphics hierarchy use TLinkedClipPort, instead of using TLinkedClipGrafState directly.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TLinkedClipGrafState::TLinkedClipGrafState

TLinkedClipGrafState (const TGrafState * parent, const TGArea & clipArea)
TLinkedClipGrafState (const TGrafState * parent, TLinkableTransformedClipState * clipState)
TLinkedClipGrafState (const TGrafState * parent, TLinkableClipState * clipState)

Interface Category:

API.

Purpose:

Constructor that links the specified clip area to the specified parent graphics state. A local clip state is instantiated and linked to the parent graphics state.
Constructor that links the specified transformed clip state to the specified parent graphics state.
Constructor that links the specified clip state to the specified parent graphics state.

Calling Context:

Call this function directly.
Call this function directly.
Call this function directly.

Parameters:

const TGrafState * parent -The TGrafState to use as the parent.
const TGArea & clipArea -The clip area to link to the parent.
const TGrafState * parent -The TGrafState to use as the parent.
TLinkableTransformedClipState * clipState -The transformed clip state to link to the parent.
const TGrafState * parent -The TGrafState to use as the parent.
TLinkableClipState * clipState -The clip state to link to the parent.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLinkedClipGrafState::~TLinkedClipGrafState

virtual ~ TLinkedClipGrafState ()

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:

Not multithread safe.

Other Considerations:

None.

Member Function: TLinkedClipGrafState::GetClipState

virtual const TClipState * GetClipState () const

Interface Category:

API.

Purpose:

Returns a constant pointer to the clip state previously linked to the parent.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a constant pointer to the clip state.

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.