kaddressbook Library API Documentation

Filter Class Reference

Filter for AddressBook related objects (Addressees). More...

#include <filter.h>

Collaboration diagram for Filter:

Collaboration graph
[legend]
List of all members.

Public Types

typedef QValueList< FilterList
enum  MatchRule { Matching = 0, NotMatching = 1 }

Public Member Functions

 Filter (const QString &name)
void setName (const QString &name)
const QStringname () 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 QStringListcategories () const
void save (KConfig *config)
void restore (KConfig *config)
void setMatchRule (MatchRule rule)
MatchRule matchRule () const

Static Public Member Functions

static void save (KConfig *config, QString baseGroup, Filter::List &list)
static 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

void Filter::setName const QString name  ) 
 

Set the name of the filter.

Definition at line 47 of file filter.cpp.

const QString & Filter::name  )  const
 

Returns:
The name of the filter.

Definition at line 52 of file filter.cpp.

bool Filter::isInternal  )  const
 

Returns:
Whether the filter is an internal one.

Definition at line 57 of file filter.cpp.

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 62 of file filter.cpp.

References filterAddressee().

bool Filter::filterAddressee const KABC::Addressee &  a  ) 
 

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 73 of file filter.cpp.

Referenced by KAddressBookView::addressees(), and apply().

void Filter::setEnabled bool  on  ) 
 

Enable or disable the filter.

Definition at line 90 of file filter.cpp.

bool Filter::isEnabled  )  const
 

Returns:
True if this filter is enabled, false otherwise.

Definition at line 95 of file filter.cpp.

void Filter::setCategories const QStringList list  ) 
 

Set the list of categories.

This list is used to filter addressees.

Definition at line 100 of file filter.cpp.

const QStringList & Filter::categories  )  const
 

Returns:
The list of categories.

Definition at line 105 of file filter.cpp.

void Filter::save KConfig *  config  ) 
 

Saves the filter to the config file.

The group should already be set.

Definition at line 110 of file filter.cpp.

void Filter::restore KConfig *  config  ) 
 

Loads the filter from the config file.

The group should already be set.

Definition at line 118 of file filter.cpp.

Referenced by KABPrinting::PrintingWizard::PrintingWizard(), and restore().

void Filter::save KConfig *  config,
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 126 of file filter.cpp.

Filter::List Filter::restore KConfig *  config,
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 153 of file filter.cpp.

References mCategoryList, mEnabled, mInternal, mMatchRule, mName, and restore().

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 187 of file filter.cpp.

Filter::MatchRule Filter::matchRule  )  const
 

Returns:
The current match rule.

Definition at line 192 of file filter.cpp.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kaddressbook Library Version 3.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Oct 4 14:41:48 2007 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003