KABC::AddressBook::ConstIterator Class Reference

#include <addressbook.h>

Public Member Functions
	ConstIterator ()
	ConstIterator (const ConstIterator &)
	ConstIterator (const Iterator &)
bool	operator!= (const ConstIterator &it) const
const Addressee &	operator* () const
ConstIterator &	operator++ ()
ConstIterator &	operator++ (int)
ConstIterator &	operator-- ()
ConstIterator &	operator-- (int)
const Addressee *	operator-> () const
ConstIterator &	operator= (const ConstIterator &)
bool	operator== (const ConstIterator &it) const

Detailed Description

Address Book Const Iterator.

This class provides a const iterator for address book entries.

Definition at line 169 of file addressbook.h.

Constructor & Destructor Documentation

AddressBook::ConstIterator::ConstIterator

(

)

Default constructor.

Definition at line 183 of file addressbook.cpp.

AddressBook::ConstIterator::ConstIterator

(

const ConstIterator &

i

)

Copy constructor.

Definition at line 188 of file addressbook.cpp.

AddressBook::ConstIterator::ConstIterator

(

const Iterator &

i

)

Copy constructor.

Constructs a ConstIterator from an non-const Iterator

Definition at line 197 of file addressbook.cpp.

Member Function Documentation

bool AddressBook::ConstIterator::operator!=

(

const ConstIterator &

it

)

const

Inequality operator.

Compares this iterator to it

Parameters

it	the iterator to compare this iterator to

Returns

true if the iterators are not equal, false otherwise

Definition at line 302 of file addressbook.cpp.

const Addressee & AddressBook::ConstIterator::operator*

(

)

const

Constant Dereference operator.

Note

For invalid iterators, the result is undefined.

Unlike in Iterator, there is no non-constant dereference operator.

Returns

the const Addressee object the iterator points to.

Definition at line 225 of file addressbook.cpp.

AddressBook::ConstIterator & AddressBook::ConstIterator::operator++

(

)

Preincrement operator.

Advances the iterator by one.

Returns

this iterator, *this

Definition at line 235 of file addressbook.cpp.

AddressBook::ConstIterator & AddressBook::ConstIterator::operator++

(

int

)

Postincrement operator.

Advances the iterator by one.

Note

This function does not copy the iterator object.

Returns

this iterator, *this

Definition at line 260 of file addressbook.cpp.

AddressBook::ConstIterator & AddressBook::ConstIterator::operator--

(

)

Predecrement operator.

Decreases the iterator by one.

Returns

this iterator, *this

Definition at line 285 of file addressbook.cpp.

AddressBook::ConstIterator & AddressBook::ConstIterator::operator--

(

int

)

Postdecrement operator.

Decreases the iterator by one.

Note

This function does not copy the iterator object.

Returns

this iterator, *this

Definition at line 291 of file addressbook.cpp.

const Addressee * AddressBook::ConstIterator::operator->

(

)

const

Arrow Dereference operator, provided for convenience.

Note

For invalid iterators, the result is undefined.

Returns

the Addressee object the iterator points to.

Definition at line 230 of file addressbook.cpp.

AddressBook::ConstIterator & AddressBook::ConstIterator::operator=

(

const ConstIterator &

i

)

Assignment operator.

Assignes the given iterator to *this.

Returns

this iterator, *this

Definition at line 207 of file addressbook.cpp.

bool AddressBook::ConstIterator::operator==

(

const ConstIterator &

it

)

const

Equality operator.

Compares this iterator to it

Parameters

it	the iterator to compare this iterator to

Returns

true if both iterators are equal, false otherwise

Definition at line 297 of file addressbook.cpp.

---

The documentation for this class was generated from the following files:

• addressbook.h
• addressbook.cpp