KDE 4.2 API Reference kmail
KMFilterActionWithUOID Class Reference
#include <kmfilteraction.h>
Detailed Description
Abstract base class for KMail's filter actions that need a parameter that has a UOID, e.g."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.
- See also:
- KMFilterAction KMFilter
Definition at line 284 of file kmfilteraction.h.
Public Member Functions | |
| virtual const QString | argsAsString () const |
| virtual void | argsFromString (const QString &argsStr) |
| virtual const QString | displayString () const |
| virtual bool | isEmpty () const |
| KMFilterActionWithUOID (const char *aName, const QString &aLabel) | |
Protected Attributes | |
| uint | mParameter |
Constructor & Destructor Documentation
| KMFilterActionWithUOID::KMFilterActionWithUOID | ( | const char * | aName, | |
| const QString & | aLabel | |||
| ) |
Initialize filter action with (english) name aName.
This is the name under which this action is known in the config file.
Definition at line 160 of file kmfilteraction.cpp.
Member Function Documentation
| const QString KMFilterActionWithUOID::argsAsString | ( | ) | const [virtual] |
Return extra arguments as string.
Must not contain newlines.
Implements KMFilterAction.
Definition at line 170 of file kmfilteraction.cpp.
| void KMFilterActionWithUOID::argsFromString | ( | const QString & | argsStr | ) | [virtual] |
Read extra arguments from given string.
Implements KMFilterAction.
Definition at line 165 of file kmfilteraction.cpp.
| const QString KMFilterActionWithUOID::displayString | ( | ) | const [virtual] |
Returns a translated string describing this filter for visualization purposes, e.g.
in the filter log.
Implements KMFilterAction.
Definition at line 175 of file kmfilteraction.cpp.
| virtual bool KMFilterActionWithUOID::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 from KMFilterAction.
Definition at line 295 of file kmfilteraction.h.
Member Data Documentation
uint KMFilterActionWithUOID::mParameter [protected] |
Definition at line 308 of file kmfilteraction.h.
The documentation for this class was generated from the following files:
