KDE PIM / Developers / API Docs / libkcal

KCal::CalFilter Class Reference

Filter for calendar objects. More...

#include <calfilter.h>

List of all members.

Public Types

Public Member Functions


Detailed Description

Filter for calendar objects.


Constructor & Destructor Documentation

CalFilter::CalFilter  ) 
 

Construct filter.

CalFilter::CalFilter const QString &  name  ) 
 

Construct filter with name.

CalFilter::~CalFilter  ) 
 

Destruct filter.


Member Function Documentation

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

Set name of filter.

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

Return name of filter.

void CalFilter::apply Event::List eventlist  )  const
 

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

void CalFilter::apply Todo::List todolist  )  const
 

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

void CalFilter::apply Journal::List journallist  )  const
 

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

bool CalFilter::filterIncidence Incidence  )  const
 

Apply filter criteria on the specified incidence.

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

void CalFilter::setEnabled bool   ) 
 

Enable or disable filter.

bool CalFilter::isEnabled  )  const
 

Return wheter the filter is enabled or not.

void CalFilter::setCategoryList const QStringList &   ) 
 

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

See related functions.

QStringList CalFilter::categoryList  )  const
 

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

See related functions.

void CalFilter::setCriteria int   ) 
 

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

int CalFilter::criteria  )  const
 

Get inclusive filter criteria.

void CalFilter::setCompletedTimeSpan int  timespan  ) 
 

Set the number of days for "Hide completed todos", after which todos are not shown any more.

If nothing is set explicitly, all finished todos will be hidden if the "hide completed todos" option is selected.

int CalFilter::completedTimeSpan  )  const
 

Return the number of days for "Hide completed todos", after which todos are not shown any more.


The documentation for this class was generated from the following files: