kmail
KMFilterActionWithUOID Class Reference
#include <kmfilteraction.h>
Inheritance diagram for KMFilterActionWithUOID:

Detailed Description
Abstract base class for KMail's filter actions that need a parameter that has a UOID, e.g.Abstract base class for filter actions with a free-form string as parameter."set identity". A subclass of this must provide at least implementations for the following methods:
- virtual KMFilterAction::ReturnCodes KMFilterAction::process
- static KMFilterAction::newAction
- the *ParamWidget* methods.
- Author:
- Marc Mutz <Marc@Mutz.com>, based upon work by Stefan Taferner <taferner@kde.org>
- See also:
- KMFilterAction KMFilter
Definition at line 286 of file kmfilteraction.h.
Public Member Functions | |
KMFilterActionWithUOID (const char *aName, const QString aLabel) | |
virtual bool | isEmpty () const |
virtual void | argsFromString (const QString argsStr) |
virtual const QString | argsAsString () const |
virtual const QString | displayString () const |
Protected Attributes | |
uint | mParameter |
Constructor & Destructor Documentation
|
Initialize filter action with (english) name This is the name under which this action is known in the config file. Definition at line 147 of file kmfilteraction.cpp. |
Member Function Documentation
|
Return extra arguments as string. Must not contain newlines. Implements KMFilterAction. Definition at line 157 of file kmfilteraction.cpp. |
|
Read extra arguments from given string.
Implements KMFilterAction. Definition at line 152 of file kmfilteraction.cpp. |
|
Returns a translated string describing this filter for visualization purposes, e.g. in the filter log. Implements KMFilterAction. Definition at line 162 of file kmfilteraction.cpp. |
|
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 from KMFilterAction. Definition at line 297 of file kmfilteraction.h. |
The documentation for this class was generated from the following files: