KDE 4.2 API Reference kaddressbook
Filter Class Reference
#include <filter.h>
Detailed Description
Filter for AddressBook related objects (Addressees).
- Todo:
- This class should be switched to use shared data.
Definition at line 39 of file filter.h.
Public Types | |
| typedef QList< Filter > | List |
| enum | MatchRule { Matching = 0, NotMatching = 1 } |
Public Member Functions | |
| void | apply (KABC::Addressee::List &addresseeList) |
| const QStringList & | categories () const |
| Filter (const QString &name) | |
| Filter () | |
| bool | filterAddressee (const KABC::Addressee &a) const |
| bool | isEmpty () const |
| bool | isEnabled () const |
| bool | isInternal () const |
| MatchRule | matchRule () const |
| const QString & | name () const |
| void | restore (KConfigGroup &cfg) |
| void | save (KConfigGroup &cfg) |
| void | setCategories (const QStringList &list) |
| void | setEnabled (bool on) |
| void | setMatchRule (MatchRule rule) |
| void | setName (const QString &name) |
| ~Filter () | |
Static Public Member Functions | |
| static Filter::List | restore (const KConfigBase *config, const QString &baseGroup) |
| static void | save (KConfig *config, const QString &baseGroup, Filter::List &list) |
Member Typedef Documentation
| typedef QList<Filter> Filter::List |
Member Enumeration Documentation
| enum Filter::MatchRule |
Constructor & Destructor Documentation
| Filter::Filter | ( | ) |
Definition at line 32 of file filter.cpp.
| Filter::Filter | ( | const QString & | name | ) |
Definition at line 38 of file filter.cpp.
| Filter::~Filter | ( | ) |
Definition at line 44 of file filter.cpp.
Member Function Documentation
| void Filter::apply | ( | KABC::Addressee::List & | addresseeList | ) |
Apply the filter to the addressee list.
All addressees not passing the filter criterias will be removed from the list.
If the MatchRule is NotMatch, then all the addressees matching the filter will be removed from the list.
Definition at line 65 of file filter.cpp.
| const QStringList & Filter::categories | ( | ) | const |
| bool Filter::filterAddressee | ( | const KABC::Addressee & | a | ) | const |
Apply the filter to the addressee.
- Returns:
- True if the addressee passes the criteria, false otherwise. The return values are opposite if the MatchRule is NotMatch.
Definition at line 76 of file filter.cpp.
| bool Filter::isEmpty | ( | ) | const |
| bool Filter::isEnabled | ( | ) | const |
| bool Filter::isInternal | ( | ) | const |
| Filter::MatchRule Filter::matchRule | ( | ) | const |
| const QString & Filter::name | ( | ) | const |
| Filter::List Filter::restore | ( | const KConfigBase * | config, | |
| const QString & | baseGroup | |||
| ) | [static] |
Restores a list of filters from a config file.
- Parameters:
-
config The config file to read from. baseGroup The base group name to be used to find the filters
- Returns:
- The list of filters.
Definition at line 170 of file filter.cpp.
| void Filter::restore | ( | KConfigGroup & | cfg | ) |
| void Filter::save | ( | KConfig * | config, | |
| const QString & | baseGroup, | |||
| Filter::List & | list | |||
| ) | [static] |
Saves a list of filters to the config file.
- Parameters:
-
config The config file to use baseGroup The base groupname to use. The number of filters will be written to this group, then a _1, _2, etc will be append for each filter saved. list The list of filters to be saved.
Definition at line 143 of file filter.cpp.
| void Filter::save | ( | KConfigGroup & | cfg | ) |
| void Filter::setCategories | ( | const QStringList & | list | ) |
Set the list of categories.
This list is used to filter addressees.
Definition at line 113 of file filter.cpp.
| void Filter::setEnabled | ( | bool | on | ) |
| void Filter::setMatchRule | ( | MatchRule | rule | ) |
Sets the filter rule.
If the rule is Filter::Matching (default), then the filter will return true on items that match the filter. If the rule is Filter::NotMatching, then the filter will return true on items that do not match the filter.
Definition at line 205 of file filter.cpp.
| void Filter::setName | ( | const QString & | name | ) |
The documentation for this class was generated from the following files:
