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

Detailed Description
Abstract base class for KMail's filter actions that need a parameter which can be chosen from a fixed set, e.g.Abstract base class for filter actions with a fixed set of string parameters.'set identity'. Can create a QComboBox 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.
- Author:
- Marc Mutz <Marc@Mutz.com>, based upon work by Stefan Taferner <taferner@kde.org>
Definition at line 339 of file kmfilteraction.h.
Public Member Functions | |
KMFilterActionWithStringList (const char *aName, const QString aLabel) | |
virtual QWidget * | createParamWidget (QWidget *parent) const |
virtual void | applyParamWidgetValue (QWidget *paramWidget) |
virtual void | setParamWidgetValue (QWidget *paramWidget) const |
virtual void | clearParamWidget (QWidget *paramWidget) const |
virtual void | argsFromString (const QString argsStr) |
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 226 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 239 of file kmfilteraction.cpp.
void KMFilterActionWithStringList::argsFromString | ( | const QString | argsStr | ) | [virtual] |
Read extra arguments from given string.
Reimplemented from KMFilterActionWithString.
Definition at line 255 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 250 of file kmfilteraction.cpp.
QWidget * KMFilterActionWithStringList::createParamWidget | ( | QWidget * | parent | ) | const [virtual] |
Creates a widget for setting the filter action parameter.
Also sets the value of the widget.
Reimplemented from KMFilterActionWithString.
Definition at line 231 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 244 of file kmfilteraction.cpp.
The documentation for this class was generated from the following files: