#include <calfilter.h>
Public Types | |
| enum | { HideRecurring = 1 , HideCompleted = 2 , ShowCategories = 4 , HideInactiveTodos = 8 , HideTodosWithoutAttendeeInEmailList = 16 } |
Public Member Functions | |
| CalFilter () | |
| CalFilter (const TQString &name) | |
| ~CalFilter () | |
| void | setName (const TQString &name) |
| TQString | name () const |
| void | apply (Event::List *eventlist) const |
| void | apply (Todo::List *todolist) const |
| void | apply (Journal::List *journallist) const |
| bool | filterIncidence (Incidence *) const |
| void | setEnabled (bool) |
| bool | isEnabled () const |
| void | setCategoryList (const TQStringList &) |
| TQStringList | categoryList () const |
| void | setEmailList (const TQStringList &) |
| TQStringList | emailList () const |
| void | setCriteria (int) |
| int | criteria () const |
| void | setCompletedTimeSpan (int timespan) |
| int | completedTimeSpan () const |
Detailed Description
Filter for calendar objects.
Definition at line 38 of file calfilter.h.
Constructor & Destructor Documentation
◆ CalFilter() [1/2]
| CalFilter::CalFilter | ( | ) |
Construct filter.
Definition at line 30 of file calfilter.cpp.
◆ CalFilter() [2/2]
| CalFilter::CalFilter | ( | const TQString & | name | ) |
Construct filter with name.
Definition at line 37 of file calfilter.cpp.
◆ ~CalFilter()
| CalFilter::~CalFilter | ( | ) |
Destruct filter.
Definition at line 45 of file calfilter.cpp.
Member Function Documentation
◆ apply() [1/3]
| void CalFilter::apply | ( | Event::List * | eventlist | ) | const |
Apply filter to eventlist, all events not matching filter criterias are removed from the list.
Definition at line 49 of file calfilter.cpp.
◆ apply() [2/3]
| void CalFilter::apply | ( | Journal::List * | journallist | ) | const |
Apply filter to todolist, all todos not matching filter criterias are removed from the list.
Definition at line 86 of file calfilter.cpp.
◆ apply() [3/3]
| void CalFilter::apply | ( | Todo::List * | todolist | ) | const |
Apply filter to todolist, all todos not matching filter criterias are removed from the list.
Definition at line 68 of file calfilter.cpp.
◆ categoryList()
| TQStringList CalFilter::categoryList | ( | ) | const |
Return category list, used for showing/hiding categories of events.
See related functions.
Definition at line 203 of file calfilter.cpp.
◆ completedTimeSpan()
| int CalFilter::completedTimeSpan | ( | ) | const |
Return the number of days for "Hide completed todos", after which todos are not shown any more.
Definition at line 223 of file calfilter.cpp.
◆ criteria()
| int CalFilter::criteria | ( | ) | const |
Get inclusive filter criteria.
Definition at line 193 of file calfilter.cpp.
◆ emailList()
| TQStringList CalFilter::emailList | ( | ) | const |
Return list of email addresses which are to be considered when finding incidences which the current user is not a participant of.
This is normally the list used by KOPrefs::thatIsMe() as well. See related functions.
Definition at line 213 of file calfilter.cpp.
◆ filterIncidence()
| bool CalFilter::filterIncidence | ( | Incidence * | incidence | ) | const |
Apply filter criteria on the specified incidence.
Return true, if event passes criteria, otherwise return false.
Definition at line 100 of file calfilter.cpp.
◆ isEnabled()
| bool CalFilter::isEnabled | ( | ) | const |
Return wheter the filter is enabled or not.
Definition at line 183 of file calfilter.cpp.
◆ name()
|
inline |
Return name of filter.
Definition at line 55 of file calfilter.h.
◆ setCategoryList()
| void CalFilter::setCategoryList | ( | const TQStringList & | categoryList | ) |
Set list of categories, which is used for showing/hiding categories of events.
See related functions.
Definition at line 198 of file calfilter.cpp.
◆ setCompletedTimeSpan()
| 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.
Definition at line 218 of file calfilter.cpp.
◆ setCriteria()
| void CalFilter::setCriteria | ( | int | criteria | ) |
Set criteria, which have to be fulfilled by events passing the filter.
Definition at line 188 of file calfilter.cpp.
◆ setEmailList()
| void CalFilter::setEmailList | ( | const TQStringList & | emailList | ) |
Set list of email addresses which are to be considered when finding incidences which the current user is not a participant of.
This is normally the list used by KOPrefs::thatIsMe() as well.
Definition at line 208 of file calfilter.cpp.
◆ setEnabled()
| void CalFilter::setEnabled | ( | bool | enabled | ) |
Enable or disable filter.
Definition at line 178 of file calfilter.cpp.
◆ setName()
|
inline |
Set name of filter.
Definition at line 51 of file calfilter.h.
The documentation for this class was generated from the following files: