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 QString &name) | |
void | setName (const QString &name) |
const QString & | name () const |
bool | isInternal () const |
void | apply (KABC::Addressee::List &addresseeList) |
bool | filterAddressee (const KABC::Addressee &a) |
void | setEnabled (bool on) |
bool | isEnabled () const |
void | setCategories (const QStringList &list) |
const QStringList & | categories () const |
void | save (KConfig *config) |
void | restore (KConfig *config) |
void | setMatchRule (MatchRule rule) |
MatchRule | matchRule () const |
Static Public Member Functions | |
void | save (KConfig *config, QString baseGroup, Filter::List &list) |
Filter::List | restore (KConfig *config, QString baseGroup) |
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 47 of file filter.cpp. References setName(). Referenced by setName(). |
|
Definition at line 52 of file filter.cpp. |
|
Definition at line 57 of file filter.cpp. |
|
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 62 of file filter.cpp. References apply(), and filterAddressee(). Referenced by apply(). |
|
Apply the filter to the addressee.
Definition at line 73 of file filter.cpp. References filterAddressee(). Referenced by KAddressBookView::addressees(), apply(), and filterAddressee(). |
|
Enable or disable the filter.
Definition at line 90 of file filter.cpp. References setEnabled(). Referenced by setEnabled(). |
|
Definition at line 95 of file filter.cpp. |
|
Set the list of categories. This list is used to filter addressees. Definition at line 100 of file filter.cpp. References setCategories(). Referenced by setCategories(). |
|
Definition at line 105 of file filter.cpp. |
|
Saves the filter to the config file. The group should already be set. Definition at line 110 of file filter.cpp. References save(). Referenced by save(). |
|
Loads the filter from the config file. The group should already be set. Definition at line 118 of file filter.cpp. References restore(). Referenced by restore(). |
|
Saves a list of filters to the config file.
Definition at line 126 of file filter.cpp. References save(). |
|
Restores a list of filters from a config file.
Definition at line 153 of file filter.cpp. References mCategoryList, mEnabled, mInternal, mMatchRule, mName, 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. Definition at line 187 of file filter.cpp. References setMatchRule(). Referenced by setMatchRule(). |
|
Definition at line 192 of file filter.cpp. |
The documentation for this class was generated from the following files: