InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IIterator Class Referenceabstract

#include <IIterator.h>

Public Member Functions

virtual UIDRef First ()=0
 
virtual UIDRef Next ()=0
 
virtual UIDRef Last ()=0
 
virtual UIDRef Previous ()=0
 

Detailed Description

IIterator is an abstract base class used to define the interface to iterators within shuksan. Since the initialization & previous/next methods are highly dependant on the thing being iterated over, there is no common implementation, but if all iterators conform to a single standard, they will be easier to use.

Member Function Documentation

virtual UIDRef IIterator::First ()
pure virtual

Initialize internal state

Returns
the first thing being iterated over.
virtual UIDRef IIterator::Last ()
pure virtual
Returns
the last thing being iterated over
virtual UIDRef IIterator::Next ()
pure virtual

Move to the next thing being iterated over.

Returns
a UIDRef, kInvalidUID if there are no more.
virtual UIDRef IIterator::Previous ()
pure virtual

return the previous thing being iterated.

Returns
a UIDRef, kInvalidUID if there are no more.