Class: TCanvasGraphicReadIterator

Declaration: GrafEdit.h

Taxonomy Categories:

Member Functions:


Interface Category:

API.

Inherits From:

None.

Inherited By:

TCanvasGraphicDequeReadIterator

Purpose:

Base class for all canvas graphic read iterators. Permits iteration over graphics in an underlying canvas representation with read-only access.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Abstract base class; must be derived. Should be derived in parallel with classed derived from MCanvasRepresentation.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TCanvasGraphicReadIterator::~TCanvasGraphicReadIterator

virtual ~ TCanvasGraphicReadIterator ()

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.

Member Function: TCanvasGraphicReadIterator::First

virtual const MCanvasGraphic * First ()

Interface Category:

API.

Purpose:

Provides read-only access to the first canvas graphic in the underlying canvas representation during iteration.

Calling Context:

Called to iterate over graphics in a canvas representation.

Parameters:

Return Value:

const MCanvasGraphic * -A const pointer to a canvas graphic.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Pure virtual function; must be overridden.

Member Function: TCanvasGraphicReadIterator::Last

virtual const MCanvasGraphic * Last ()

Interface Category:

API.

Purpose:

Provides read-only access to the last canvas graphic in the underlying canvas representation during iteration.

Calling Context:

Called to iterate over graphics in a canvas representation.

Parameters:

Return Value:

const MCanvasGraphic * -A const pointer to a canvas graphic.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Pure virtual function; must be overridden.

Member Function: TCanvasGraphicReadIterator::Next

virtual const MCanvasGraphic * Next ()

Interface Category:

API.

Purpose:

Provides read-only access to the next canvas graphic in the underlying canvas representation during iteration.

Calling Context:

Called to iterate over graphics in a canvas representation.

Parameters:

Return Value:

const MCanvasGraphic * -A const pointer to a canvas graphic.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Pure virtual function; must be overridden.

Member Function: TCanvasGraphicReadIterator::Previous

virtual const MCanvasGraphic * Previous ()

Interface Category:

API.

Purpose:

Provides read-only access to the previous canvas graphic in the underlying canvas representation during iteration.

Calling Context:

Called to iterate over graphics in a canvas representation.

Parameters:

Return Value:

const MCanvasGraphic * -A const pointer to a canvas graphic.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Pure virtual function; must be overridden.

Member Function: TCanvasGraphicReadIterator::TCanvasGraphicReadIterator

TCanvasGraphicReadIterator ()

Interface Category:

API.

Purpose:

Default constructor.

Calling Context:

Called by constructors of derived classes.

Parameters:

Return Value:

None.

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.