KMFilterAction Class Reference
Abstract base class for KMail's filter actions.Abstract base class for KMail's filter actions. More...
#include <kmfilteraction.h>
Inherited by KMFilterActionWithFolder, KMFilterActionWithNone, KMFilterActionWithString, KMFilterActionWithTest, KMFilterActionWithUOID, and KMFilterActionWithUrl.
Public Types
- enum ReturnCode { ErrorNeedComplete = 0x1, GoOn = 0x2, ErrorButGoOn = 0x4, CriticalError = 0x8 }
Public Member Functions
- KMFilterAction (const char *aName, const QString aLabel)
- const QString label () const
- const QString name () const
- virtual ReturnCode process (KMMessage *msg) const =0
- virtual void processAsync (KMMessage *msg) const
- virtual bool requiresBody (KMMsgBase *msgBase) const
- virtual bool isEmpty () const
- virtual QWidget * createParamWidget (QWidget *parent) const
- virtual void applyParamWidgetValue (QWidget *paramWidget)
- virtual void setParamWidgetValue (QWidget *paramWidget) const
- virtual void clearParamWidget (QWidget *paramWidget) const
- virtual void argsFromString (const QString argsStr)=0
- virtual const QString argsAsString () const =0
- virtual const QString displayString () const =0
- virtual bool folderRemoved (KMFolder *aFolder, KMFolder *aNewFolder)
Static Public Member Functions
- static KMFilterAction * newAction ()
- static int tempOpenFolder (KMFolder *aFolder)
- static void sendMDN (KMMessage *msg, KMime::MDN::DispositionType d, const QValueList< KMime::MDN::DispositionModifier > &m=QValueList< KMime::MDN::DispositionModifier >())
Detailed Description
Abstract base class for KMail's filter actions.Abstract base class for KMail's filter actions.All it can do is hold a name (ie. type-string). There are several sub-classes that inherit form this and are capable of providing parameter handling (import/export as string, a widget to allow editing, etc.)
- Author:
- Marc Mutz <Marc@Mutz.com>, based on work by Stefan Taferner <taferner@kde.org>.
- See also:
- KMFilter KMFilterMgr
Member Enumeration Documentation
|
Possible return codes of.
|
Constructor & Destructor Documentation
|
Initialize filter action with (english) name
|
Member Function Documentation
|
Returns nationalized label, ie. the one which is presented in the filter dialog. |
|
Returns english name, ie. the one under which it is known in the config. |
|
Execute action on given message.
Returns |
|
Execute an action on given message asynchronously. Emits a result signal on completion. |
|
Determines if the action depends on the body of the message.
|
|
Determines whether this action is valid. But this is just a quick test. Eg., actions that have a mail address as parameter shouldn't try real address validation, but only check if the string representation is empty. Reimplemented in KMFilterActionWithString, KMFilterActionWithUOID, KMFilterActionWithFolder, and KMFilterActionWithUrl. |
|
Creates a widget for setting the filter action parameter. Also sets the value of the widget. Reimplemented in KMFilterActionWithString, KMFilterActionWithStringList, KMFilterActionWithFolder, KMFilterActionWithAddress, and KMFilterActionWithUrl. |
|
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 in KMFilterActionWithString, KMFilterActionWithStringList, KMFilterActionWithFolder, KMFilterActionWithAddress, and KMFilterActionWithUrl. |
|
The filter action shall set it's widget's contents from it's parameter.
Reimplemented in KMFilterActionWithString, KMFilterActionWithStringList, KMFilterActionWithFolder, KMFilterActionWithAddress, and KMFilterActionWithUrl. |
|
The filter action shall clear it's parameter widget's contents.
Reimplemented in KMFilterActionWithString, KMFilterActionWithStringList, KMFilterActionWithFolder, KMFilterActionWithAddress, and KMFilterActionWithUrl. |
|
Read extra arguments from given string.
Implemented in KMFilterActionWithNone, KMFilterActionWithString, KMFilterActionWithUOID, KMFilterActionWithStringList, KMFilterActionWithFolder, and KMFilterActionWithUrl. |
|
Return extra arguments as string. Must not contain newlines. Implemented in KMFilterActionWithNone, KMFilterActionWithString, KMFilterActionWithUOID, KMFilterActionWithFolder, and KMFilterActionWithUrl. |
|
Returns a translated string describing this filter for visualization purposes, e.g. in the filter log. Implemented in KMFilterActionWithNone, KMFilterActionWithString, KMFilterActionWithUOID, KMFilterActionWithFolder, and KMFilterActionWithUrl. |
|
Called from the filter when a folder is removed.
Tests if the folder Reimplemented in KMFilterActionWithFolder. |
|
Static function that creates a filter action of this type.
|
|
Temporarily open folder. Will be closed by the next
|
|
Automates the sending of MDNs from filter actions.
|
The documentation for this class was generated from the following files:
- kmfilteraction.h
- kmfilteraction.cpp