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
|
/*
* Copyright (c) 1996-1998 Stefan Taferner <taferner@kde.org>
*
* 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.
*
*/
#ifndef MAILCOMMON_FILTERACTIONWITHFOLDER_H
#define MAILCOMMON_FILTERACTIONWITHFOLDER_H
#include "filteraction.h"
namespace MailCommon {
/**
* @short Abstract base class for filter actions with a mail folder as parameter.
*
* Abstract base class for mail filter actions that need a
* mail folder as parameter, e.g. 'move into folder'. Can
* create a KComboBox as parameter widget. A subclass of this
* must provide at least implementations for the following methods:
*
* @li virtual FilterAction::ReturnCodes FilterAction::process
* @li static FilterAction::newAction
*
* @author Marc Mutz <mutz@kde.org>, based upon work by Stefan Taferner <taferner@kde.org>
* @see FilterActionWithStringList FilterAction Filter
*/
class FilterActionWithFolder : public FilterAction
{
Q_OBJECT
public:
/**
* @copydoc FilterAction::FilterAction
*/
FilterActionWithFolder(const QString &name, const QString &label, QObject *parent = 0 );
/**
* @copydoc FilterAction::isEmpty
*/
virtual bool isEmpty() const;
/**
* @copydoc FilterAction::createParamWidget
*/
virtual QWidget *createParamWidget( QWidget *parent ) const;
/**
* @copydoc FilterAction::applyParamWidgetValue
*/
virtual void applyParamWidgetValue( QWidget *paramWidget );
/**
* @copydoc FilterAction::setParamWidgetValue
*/
virtual void setParamWidgetValue( QWidget *paramWidget ) const;
/**
* @copydoc FilterAction::clearParamWidget
*/
virtual void clearParamWidget( QWidget *paramWidget ) const;
/**
* @copydoc FilterAction::argsFromString
*/
virtual void argsFromString( const QString &argsStr );
/**
* @copydoc FilterAction::argsAsString
*/
virtual QString argsAsString() const;
virtual bool argsFromStringInteractive( const QString &argsStr, const QString &filterName );
virtual QString argsAsStringReal() const;
/**
* @copydoc FilterAction::displayString
*/
virtual QString displayString() const;
/**
* @copydoc FilterAction::folderRemoved
*/
virtual bool folderRemoved( const Akonadi::Collection &aFolder,
const Akonadi::Collection &aNewFolder );
protected:
Akonadi::Collection mFolder;
};
}
#endif
|
