1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
/*
This file is part of libkcal.
Copyright (c) 2001,2003,2004 Cornelius Schumacher <[email protected]>
Copyright (C) 2003-2004 Reinhold Kainhofer <[email protected]>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef KCAL_CALFILTER_H
#define KCAL_CALFILTER_H
#include <tqstring.h>
#include <tqptrlist.h>
#include "event.h"
#include "todo.h"
#include "journal.h"
#include "libkcal_export.h"
namespace KCal {
/**
Filter for calendar objects.
*/
class LIBKCAL_EXPORT CalFilter
{
public:
/** Construct filter. */
CalFilter();
/** Construct filter with name */
CalFilter( const TQString &name );
/** Destruct filter. */
~CalFilter();
/**
Set name of filter.
*/
void setName( const TQString &name ) { mName = name; }
/**
Return name of filter.
*/
TQString name() const { return mName; }
/**
Apply filter to eventlist, all events not matching filter criterias are
removed from the list.
*/
void apply( Event::List *eventlist ) const;
/**
Apply filter to todolist, all todos not matching filter criterias are
removed from the list.
*/
void apply( Todo::List *todolist ) const;
/**
Apply filter to todolist, all todos not matching filter criterias are
removed from the list.
*/
void apply( Journal::List *journallist) const;
/**
Apply filter criteria on the specified incidence. Return true, if event passes
criteria, otherwise return false.
*/
bool filterIncidence( Incidence * ) const;
/**
Enable or disable filter.
*/
void setEnabled( bool );
/**
Return wheter the filter is enabled or not.
*/
bool isEnabled() const;
/**
Set list of categories, which is used for showing/hiding categories of
events.
See related functions.
*/
void setCategoryList( const TQStringList & );
/**
Return category list, used for showing/hiding categories of events.
See related functions.
*/
TQStringList categoryList() const;
/**
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.
*/
void setEmailList( const TQStringList & );
/**
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.
*/
TQStringList emailList() const;
enum { HideRecurring = 1, HideCompleted = 2, ShowCategories = 4,
HideInactiveTodos = 8, HideTodosWithoutAttendeeInEmailList = 16 };
/**
Set criteria, which have to be fulfilled by events passing the filter.
*/
void setCriteria( int );
/**
Get inclusive filter criteria.
*/
int criteria() const;
/**
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.
*/
void setCompletedTimeSpan( int timespan );
/**
Return the number of days for "Hide completed todos", after which todos are
not shown any more.
*/
int completedTimeSpan() const;
private:
TQString mName;
int mCriteria;
bool mEnabled;
TQStringList mCategoryList;
TQStringList mEmailList;
int mCompletedTimeSpan;
class Private;
Private *d;
};
}
#endif
|
