Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
None.
Inherited By:
TCanvasSelectionFilter
TCanvasBackToFrontFilter
TCanvasFrontToBackFilter
Purpose:
Controls which canvas graphics are enumerated in TCanvasView::EnumerateGraphics and MCanvasSelection::EnumerateGraphics.
Instantiation:
Allocate on the heap or the stack.
Deriving Classes:
Abstract base class; must be derived from to develop specific concrete filter classes.
Concurrency:
Not multithread safe.
Resource Use:
No special requirements.
Other Considerations:
In EnumerateGraphics, an iterator is created to iterate over all canvas graphics. The filter's iterator is set with SetIterator. Then the filter is used to iterate over selected canvas graphics. EnumerateGraphics calls First to get the first canvas graphic to be iterated and calls Next to get each subsequent canvas graphic to be iterated. The filter uses the iterator that it was given in SetIterator to do its job.
virtual ~ TCanvasGraphicFilter ()
Interface Category:
API.
Purpose:
Destructor.
Calling Context:
Called to destroy an object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual const MCanvasGraphic * First ()
Interface Category:
API.
Purpose:
Gets the first canvas graphic to be enumerated.
Calling Context:
Called in EnumerateGraphics implementations.
Parameters:
Return Value:
An MCanvasGraphic.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual const MCanvasGraphic * Next ()
Interface Category:
API.
Purpose:
Gets the subsequent canvas graphic to be enumerated.
Calling Context:
Called in EnumerateGraphics implementations.
Parameters:
Return Value:
An MCanvasGraphic.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
void SetIterator (TCanvasGraphicReadIterator *)
Interface Category:
API.
Purpose:
Sets the iterator of the filter.
Calling Context:
Called in EnumerateGraphics implementations.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
TCanvasGraphicFilter ()
Interface Category:
API.
Purpose:
Default constructor.
Calling Context:
Called by the stream-in operators and constructors of derived classes.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
TCanvasGraphicReadIterator * GetIterator ()
Interface Category:
API.
Purpose:
Gets the iterator of the filter.
Calling Context:
Provided for symmetry of SetIterator.
Parameters:
Return Value:
A TCanvasGraphicReadIterator.
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.
Copyright©1995 Taligent,Inc. All rights reserved.