kabc
#include <addressbook.h>
Public Member Functions | |
Iterator () | |
Iterator (const Iterator &) | |
bool | operator!= (const Iterator &it) const |
Addressee & | operator* () |
const Addressee & | operator* () const |
Iterator & | operator++ () |
Iterator & | operator++ (int) |
Iterator & | operator-- () |
Iterator & | operator-- (int) |
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 64 of file addressbook.h.
Constructor & Destructor Documentation
◆ Iterator() [1/2]
AddressBook::Iterator::Iterator | ( | ) |
Default constructor.
Definition at line 62 of file addressbook.cpp.
◆ Iterator() [2/2]
AddressBook::Iterator::Iterator | ( | const Iterator & | i | ) |
Copy constructor.
Definition at line 67 of file addressbook.cpp.
◆ ~Iterator()
AddressBook::Iterator::~Iterator | ( | ) |
Definition at line 89 of file addressbook.cpp.
Member Function Documentation
◆ operator!=()
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.
◆ operator*() [1/2]
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.
◆ operator*() [2/2]
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.
◆ operator++() [1/2]
AddressBook::Iterator & AddressBook::Iterator::operator++ | ( | ) |
Preincrement operator.
Advances the iterator by one.
- Returns
- this iterator,
*this
Definition at line 109 of file addressbook.cpp.
◆ operator++() [2/2]
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.
◆ operator--() [1/2]
AddressBook::Iterator & AddressBook::Iterator::operator-- | ( | ) |
Predecrement operator.
Decreases the iterator by one.
- Returns
- this iterator,
*this
Definition at line 159 of file addressbook.cpp.
◆ operator--() [2/2]
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.
◆ operator->()
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.
◆ operator=()
AddressBook::Iterator & AddressBook::Iterator::operator= | ( | const Iterator & | i | ) |
Assignment operator.
Assignes the given iterator to *this
.
- Returns
- this iterator,
*this
Definition at line 75 of file addressbook.cpp.
◆ operator==()
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:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Wed Jan 24 2024 00:00:00 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.