KABC::AddressBook::Iterator Class Reference

#include <addressbook.h>

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

Detailed Description

Address Book Iterator.

This class provides an iterator for address book entries.

Definition at line 64 of file addressbook.h.

Constructor & Destructor Documentation

AddressBook::Iterator::Iterator

(

)

Default constructor.

Definition at line 62 of file addressbook.cpp.

AddressBook::Iterator::Iterator

(

const Iterator &

i

)

Copy constructor.

Definition at line 67 of file addressbook.cpp.

Member Function Documentation

bool AddressBook::Iterator::operator!=

(

const Iterator &

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 178 of file addressbook.cpp.

const Addressee & AddressBook::Iterator::operator*

(

)

const

Constant Dereference operator.

Note

For invalid iterators, the result is undefined.

Returns

the const Addressee object the iterator points to.

Definition at line 94 of file addressbook.cpp.

Addressee & AddressBook::Iterator::operator*

(

)

Dereference operator.

Note

For invalid iterators, the result is undefined.

Returns

the Addressee object the iterator points to.

Definition at line 99 of file addressbook.cpp.

AddressBook::Iterator & AddressBook::Iterator::operator++

(

)

Preincrement operator.

Advances the iterator by one.

Returns

this iterator, *this

Definition at line 109 of file addressbook.cpp.

AddressBook::Iterator & AddressBook::Iterator::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 134 of file addressbook.cpp.

AddressBook::Iterator & AddressBook::Iterator::operator--

(

)

Predecrement operator.

Decreases the iterator by one.

Returns

this iterator, *this

Definition at line 159 of file addressbook.cpp.

AddressBook::Iterator & AddressBook::Iterator::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 166 of file addressbook.cpp.

Addressee * AddressBook::Iterator::operator->

(

)

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 104 of file addressbook.cpp.

AddressBook::Iterator & AddressBook::Iterator::operator=

(

const Iterator &

i

)

Assignment operator.

Assignes the given iterator to *this.

Returns

this iterator, *this

Definition at line 76 of file addressbook.cpp.

bool AddressBook::Iterator::operator==

(

const Iterator &

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 173 of file addressbook.cpp.

---

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

• addressbook.h
• addressbook.cpp