Class: TLinkedClipPort

Declaration: GrafPort.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TLinkedGrafPort

Inherited By:

None.

Purpose:

TLinkedClipPort is a concrete class, derived from TLinkedGrafPort, that concatenates a 2-D clip area with a parent port. The TLinkedClipPort constructors take an argument that specifies a clip area directly, as a TGArea or indirectly, as a clip state. The child's resultant clip area is the intersection of this specified clip area with the parent's clip area.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

The parent port must exist as long as the child port exists.

Member Function: TLinkedClipPort::TLinkedClipPort

TLinkedClipPort (TGrafPort * referencedParentPort, const TGArea & clipArea)
TLinkedClipPort (TGrafPort * referencedParentPort, TLinkableTransformedClipState * referencedClipState)
TLinkedClipPort (TGrafPort * referencedParentPort, TLinkableClipState * referencedClipState)

Interface Category:

API.

Purpose:

Constructs a new TLinkedClipPort with the specified TGrafPort as its parent, concatenating the clip area specified by the TGArea argument with the parent port's state.
Constructs a new TLinkedClipPort with the specified TGrafPort as its parent, concatenating the clip area specified by the TLinkableTransformedClipState argument with the parent port's state.
Constructs a new TLinkedClipPort with the specified TGrafPort as its parent, concatenating the clip area specified by the TLinkableClipState argument with the parent port's state.

Calling Context:

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

Parameters:

TGrafPort * referencedParentPort -The graph port to use as the parent.
const TGArea & clipArea -The clipping area to concatenate with the parent port's state.
TGrafPort * referencedParentPort -The graph port to use as the parent.
TLinkableTransformedClipState * referencedClipState -The clipping state to concatenate with the parent port's state.
TGrafPort * referencedParentPort -The graph port to use as the parent.
TLinkableClipState * referencedClipState -The clipping state to concatenate with the parent port's state.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TLinkedClipPort::~TLinkedClipPort

virtual ~ TLinkedClipPort ()

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: TLinkedClipPort::GetState

virtual const TGrafState * GetState () const

Interface Category:

API.

Purpose:

Returns a pointer to a TGrafState object that represents the concatenated graphic state of this object.

Calling Context:

Do not call this function directly. This function is designed to be called by internal classes of the Graphics system (most notably, TGrafStateAccessor).

Parameters:

Takes no parameters.

Return Value:

Returns a constant pointer to the concatenated graphic 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.