KDE 4.2 API Reference kmail
KMFilterActionWithStringList Class Reference
#include <kmfilteraction.h>
Detailed Description
Abstract base class for KMail's filter actions that need a parameter which can be chosen from a fixed set, e.g.'set identity'. Can create a KComboBox as parameter widget. A subclass of this must provide at least implementations for the following methods:
- virtual KMFilterAction::ReturnCodes KMFilterAction::process
- static KMFilterAction::newAction
mParameterList with the valid parameter strings. The combobox will then contain be populated automatically with those strings. The default string will be the first one.Abstract base class for filter actions with a fixed set of string parameters.
Definition at line 337 of file kmfilteraction.h.
Public Member Functions | |
| virtual void | applyParamWidgetValue (QWidget *paramWidget) |
| virtual void | argsFromString (const QString &argsStr) |
| virtual void | clearParamWidget (QWidget *paramWidget) const |
| virtual QWidget * | createParamWidget (QWidget *parent) const |
| KMFilterActionWithStringList (const char *aName, const QString &aLabel) | |
| virtual void | setParamWidgetValue (QWidget *paramWidget) const |
Protected Attributes | |
| QStringList | mParameterList |
Constructor & Destructor Documentation
| KMFilterActionWithStringList::KMFilterActionWithStringList | ( | 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 241 of file kmfilteraction.cpp.
Member Function Documentation
| void KMFilterActionWithStringList::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 KMFilterActionWithString.
Definition at line 255 of file kmfilteraction.cpp.
| void KMFilterActionWithStringList::argsFromString | ( | const QString & | argsStr | ) | [virtual] |
Read extra arguments from given string.
Reimplemented from KMFilterActionWithString.
Definition at line 271 of file kmfilteraction.cpp.
| void KMFilterActionWithStringList::clearParamWidget | ( | QWidget * | paramWidget | ) | const [virtual] |
The filter action shall clear it's parameter widget's contents.
Reimplemented from KMFilterActionWithString.
Definition at line 266 of file kmfilteraction.cpp.
Creates a widget for setting the filter action parameter.
Also sets the value of the widget.
Reimplemented from KMFilterActionWithString.
Definition at line 246 of file kmfilteraction.cpp.
| void KMFilterActionWithStringList::setParamWidgetValue | ( | QWidget * | paramWidget | ) | const [virtual] |
The filter action shall set it's widget's contents from it's parameter.
Reimplemented from KMFilterActionWithString.
Definition at line 260 of file kmfilteraction.cpp.
Member Data Documentation
Definition at line 365 of file kmfilteraction.h.
The documentation for this class was generated from the following files:
