Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
None.
Inherited By:
None.
Purpose:
An abstract base class for an object that is used to iterate over a list of TPageDescriptions.
Instantiation:
Allocate on the heap or the stack.
Deriving Classes:
Not intended for general derived classes. Developers of Printer Handlers can derive from this class to provide a list of page descriptions available for a given printer. Page description iterators are normally provided to clients through TPrinter objects so only the abstract interface is provided. Clients who do derive classes must override Next, First, and Remove which have standard iterator behavior.
Concurrency:
Not multithread safe.
Resource Use:
No special requirements.
virtual ~ TPageDescriptionIterator ()
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 TPageDescription * Next ()
Interface Category:
API.
Purpose:
Gets the next element in the list.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the next TPageDescription object in the collection.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual TPageDescription * First ()
Interface Category:
API.
Purpose:
Get first element in the list.
Calling Context:
Call this function directly.
Parameters:
Return Value:
Returns the first TPageDescription object in the collection.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual void Remove ()
Interface Category:
API.
Purpose:
Removes the current element in the list.
Calling Context:
Call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
TPageDescriptionIterator ()
Interface Category:
API.
Purpose:
Default constructor.
Calling Context:
Called by the stream-in operators.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
This is a protected constructor.
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.