KDE 4.2 API Reference kmail
KMFilterActionWithString Class Reference
#include <kmfilteraction.h>
Detailed Description
Abstract base class for KMail's filter actions that need a free-form parameter, e.g.'set transport' or 'set reply to'. Can create a QLineEdit as parameter widget. A subclass of this must provide at least implementations for the following methods:
- virtual KMFilterAction::ReturnCodes KMFilterAction::process
- static KMFilterAction::newAction
- See also:
- KMFilterAction KMFilter
Definition at line 220 of file kmfilteraction.h.
Public Member Functions | |
| virtual void | applyParamWidgetValue (QWidget *paramWidget) |
| virtual const QString | argsAsString () const |
| virtual void | argsFromString (const QString &argsStr) |
| virtual void | clearParamWidget (QWidget *paramWidget) const |
| virtual QWidget * | createParamWidget (QWidget *parent) const |
| virtual const QString | displayString () const |
| virtual bool | isEmpty () const |
| KMFilterActionWithString (const char *aName, const QString &aLabel) | |
| virtual void | setParamWidgetValue (QWidget *paramWidget) const |
Protected Attributes | |
| QString | mParameter |
Constructor & Destructor Documentation
| KMFilterActionWithString::KMFilterActionWithString | ( | 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 189 of file kmfilteraction.cpp.
Member Function Documentation
| void KMFilterActionWithString::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 from KMFilterAction.
Reimplemented in KMFilterActionWithStringList, and KMFilterActionWithAddress.
Definition at line 201 of file kmfilteraction.cpp.
| const QString KMFilterActionWithString::argsAsString | ( | ) | const [virtual] |
Return extra arguments as string.
Must not contain newlines.
Implements KMFilterAction.
Definition at line 221 of file kmfilteraction.cpp.
| void KMFilterActionWithString::argsFromString | ( | const QString & | argsStr | ) | [virtual] |
Read extra arguments from given string.
Implements KMFilterAction.
Reimplemented in KMFilterActionWithStringList.
Definition at line 216 of file kmfilteraction.cpp.
| void KMFilterActionWithString::clearParamWidget | ( | QWidget * | paramWidget | ) | const [virtual] |
The filter action shall clear it's parameter widget's contents.
Reimplemented from KMFilterAction.
Reimplemented in KMFilterActionWithStringList, and KMFilterActionWithAddress.
Definition at line 211 of file kmfilteraction.cpp.
Creates a widget for setting the filter action parameter.
Also sets the value of the widget.
Reimplemented from KMFilterAction.
Reimplemented in KMFilterActionWithStringList, and KMFilterActionWithAddress.
Definition at line 194 of file kmfilteraction.cpp.
| const QString KMFilterActionWithString::displayString | ( | ) | const [virtual] |
Returns a translated string describing this filter for visualization purposes, e.g.
in the filter log.
Implements KMFilterAction.
Definition at line 226 of file kmfilteraction.cpp.
| virtual bool KMFilterActionWithString::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 231 of file kmfilteraction.h.
| void KMFilterActionWithString::setParamWidgetValue | ( | QWidget * | paramWidget | ) | const [virtual] |
The filter action shall set it's widget's contents from it's parameter.
Reimplemented from KMFilterAction.
Reimplemented in KMFilterActionWithStringList, and KMFilterActionWithAddress.
Definition at line 206 of file kmfilteraction.cpp.
Member Data Documentation
QString KMFilterActionWithString::mParameter [protected] |
Definition at line 261 of file kmfilteraction.h.
The documentation for this class was generated from the following files:
