Filter Class Reference
Filter for AddressBook related objects (Addressees). More...
#include <filter.h>
Public Types | |
typedef QValueList< Filter > | List |
enum | MatchRule { Matching = 0, NotMatching = 1 } |
Public Member Functions | |
Filter (const Filter &) | |
Filter (const QString &name) | |
Filter & | operator= (const Filter &) |
void | setName (const QString &name) |
Set the name of the filter. | |
const QString & | name () const |
void | apply (KABC::Addressee::List &addresseeList) |
Apply the filter to the addressee list. | |
bool | filterAddressee (const KABC::Addressee &a) |
Apply the filter to the addressee. | |
void | setEnabled (bool on) |
Enable or disable the filter. | |
bool | isEnabled () const |
void | setCategories (const QStringList &list) |
Set the list of categories. | |
const QStringList & | categories () const |
void | save (KConfig *config) |
Saves the filter to the config file. | |
void | restore (KConfig *config) |
Loads the filter from the config file. | |
void | setMatchRule (MatchRule rule) |
Sets the filter rule. | |
MatchRule | matchRule () const |
Static Public Member Functions | |
void | save (KConfig *config, QString baseGroup, Filter::List &list) |
Saves a list of filters to the config file. | |
Filter::List | restore (KConfig *config, QString baseGroup) |
Restores a list of filters from a config file. |
Detailed Description
Filter for AddressBook related objects (Addressees).
Definition at line 39 of file filter.h.
Member Function Documentation
|
Set the name of the filter.
|
|
Definition at line 59 of file filter.h. Referenced by ViewManager::modifyView(), ViewManager::setActiveView(), and ViewManager::writeConfig(). |
|
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. References filterAddressee(). |
|
Apply the filter to the addressee.
Definition at line 77 of file filter.cpp. Referenced by KAddressBookView::addressees(), and apply(). |
|
Enable or disable the filter.
|
|
|
|
Set the list of categories. This list is used to filter addressees. |
|
|
|
Saves the filter to the config file. The group should already be set. Definition at line 94 of file filter.cpp. Referenced by ViewManager::modifyView(), and ViewManager::writeConfig(). |
|
Loads the filter from the config file. The group should already be set Definition at line 102 of file filter.cpp. Referenced by ViewManager::readConfig(), and restore(). |
|
Saves a list of filters to the config file.
Definition at line 110 of file filter.cpp. References QValueList::begin(), QValueList::count(), and QValueList::end(). |
|
Restores a list of filters from a config file.
Definition at line 136 of file filter.cpp. References QValueList::append(), and restore(). |
|
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. |
|
|
The documentation for this class was generated from the following files: