Class: TCanvasGraphicDequeReadIterator

Declaration: GrafEditUtilities.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TCanvasGraphicReadIterator

Inherited By:

None.

Purpose:

Iterator that produces const pointers to graphics in an associated canvas graphic deque.

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

TCanvasGraphicDequeReadIterator (const TDequeOf < MCanvasGraphic > &)

Interface Category:

API.

Purpose:

Constructor.

Calling Context:

Called to create a new object.

Parameters:

const TDequeOf < MCanvasGraphic > & -A deque of canvas graphics.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCanvasGraphicDequeReadIterator::~TCanvasGraphicDequeReadIterator

virtual ~ TCanvasGraphicDequeReadIterator ()

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

virtual const MCanvasGraphic * First ()

Interface Category:

API.

Purpose:

Returns the first canvas graphic in the deque.

Calling Context:

Call this function directly.

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: TCanvasGraphicDequeReadIterator::Last

virtual const MCanvasGraphic * Last ()

Interface Category:

API.

Purpose:

Returns the last canvas graphic in the deque.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

const MCanvasGraphic * -The last graphic.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TCanvasGraphicDequeReadIterator::Next

virtual const MCanvasGraphic * Next ()

Interface Category:

API.

Purpose:

Returns the next canvas graphic in the deque.

Calling Context:

Call this function directly.

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.

Member Function: TCanvasGraphicDequeReadIterator::Previous

virtual const MCanvasGraphic * Previous ()

Interface Category:

API.

Purpose:

Returns the previous canvas graphic in the deque.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

const MCanvasGraphic * -The previous 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.