libkcal Library API Documentation

KCal::CalFilter Class Reference

Filter for calendar objects. More...

#include <calfilter.h>

List of all members.

Public Types

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

Public Methods

 CalFilter ()
 CalFilter (const QString &name)
 ~CalFilter ()
void setName (const QString &name)
QString name () const
void apply (Event::List *eventlist)
void apply (Todo::List *todolist)
bool filterEvent (Event *)
bool filterTodo (Todo *)
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 35 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 48 of file calfilter.h.

References name().

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

Return name of filter.

Definition at line 52 of file calfilter.h.

Referenced by setName().

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 filterEvent().

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 filterTodo().

bool CalFilter::filterEvent Event  
 

Apply filter criteria on the specified event.

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

Definition at line 79 of file calfilter.cpp.

References KCal::Incidence::doesRecur(), and filterIncidence().

Referenced by apply().

bool CalFilter::filterTodo Todo  
 

Apply filter criteria on the specified todo.

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

Definition at line 92 of file calfilter.cpp.

References filterIncidence(), and KCal::Todo::isCompleted().

Referenced by apply().

bool CalFilter::filterIncidence Incidence  
 

Apply filter criteria on the specified incidence.

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

Definition at line 105 of file calfilter.cpp.

References KCal::Incidence::categories().

Referenced by filterEvent(), and filterTodo().

void CalFilter::setEnabled bool   
 

Enable or disable filter.

Definition at line 142 of file calfilter.cpp.

bool CalFilter::isEnabled  
 

Return wheter the filter is enabled or not.

Definition at line 147 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 162 of file calfilter.cpp.

QStringList CalFilter::categoryList  
 

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

See related functions.

Definition at line 167 of file calfilter.cpp.

void CalFilter::setCriteria int   
 

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

Definition at line 152 of file calfilter.cpp.

References criteria().

int CalFilter::criteria  
 

Get inclusive filter criteria.

Definition at line 157 of file calfilter.cpp.

Referenced by setCriteria().


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.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat May 1 11:36:24 2004 by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2003