KDE 4.2 API Reference kmail
KMFilterAction Class Reference
#include <kmfilteraction.h>
Detailed Description
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.)
Abstract base class for KMail's filter actions.
- See also:
- KMFilter KMFilterMgr
Definition at line 53 of file kmfilteraction.h.
Public Types | |
| enum | ReturnCode { ErrorNeedComplete = 0x1, GoOn = 0x2, ErrorButGoOn = 0x4, CriticalError = 0x8 } |
Public Member Functions | |
| virtual void | applyParamWidgetValue (QWidget *paramWidget) |
| virtual const QString | argsAsString () const =0 |
| virtual void | argsFromString (const QString &argsStr)=0 |
| virtual void | clearParamWidget (QWidget *paramWidget) const |
| virtual QWidget * | createParamWidget (QWidget *parent) const |
| virtual const QString | displayString () const =0 |
| virtual bool | folderRemoved (KMFolder *aFolder, KMFolder *aNewFolder) |
| virtual bool | isEmpty () const |
| 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 void | setParamWidgetValue (QWidget *paramWidget) const |
| virtual | ~KMFilterAction () |
Static Public Member Functions | |
| static KMFilterAction * | newAction () |
| static void | sendMDN (KMMessage *msg, KMime::MDN::DispositionType d, const QList< KMime::MDN::DispositionModifier > &m=QList< KMime::MDN::DispositionModifier >()) |
| static int | tempOpenFolder (KMFolder *aFolder) |
Member Enumeration Documentation
Possible return codes of process:.
ErrorNeedComplete:Could not process because a complete message is needed.
GoOn:Go on with applying filter actions.
ErrorButGoOn:There was a non-critical error (e.g. an invalid address in the 'forward' action), but the processing should continue.
CriticalError:A critical error has occurred during processing (e.g. "disk full").
Definition at line 71 of file kmfilteraction.h.
Constructor & Destructor Documentation
| KMFilterAction::KMFilterAction | ( | const char * | aName, | |
| const QString & | aLabel | |||
| ) |
Initialize filter action with (english) name aName and (internationalized) label aLabel.
Definition at line 53 of file kmfilteraction.cpp.
| KMFilterAction::~KMFilterAction | ( | ) | [virtual] |
Definition at line 59 of file kmfilteraction.cpp.
Member Function Documentation
| void KMFilterAction::applyParamWidgetValue | ( | QWidget * | paramWidget | ) | [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 in KMFilterActionWithString, KMFilterActionWithStringList, KMFilterActionWithFolder, KMFilterActionWithAddress, KMFilterActionWithUrl, KMFilterActionWithCommand, and KMFilterActionWithTest.
Definition at line 86 of file kmfilteraction.cpp.
| virtual const QString KMFilterAction::argsAsString | ( | ) | const [pure virtual] |
Return extra arguments as string.
Must not contain newlines.
Implemented in KMFilterActionWithNone, KMFilterActionWithString, KMFilterActionWithUOID, KMFilterActionWithFolder, KMFilterActionWithUrl, and KMFilterActionWithTest.
| virtual void KMFilterAction::argsFromString | ( | const QString & | argsStr | ) | [pure virtual] |
Read extra arguments from given string.
Implemented in KMFilterActionWithNone, KMFilterActionWithString, KMFilterActionWithUOID, KMFilterActionWithStringList, KMFilterActionWithFolder, KMFilterActionWithUrl, and KMFilterActionWithTest.
| void KMFilterAction::clearParamWidget | ( | QWidget * | paramWidget | ) | const [virtual] |
The filter action shall clear it's parameter widget's contents.
Reimplemented in KMFilterActionWithString, KMFilterActionWithStringList, KMFilterActionWithFolder, KMFilterActionWithAddress, KMFilterActionWithUrl, KMFilterActionWithCommand, and KMFilterActionWithTest.
Definition at line 94 of file kmfilteraction.cpp.
Creates a widget for setting the filter action parameter.
Also sets the value of the widget.
Reimplemented in KMFilterActionWithString, KMFilterActionWithStringList, KMFilterActionWithFolder, KMFilterActionWithAddress, KMFilterActionWithUrl, KMFilterActionWithCommand, and KMFilterActionWithTest.
Definition at line 81 of file kmfilteraction.cpp.
| virtual const QString KMFilterAction::displayString | ( | ) | const [pure virtual] |
Returns a translated string describing this filter for visualization purposes, e.g.
in the filter log.
Implemented in KMFilterActionWithNone, KMFilterActionWithString, KMFilterActionWithUOID, KMFilterActionWithFolder, KMFilterActionWithUrl, and KMFilterActionWithTest.
Called from the filter when a folder is removed.
Tests if the folder aFolder is used and changes to aNewFolder in this case. Returns true if a change was made.
Reimplemented in KMFilterActionWithFolder.
Definition at line 98 of file kmfilteraction.cpp.
| virtual bool KMFilterAction::isEmpty | ( | ) | const [inline, virtual] |
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, KMFilterActionWithUrl, and KMFilterActionWithTest.
Definition at line 108 of file kmfilteraction.h.
| const QString KMFilterAction::label | ( | ) | const [inline] |
Returns nationalized label, ie.
the one which is presented in the filter dialog.
Definition at line 80 of file kmfilteraction.h.
| const QString KMFilterAction::name | ( | ) | const [inline] |
Returns english name, ie.
the one under which it is known in the config.
Definition at line 84 of file kmfilteraction.h.
| KMFilterAction * KMFilterAction::newAction | ( | void | ) | [static] |
Static function that creates a filter action of this type.
Definition at line 76 of file kmfilteraction.cpp.
| virtual ReturnCode KMFilterAction::process | ( | KMMessage * | msg | ) | const [pure virtual] |
Execute action on given message.
Returns CriticalError if a critical error has occurred (eg. disk full), ErrorButGoOn if there was a non-critical error (e.g. invalid address in 'forward' action), ErrorNeedComplete if a complete message is required, GoOn if the message shall be processed by further filters and Ok otherwise.
| void KMFilterAction::processAsync | ( | KMMessage * | msg | ) | const [virtual] |
Execute an action on given message asynchronously.
Emits a result signal on completion.
Definition at line 63 of file kmfilteraction.cpp.
| bool KMFilterAction::requiresBody | ( | KMMsgBase * | msgBase | ) | const [virtual] |
Determines if the action depends on the body of the message.
Definition at line 71 of file kmfilteraction.cpp.
| void KMFilterAction::sendMDN | ( | KMMessage * | msg, | |
| KMime::MDN::DispositionType | d, | |||
| const QList< KMime::MDN::DispositionModifier > & | m = QList<KMime::MDN::DispositionModifier>() | |||
| ) | [static] |
Automates the sending of MDNs from filter actions.
Definition at line 108 of file kmfilteraction.cpp.
| void KMFilterAction::setParamWidgetValue | ( | QWidget * | paramWidget | ) | const [virtual] |
The filter action shall set it's widget's contents from it's parameter.
Reimplemented in KMFilterActionWithString, KMFilterActionWithStringList, KMFilterActionWithFolder, KMFilterActionWithAddress, KMFilterActionWithUrl, KMFilterActionWithCommand, and KMFilterActionWithTest.
Definition at line 90 of file kmfilteraction.cpp.
| int KMFilterAction::tempOpenFolder | ( | KMFolder * | aFolder | ) | [static] |
Temporarily open folder.
Will be closed by the next KMFilterMgr::cleanup() call.
Definition at line 103 of file kmfilteraction.cpp.
The documentation for this class was generated from the following files:
