libkcal Library API Documentation

KCal::CalFilter Class Reference

Filter for calendar objects. More...

#include <calfilter.h>

Collaboration diagram for KCal::CalFilter:

Collaboration graph
[legend]
List of all members.

Public Types

enum  { HideRecurring = 1, HideCompleted = 2, ShowCategories = 4 }

Public Member Functions

 CalFilter ()
 CalFilter (const QString &name)
 ~CalFilter ()
void setName (const QString &name)
QString name () const
void apply (Event::List *eventlist)
void apply (Todo::List *todolist)
void apply (Journal::List *journallist)
bool filterIncidence (Incidence *)
void setEnabled (bool)
bool isEnabled ()
void setCategoryList (const QStringList &)
QStringList categoryList ()
void setCriteria (int)
int criteria ()

Detailed Description

Filter for calendar objects.

Definition at line 36 of file calfilter.h.


Constructor & Destructor Documentation

CalFilter::CalFilter  ) 
 

Construct filter.

Definition at line 27 of file calfilter.cpp.

CalFilter::CalFilter const QString name  ) 
 

Construct filter with name.

Definition at line 33 of file calfilter.cpp.

CalFilter::~CalFilter  ) 
 

Destruct filter.

Definition at line 38 of file calfilter.cpp.


Member Function Documentation

void KCal::CalFilter::setName const QString name  )  [inline]
 

Set name of filter.

Definition at line 49 of file calfilter.h.

QString KCal::CalFilter::name  )  const [inline]
 

Return name of filter.

Definition at line 53 of file calfilter.h.

void CalFilter::apply Event::List eventlist  ) 
 

Apply filter to eventlist, all events not matching filter criterias are removed from the list.

Definition at line 42 of file calfilter.cpp.

References filterIncidence().

Referenced by KCal::Calendar::events(), and KCal::Calendar::todos().

void CalFilter::apply Todo::List todolist  ) 
 

Apply filter to todolist, all todos not matching filter criterias are removed from the list.

Definition at line 61 of file calfilter.cpp.

References filterIncidence().

void CalFilter::apply Journal::List journallist  ) 
 

Apply filter to todolist, all todos not matching filter criterias are removed from the list.

Definition at line 79 of file calfilter.cpp.

References filterIncidence().

bool CalFilter::filterIncidence Incidence  ) 
 

Apply filter criteria on the specified incidence.

Return true, if event passes criteria, otherwise return false.

Definition at line 93 of file calfilter.cpp.

Referenced by apply().

void CalFilter::setEnabled bool   ) 
 

Enable or disable filter.

Definition at line 139 of file calfilter.cpp.

bool CalFilter::isEnabled  ) 
 

Return wheter the filter is enabled or not.

Definition at line 144 of file calfilter.cpp.

void CalFilter::setCategoryList const QStringList  ) 
 

Set list of categories, which is used for showing/hiding categories of events.

See related functions.

Definition at line 159 of file calfilter.cpp.

QStringList CalFilter::categoryList  ) 
 

Return category list, used for showing/hiding categories of events.

See related functions.

Definition at line 164 of file calfilter.cpp.

void CalFilter::setCriteria int   ) 
 

Set criteria, which have to be fulfilled by events passing the filter.

Definition at line 149 of file calfilter.cpp.

int CalFilter::criteria  ) 
 

Get inclusive filter criteria.

Definition at line 154 of file calfilter.cpp.


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