mailcommon
#include <filteractionwithstringlist.h>
Public Member Functions | |
FilterActionWithStringList (const QString &name, const QString &label, QObject *parent=0) | |
virtual void | applyParamWidgetValue (QWidget *paramWidget) |
virtual void | argsFromString (const QString &argsStr) |
virtual void | clearParamWidget (QWidget *paramWidget) const |
virtual QWidget * | createParamWidget (QWidget *parent) const |
virtual void | setParamWidgetValue (QWidget *paramWidget) const |
Public Member Functions inherited from MailCommon::FilterActionWithString | |
FilterActionWithString (const QString &name, const QString &label, QObject *parent=0) | |
virtual QString | argsAsString () const |
virtual QString | displayString () const |
virtual bool | isEmpty () const |
Public Member Functions inherited from MailCommon::FilterAction | |
FilterAction (const QString &name, const QString &label, QObject *parent=0) | |
virtual | ~FilterAction () |
virtual QString | argsAsStringReal () const |
virtual bool | argsFromStringInteractive (const QString &argsStr, const QString &filterName) |
virtual bool | folderRemoved (const Akonadi::Collection &aFolder, const Akonadi::Collection &aNewFolder) |
QString | label () const |
QString | name () const |
virtual ReturnCode | process (ItemContext &context, bool applyOnOutbound) const =0 |
virtual SearchRule::RequiredPart | requiredPart () const =0 |
virtual QString | sieveCode () const |
virtual QStringList | sieveRequires () const |
Protected Attributes | |
QStringList | mParameterList |
Protected Attributes inherited from MailCommon::FilterActionWithString | |
QString | mParameter |
Additional Inherited Members | |
Public Types inherited from MailCommon::FilterAction | |
enum | ReturnCode { ErrorNeedComplete = 0x1, GoOn = 0x2, ErrorButGoOn = 0x4, CriticalError = 0x8 } |
Signals inherited from MailCommon::FilterAction | |
void | filterActionModified () |
Static Public Member Functions inherited from MailCommon::FilterAction | |
static FilterAction * | newAction () |
static void | sendMDN (const Akonadi::Item &item, KMime::MDN::DispositionType d, const QList< KMime::MDN::DispositionModifier > &m=QList< KMime::MDN::DispositionModifier >()) |
Detailed Description
Abstract base class for filter actions with a fixed set of string parameters.
Abstract base class for mail filter actions that need a parameter which can be chosen from a fixed set, e.g. 'set identity'. Can create a KComboBox as parameter widget. A subclass of this must provide at least implementations for the following methods:
- virtual FilterAction::ReturnCodes FilterAction::process
- static FilterAction::newAction
Additionally, it's constructor should populate the QStringList mParameterList
with the valid parameter strings. The combobox will then contain be populated automatically with those strings. The default string will be the first one.
- See also
- FilterActionWithString FilterActionWithFolder FilterAction Filter
Definition at line 49 of file filteractionwithstringlist.h.
Constructor & Destructor Documentation
FilterActionWithStringList::FilterActionWithStringList | ( | const QString & | name, |
const QString & | label, | ||
QObject * | parent = 0 |
||
) |
Creates a new filter action.
The action is initialized with an identifier name
and an i18n'd label
.
Definition at line 26 of file filteractionwithstringlist.cpp.
Member Function Documentation
|
virtual |
The filter action shall set it's parameter from the widget's contents.
It is allowed that the value is read by the action before this function is called.
Reimplemented from MailCommon::FilterActionWithString.
Reimplemented in MailCommon::FilterActionAddToAddressBook, MailCommon::FilterActionRewriteHeader, and MailCommon::FilterActionAddHeader.
Definition at line 44 of file filteractionwithstringlist.cpp.
|
virtual |
Read extra arguments from given string.
Reimplemented from MailCommon::FilterActionWithString.
Reimplemented in MailCommon::FilterActionAddToAddressBook, MailCommon::FilterActionRewriteHeader, MailCommon::FilterActionAddHeader, MailCommon::FilterActionSendFakeDisposition, and MailCommon::FilterActionStatus.
Definition at line 60 of file filteractionwithstringlist.cpp.
|
virtual |
The filter action shall clear it's parameter widget's contents.
Reimplemented from MailCommon::FilterActionWithString.
Reimplemented in MailCommon::FilterActionAddToAddressBook, MailCommon::FilterActionRewriteHeader, and MailCommon::FilterActionAddHeader.
Definition at line 55 of file filteractionwithstringlist.cpp.
Creates a widget for setting the filter action parameter.
Also sets the value of the widget.
Reimplemented from MailCommon::FilterActionWithString.
Reimplemented in MailCommon::FilterActionAddToAddressBook, MailCommon::FilterActionRewriteHeader, MailCommon::FilterActionRemoveHeader, and MailCommon::FilterActionAddHeader.
Definition at line 31 of file filteractionwithstringlist.cpp.
|
virtual |
The filter action shall set it's widget's contents from it's parameter.
Reimplemented from MailCommon::FilterActionWithString.
Reimplemented in MailCommon::FilterActionAddToAddressBook, MailCommon::FilterActionRewriteHeader, MailCommon::FilterActionRemoveHeader, and MailCommon::FilterActionAddHeader.
Definition at line 49 of file filteractionwithstringlist.cpp.
Member Data Documentation
|
protected |
Definition at line 85 of file filteractionwithstringlist.h.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:55:15 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.