Class: TGraphicGroupIterator

Declaration: Graphics.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TGraphicIterator

Inherited By:

None.

Purpose:

Used for building a hierarchical structure comprised of graphic objects. This class contains functions useful for traversing and managing this hierarchical tree.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

None.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TGraphicGroupIterator::TGraphicGroupIterator

TGraphicGroupIterator (const TGraphicGroup *)

Interface Category:

API.

Purpose:

Copy constructor.

Calling Context:

Called to copy an object.

Parameters:

const TGraphicGroup * -The graphic group to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGraphicGroupIterator::~TGraphicGroupIterator

virtual ~ TGraphicGroupIterator ()

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: TGraphicGroupIterator::Reset

virtual void Reset ()

Interface Category:

API.

Purpose:

Resets this TGraphicGroupIterator to the first MGraphic in the hierarchy.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGraphicGroupIterator::First

virtual MGraphic * First ()

Interface Category:

API.

Purpose:

Gets the first MGraphic in the hierarchy.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a pointer to the first graphic in the hierarchy.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGraphicGroupIterator::Last

virtual MGraphic * Last ()

Interface Category:

API.

Purpose:

Gets the last MGraphic in the hierarchy.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a pointer to the last graphic in the hierarchy.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGraphicGroupIterator::Next

virtual MGraphic * Next ()

Interface Category:

API.

Purpose:

Increments the iterator and returns a pointer to that MGraphic.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a pointer to the next graphic in the hierarchy.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TGraphicGroupIterator::Previous

virtual MGraphic * Previous ()

Interface Category:

API.

Purpose:

Decrements the iterator and returns a pointer to that MGraphic.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a pointer to the previous graphic in the hierarchy.

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.