Views
Foundation Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions | Friends
IlvPrintableComposite::Iterator Class Reference

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

#include <ilviews/printing/composite.h>

Public Member Functions

 Iterator (Iterator const &other)
 The copy constructor. More...
 
 ~Iterator ()
 The destructor. More...
 
Coordinates const * getCoordinates () const
 Returns the Coordinates object of the current element of the list. More...
 
IlvPrintable * getPrintable () const
 Returns the IlvPrintable 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 IlvPrintableComposite
 

Detailed Description

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

Library: ilvprint

Constructor & Destructor Documentation

◆ Iterator()

IlvPrintableComposite::Iterator::Iterator ( Iterator const &  other)

The copy constructor.

Parameters
otherThe object to be copied.

◆ ~Iterator()

IlvPrintableComposite::Iterator::~Iterator ( )

The destructor.

Cleans the resources used by the object.

Member Function Documentation

◆ getCoordinates()

Coordinates const* IlvPrintableComposite::Iterator::getCoordinates ( ) const

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

Returns
A const reference to a Coordinates.

◆ getPrintable()

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

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

Returns
A const reference to an IlvPrintableLayout.

◆ operator!=()

IlBoolean IlvPrintableComposite::Iterator::operator!= ( Iterator const &  other) const

Inequality operator.

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

◆ operator++() [1/2]

Iterator& IlvPrintableComposite::Iterator::operator++ ( )

The prefix increment operator.

Returns
An iterator pointing to the next element in the list.

◆ operator++() [2/2]

Iterator IlvPrintableComposite::Iterator::operator++ ( int  )

The postfix increment operator.

Returns
An iterator pointing to the current element in the list.

◆ operator=()

Iterator& IlvPrintableComposite::Iterator::operator= ( Iterator const &  other)

Assignment operator.

Parameters
otherThe object to assign to the current object.
Returns
A reference to the current object.

◆ operator==()

IlBoolean IlvPrintableComposite::Iterator::operator== ( Iterator const &  other) const

Equality operator.

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