Rogue Wave Views
Foundation Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions | Friends
IlvPrintableDocument::Iterator Class Reference

Iterator class to walk through the objects stored in an IlvPrintableDocument. More...

#include <ilviews/printing/document.h>

Public Member Functions

 Iterator (Iterator const &other)
 The copy constructor. More...
 
 ~Iterator ()
 The destructor. More...
 
IlvPrintablegetPrintable () const
 Returns the printable object of the current element of the list. More...
 
IlvPrintableLayoutgetPrintableLayout () const
 Returns the printable layout object of the current element of the list. More...
 
IlBoolean operator!= (Iterator const &other) const
 Inequality operator. More...
 
Iteratoroperator++ ()
 The prefix increment operator. More...
 
Iterator operator++ (int)
 The postfix increment operator. More...
 
Iteratoroperator= (Iterator const &other)
 Assignment operator. More...
 
IlBoolean operator== (Iterator const &other) const
 Equality operator. More...
 

Friends

class IlvPrintableDocument
 

Detailed Description

Iterator class to walk through the objects stored in an IlvPrintableDocument.

Library: ilvprint

Constructor & Destructor Documentation

IlvPrintableDocument::Iterator::Iterator ( Iterator const &  other)

The copy constructor.

Parameters
otherThe object to be copied.
IlvPrintableDocument::Iterator::~Iterator ( )

The destructor.

Cleans the resources used by the object.

Member Function Documentation

IlvPrintable* IlvPrintableDocument::Iterator::getPrintable ( ) const

Returns the printable object of the current element of the list.

Returns
The current IlvPrintable.
IlvPrintableLayout* IlvPrintableDocument::Iterator::getPrintableLayout ( ) const

Returns the printable layout object of the current element of the list.

Returns
The current IlvPrintableLayout.
IlBoolean IlvPrintableDocument::Iterator::operator!= ( Iterator const &  other) const

Inequality operator.

Parameters
otherThe object to be compared with.
Returns
IlFalse when objects are equal, IlTrue otherwise.
Iterator& IlvPrintableDocument::Iterator::operator++ ( )

The prefix increment operator.

Returns
An iterator pointing to the next element in the list.
Iterator IlvPrintableDocument::Iterator::operator++ ( int  )

The postfix increment operator.

Returns
An iterator pointing to the current element in the list.
Iterator& IlvPrintableDocument::Iterator::operator= ( Iterator const &  other)

Assignment operator.

Parameters
otherThe object to assign to the current object.
Returns
A reference to the current object.
IlBoolean IlvPrintableDocument::Iterator::operator== ( Iterator const &  other) const

Equality operator.

Parameters
otherThe object to be compared with.
Returns
IlTrue when objects are equal, IlFalse otherwise.

© Copyright 2016, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.