Class: TCanvasDrawingFunnel

Declaration: GrafEditUtilities.h

Taxonomy Categories:

Member Functions:

TCanvasDrawingFunnel
~TCanvasDrawingFunnel
ProcessGraphic
GetGrafPort
GetClipRect

Interface Category:

API.

Inherits From:

TCanvasGraphicFunnel

Inherited By:

None.

Purpose:

Funnel used to draw each enumerated graphic.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Intended to be used as is but can also be derived.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TCanvasDrawingFunnel::TCanvasDrawingFunnel

TCanvasDrawingFunnel (TGrafPort * referencePort)

Interface Category:

API.

Purpose:

Constructor.

Calling Context:

Called to create a new object.

Parameters:

TGrafPort * referencePort -The port to draw graphics into.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCanvasDrawingFunnel::~TCanvasDrawingFunnel

virtual ~ TCanvasDrawingFunnel ()

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: TCanvasDrawingFunnel::ProcessGraphic

virtual bool ProcessGraphic (const MCanvasGraphic &)

Interface Category:

API.

Purpose:

Draws the graphic to process.

Calling Context:

Typically called in an implementation of EnumerateGraphics.

Parameters:

const MCanvasGraphic & -The graphic to process.

Return Value:

Always returns false.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCanvasDrawingFunnel::GetGrafPort

TGrafPort * GetGrafPort () const

Interface Category:

API.

Purpose:

Provides access to the graf port for drawing graphics.

Calling Context:

Called internally by ProcessGraphic to access the port to draw graphics into.

Parameters:

Takes no parameters.

Return Value:

TGrafPort * -An alias to the port.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCanvasDrawingFunnel::GetClipRect

TGRect GetClipRect () const

Interface Category:

API.

Purpose:

Provides access to the clipping rectangle for the drawing funnel graphics object.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the clipping rectangle for the drawing funnel.

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.