KABC::AddressBook::Iterator Class Reference
Address Book Iterator. More...
#include <addressbook.h>
Public Member Functions | |
| Iterator (const Iterator &) | |
| Iterator () | |
| bool | operator!= (const Iterator &it) const |
| Addressee & | operator* () |
| const Addressee & | operator* () const |
| Iterator & | operator++ (int) |
| Iterator & | operator++ () |
| Iterator & | operator-- (int) |
| Iterator & | operator-- () |
| Addressee * | operator-> () |
| Iterator & | operator= (const Iterator &) |
| bool | operator== (const Iterator &it) const |
Detailed Description
This class provides an iterator for address book entries.
Definition at line 62 of file addressbook.h.
Constructor & Destructor Documentation
| AddressBook::Iterator::Iterator | ( | ) |
Default constructor.
Definition at line 63 of file addressbook.cpp.
| AddressBook::Iterator::Iterator | ( | const Iterator & | i | ) |
Copy constructor.
Definition at line 68 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:
trueif the iterators are not equal,falseotherwise
Definition at line 179 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 100 of file addressbook.cpp.
| const Addressee & AddressBook::Iterator::operator* | ( | ) | const |
Constant Dereference operator.
- Note:
- For invalid iterators, the result is undefined.
- Returns:
- the
constAddressee object the iterator points to.
Definition at line 95 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 135 of file addressbook.cpp.
| AddressBook::Iterator & AddressBook::Iterator::operator++ | ( | ) |
Preincrement operator.
Advances the iterator by one.
- Returns:
- this iterator,
*this
Definition at line 110 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 167 of file addressbook.cpp.
| AddressBook::Iterator & AddressBook::Iterator::operator-- | ( | ) |
Predecrement operator.
Decreases the iterator by one.
- Returns:
- this iterator,
*this
Definition at line 160 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 105 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 77 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:
trueif both iterators are equal,falseotherwise
Definition at line 174 of file addressbook.cpp.
The documentation for this class was generated from the following files:
