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
159
160
|
/*
This file is part of KAddressBook.
Copyright (c) 2002 Mike Pilone <mpilone@slac.com>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
As a special exception, permission is given to link this program
with any edition of TQt, and distribute the resulting executable,
without including the source code for TQt in the source distribution.
*/
#ifndef FILTER_H
#define FILTER_H
#include <tqstring.h>
#include <tqstringlist.h>
#include <tqvaluelist.h>
#include <tdeabc/addressee.h>
#include <tdeconfig.h>
/**
Filter for AddressBook related objects (Addressees)
@todo This class should be switched to use shared data.
*/
class Filter
{
public:
typedef TQValueList<Filter> List;
enum MatchRule { Matching = 0, NotMatching = 1 };
Filter();
Filter( const TQString& name );
~Filter();
/**
Set the name of the filter.
*/
void setName( const TQString &name );
/**
@return The name of the filter.
*/
const TQString &name() const;
/**
@return Whether the filter is an internal one.
*/
bool isInternal() const;
/**
Apply the filter to the addressee list. All addressees not passing
the filter criterias will be removed from the list.
If the MatchRule is NotMatch, then all the addressees matching the
filter will be removed from the list.
*/
void apply( TDEABC::Addressee::List &addresseeList );
/**
Apply the filter to the addressee.
@return True if the addressee passes the criteria, false otherwise.
The return values are opposite if the MatchRule is NotMatch.
*/
bool filterAddressee( const TDEABC::Addressee &a ) const;
/**
Enable or disable the filter
*/
void setEnabled( bool on );
/**
@return True if this filter is enabled, false otherwise.
*/
bool isEnabled() const;
/**
Set the list of categories. This list is used to filter addressees.
*/
void setCategories( const TQStringList &list );
/**
@return The list of categories.
*/
const TQStringList &categories() const;
/**
Saves the filter to the config file. The group should already be set.
*/
void save( TDEConfig *config );
/**
Loads the filter from the config file. The group should already be set.
*/
void restore( TDEConfig *config );
/**
Saves a list of filters to the config file.
@param config The config file to use
@param baseGroup The base groupname to use. The number of filters
will be written to this group, then a _1, _2, etc
will be append for each filter saved.
@param list The list of filters to be saved.
*/
static void save( TDEConfig *config, const TQString &baseGroup, Filter::List &list );
/**
Restores a list of filters from a config file.
@param config The config file to read from.
@param baseGroup The base group name to be used to find the filters
@return The list of filters.
*/
static Filter::List restore( TDEConfig *config, const TQString &baseGroup );
/**
Sets the filter rule. If the rule is Filter::Matching (default),
then the filter will return true on items that match the filter.
If the rule is Filter::NotMatching, then the filter will return
true on items that do not match the filter.
*/
void setMatchRule( MatchRule rule );
/**
@return The current match rule.
*/
MatchRule matchRule() const;
/**
@return true if the category list is empty.
*/
bool isEmpty() const;
private:
TQString mName;
TQStringList mCategoryList;
MatchRule mMatchRule;
bool mEnabled;
bool mInternal;
bool mIsEmpty;
};
#endif
|
