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...
IlvPrintable *	getPrintable () const
	Returns the printable object of the current element of the list. More...
IlvPrintableLayout *	getPrintableLayout () const
	Returns the printable layout object of the current element of the list. More...
IlBoolean	operator!= (Iterator const &other) const
	Inequality operator. More...
Iterator &	operator++ ()
	The prefix increment operator. More...
Iterator	operator++ (int)
	The postfix increment operator. More...
Iterator &	operator= (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

Iterator()

IlvPrintableDocument::Iterator::Iterator

(

Iterator const &

other

)

The copy constructor.

Parameters

other

The object to be copied.

~Iterator()

IlvPrintableDocument::Iterator::~Iterator

(

)

The destructor.

Cleans the resources used by the object.

Member Function Documentation

getPrintable()

IlvPrintable* IlvPrintableDocument::Iterator::getPrintable

(

)

const

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

Returns

The current IlvPrintable.

getPrintableLayout()

IlvPrintableLayout* IlvPrintableDocument::Iterator::getPrintableLayout

(

)

const

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

Returns

The current IlvPrintableLayout.

operator!=()

IlBoolean IlvPrintableDocument::Iterator::operator!=

(

Iterator const &

other

)

const

Inequality operator.

Parameters

other

The object to be compared with.

Returns

IlFalse when objects are equal, IlTrue otherwise.

operator++() [1/2]

Iterator& IlvPrintableDocument::Iterator::operator++

(

)

The prefix increment operator.

Returns

An iterator pointing to the next element in the list.

operator++() [2/2]

Iterator IlvPrintableDocument::Iterator::operator++

(

int

)

The postfix increment operator.

Returns

An iterator pointing to the current element in the list.

operator=()

Iterator& IlvPrintableDocument::Iterator::operator=

(

Iterator const &

other

)

Assignment operator.

Parameters

other

The object to assign to the current object.

Returns

A reference to the current object.

operator==()

IlBoolean IlvPrintableDocument::Iterator::operator==

(

Iterator const &

other

)

const

Equality operator.

Parameters

other

The object to be compared with.

Returns

IlTrue when objects are equal, IlFalse otherwise.