KABC::AddressBook::ConstIterator Class Reference
Address Book Const Iterator. More...
#include <addressbook.h>
Public Member Functions | |
| ConstIterator (const Iterator &) | |
| ConstIterator (const ConstIterator &) | |
| ConstIterator () | |
| bool | operator!= (const ConstIterator &it) const |
| const Addressee & | operator* () const |
| ConstIterator & | operator++ (int) |
| ConstIterator & | operator++ () |
| ConstIterator & | operator-- (int) |
| ConstIterator & | operator-- () |
| const Addressee * | operator-> () const |
| ConstIterator & | operator= (const ConstIterator &) |
| bool | operator== (const ConstIterator &it) const |
Detailed Description
This class provides a const iterator for address book entries.
Definition at line 167 of file addressbook.h.
Constructor & Destructor Documentation
| AddressBook::ConstIterator::ConstIterator | ( | ) |
Default constructor.
Definition at line 184 of file addressbook.cpp.
| AddressBook::ConstIterator::ConstIterator | ( | const ConstIterator & | i | ) |
Copy constructor.
Definition at line 189 of file addressbook.cpp.
| AddressBook::ConstIterator::ConstIterator | ( | const Iterator & | i | ) |
Copy constructor.
Constructs a ConstIterator from an non-const Iterator
Definition at line 198 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:
trueif the iterators are not equal,falseotherwise
Definition at line 303 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
constAddressee object the iterator points to.
Definition at line 226 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 261 of file addressbook.cpp.
| AddressBook::ConstIterator & AddressBook::ConstIterator::operator++ | ( | ) |
Preincrement operator.
Advances the iterator by one.
- Returns:
- this iterator,
*this
Definition at line 236 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 292 of file addressbook.cpp.
| AddressBook::ConstIterator & AddressBook::ConstIterator::operator-- | ( | ) |
Predecrement operator.
Decreases the iterator by one.
- Returns:
- this iterator,
*this
Definition at line 286 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 231 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 208 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:
trueif both iterators are equal,falseotherwise
Definition at line 298 of file addressbook.cpp.
The documentation for this class was generated from the following files:
