Class: TCanvasTopSelectionDrawingFilter

Declaration: CanvasConvenienceFilters.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TCanvasSelectionFilter

Inherited By:

None.

Purpose:

Enumerates all graphics from back to front, including selection graphics. All selection graphics are TSRTBoxFeedbacker graphics. These are on top of all other graphics and are enumerated last.

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.

Other Considerations:

None.

Member Function: TCanvasTopSelectionDrawingFilter::TCanvasTopSelectionDrawingFilter

TCanvasTopSelectionDrawingFilter (const MCanvasSelection * referenceSelection)

Interface Category:

API.

Purpose:

Constructor.

Calling Context:

Called to create a new object.

Parameters:

const MCanvasSelection * referenceSelection -The selection referenced to determine which graphics are selected.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCanvasTopSelectionDrawingFilter::~TCanvasTopSelectionDrawingFilter

virtual ~ TCanvasTopSelectionDrawingFilter ()

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: TCanvasTopSelectionDrawingFilter::First

virtual const MCanvasGraphic * First ()

Interface Category:

API.

Purpose:

Returns the first graphic.

Calling Context:

Typically called from an implementation of EnumerateGraphics.

Parameters:

Takes no parameters.

Return Value:

const MCanvasGraphic * -The first graphic.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCanvasTopSelectionDrawingFilter::Next

virtual const MCanvasGraphic * Next ()

Interface Category:

API.

Purpose:

Returns the next graphic.

Calling Context:

Typically called from an implementation of EnumerateGraphics.

Parameters:

Takes no parameters.

Return Value:

const MCanvasGraphic * -The next graphic.

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.