Class: TCanvasRectSelectionFunnel

Declaration: CanvasGraphicSelection.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TCanvasGraphicFunnel

Inherited By:

None.

Purpose:

Selects graphics that are completely enclosed within a specified rectangle. Passed into TCanvasView::EnumerateGraphics, this funnel identifies each graphic that is enclosed in a rectangle that it has been given and adds the graphic to the selection it has been given.

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: TCanvasRectSelectionFunnel::TCanvasRectSelectionFunnel

TCanvasRectSelectionFunnel (const TGRect &, MCanvasSelection &, bool shiftedSelection)

Interface Category:

API.

Purpose:

Constructor.

Calling Context:

Called to create a new funnel.

Parameters:

const TGRect & -The rectangle that graphics must be completely within in order to be added to the selection.
MCanvasSelection & -The selection that graphics are to be added to.
bool shiftedSelection -If false, all graphics in the selection are deselected before adding new graphics to it.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCanvasRectSelectionFunnel::~TCanvasRectSelectionFunnel

virtual ~ TCanvasRectSelectionFunnel ()

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

virtual bool ProcessGraphic (const MCanvasGraphic &)

Interface Category:

API.

Purpose:

If the graphic is completely enclosed within the rectangle that was provided in the constructor, then the graphic is added to the selection that was provided in the constructor.

Calling Context:

Typically called by TCanvasView::EnumerateGraphics to process each graphic in the canvas representation.

Parameters:

const MCanvasGraphic & -The canvas graphic to examine.

Return Value:

Returns true.

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.