rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvPrintableDocument::Iterator Class Reference

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

#include <ilviews/printing/document.h>

List of all members.

Public Member Functions

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

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:
other The 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 IlvPrintable object of the current element of the list.

Returns:
A const pointer to an IlvPrintableLayout.
IlvPrintableLayout* IlvPrintableDocument::Iterator::getPrintableLayout (  )  const

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

Returns:
A const pointer to an IlvPrintableLayout.
IlBoolean IlvPrintableDocument::Iterator::operator!= ( IlvPrintableDocument::Iterator const &  other  )  const

Inequality operator.

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

The postfix increment operator.

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

The prefix increment operator.

Returns:
An iterator pointing to the next element in the list.
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.
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.

© Copyright 2012, 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.