KCal::CalFilter Class Reference
Provides a filter for calendars. More...
#include <calfilter.h>
Public Types | |
| enum | Criteria { HideRecurring = 1, HideCompletedTodos = 2, ShowCategories = 4, HideInactiveTodos = 8, HideNoMatchingAttendeeTodos = 16 } |
Public Member Functions | |
| CalFilter (const QString &name) | |
| CalFilter () | |
| ~CalFilter () | |
| void | apply (Journal::List *journalList) const |
| void | apply (Todo::List *todoList) const |
| void | apply (Event::List *eventList) const |
| QStringList | categoryList () const |
| int | completedTimeSpan () const |
| int | criteria () const |
| QStringList | emailList () const |
| bool | filterIncidence (Incidence *incidence) const |
| bool | isEnabled () const |
| QString | name () const |
| bool | operator== (const CalFilter &filter) |
| void | setCategoryList (const QStringList &categoryList) |
| void | setCompletedTimeSpan (int timespan) |
| void | setCriteria (int criteria) |
| void | setEmailList (const QStringList &emailList) |
| void | setEnabled (bool enabled) |
| void | setName (const QString &name) |
Detailed Description
Provides a filter for calendars.
This class provides a means for filtering calendar incidences by a list of email addresses, a list of categories, or other Criteria.
The following Criteria are available:
- remove recurring Incidences
- keep Incidences with a matching category (see setCategoryList())
- remove completed To-dos (see setCompletedTimeSpan())
- remove inactive To-dos
- remove To-dos without a matching attendee (see setEmailList())
Definition at line 57 of file calfilter.h.
Member Enumeration Documentation
Filtering Criteria.
- Enumerator:
Definition at line 63 of file calfilter.h.
Constructor & Destructor Documentation
| CalFilter::CalFilter | ( | ) |
Constructs an empty filter -- a filter without a name or criteria.
Private class that helps to provide binary compatibility between releases.
For internal use only.
Definition at line 65 of file calfilter.cpp.
| CalFilter::CalFilter | ( | const QString & | name | ) | [explicit] |
Constructs a filter with name.
- Parameters:
-
name is the name of this filter.
Definition at line 69 of file calfilter.cpp.
| CalFilter::~CalFilter | ( | ) |
Destroys this filter.
Definition at line 75 of file calfilter.cpp.
Member Function Documentation
| void KCal::CalFilter::apply | ( | Journal::List * | journalList | ) | const |
Applies the filter to a list of Journals.
All journals not matching the filter criterias are removed from the list.
- Parameters:
-
journalList is a list of Journals to filter.
| void KCal::CalFilter::apply | ( | Todo::List * | todoList | ) | const |
Applies the filter to a list of To-dos.
All to-dos not matching the filter criterias are removed from the list.
- Parameters:
-
todoList is a list of To-dos to filter.
| void CalFilter::apply | ( | Event::List * | eventList | ) | const |
Applies the filter to a list of Events.
All events not matching the filter criteria are removed from the list.
- Parameters:
-
eventList is a list of Events to filter.
Definition at line 89 of file calfilter.cpp.
| QStringList CalFilter::categoryList | ( | ) | const |
Returns the category list for this filter.
- See also:
- setCategoryList().
Definition at line 252 of file calfilter.cpp.
| int CalFilter::completedTimeSpan | ( | ) | const |
Returns the completed time span for this filter.
- See also:
- setCompletedTimeSpan()
Definition at line 272 of file calfilter.cpp.
| int CalFilter::criteria | ( | ) | const |
Returns the inclusive filter criteria.
- See also:
- setCriteria().
Definition at line 242 of file calfilter.cpp.
| QStringList CalFilter::emailList | ( | ) | const |
Returns the email list for this filter.
- See also:
- setEmailList().
Definition at line 262 of file calfilter.cpp.
| bool CalFilter::filterIncidence | ( | Incidence * | incidence | ) | const |
Applies the filter criteria to the specified Incidence.
- Parameters:
-
incidence is the Incidence to filter.
- Returns:
- true if the Incidence passes the criteria; false otherwise.
Definition at line 138 of file calfilter.cpp.
| bool CalFilter::isEnabled | ( | ) | const |
Returns whether the filter is enabled or not.
- See also:
- setEnabled().
Definition at line 232 of file calfilter.cpp.
| QString CalFilter::name | ( | ) | const |
| bool KCal::CalFilter::operator== | ( | const CalFilter & | filter | ) |
Compares this with filter for equality.
- Parameters:
-
filter the CalFilter to compare.
Definition at line 80 of file calfilter.cpp.
| void CalFilter::setCategoryList | ( | const QStringList & | categoryList | ) |
Sets the list of categories to be considered when filtering incidences according to the ShowCategories criteria.
- Parameters:
-
categoryList is a QStringList of categories.
- See also:
- categoryList().
Definition at line 247 of file calfilter.cpp.
| void CalFilter::setCompletedTimeSpan | ( | int | timespan | ) |
Sets the number of days for the HideCompletedTodos criteria.
If a to-do has been completed within the recent timespan days, then that to-do will be removed during filtering. If a time span is not specified in the filter, then all completed to-dos will be removed if the HideCompletedTodos criteria is set.
- Parameters:
-
timespan is an integer representing a time span in days.
- See also:
- completedTimeSpan().
Definition at line 267 of file calfilter.cpp.
| void CalFilter::setCriteria | ( | int | criteria | ) |
Sets the criteria which must be fulfilled for an Incidence to pass the filter.
- Parameters:
-
criteria is a combination of Criteria.
- See also:
- criteria().
Definition at line 237 of file calfilter.cpp.
| void CalFilter::setEmailList | ( | const QStringList & | emailList | ) |
Sets the list of email addresses to be considered when filtering incidences according ot the HideNoMatchingAttendeeTodos criteria.
- Parameters:
-
emailList is a QStringList of email addresses.
- See also:
- emailList().
Definition at line 257 of file calfilter.cpp.
| void CalFilter::setEnabled | ( | bool | enabled | ) |
Enables or disables the filter.
- Parameters:
-
enabled is true if the filter is to be enabled; false otherwise.
- See also:
- isEnabled().
Definition at line 227 of file calfilter.cpp.
| void CalFilter::setName | ( | const QString & | name | ) |
Sets the filter name.
- Parameters:
-
name is the name of this filter.
- See also:
- name().
Definition at line 217 of file calfilter.cpp.
The documentation for this class was generated from the following files:
