KMFilterActionWithFolder Class Reference
Abstract base class for KMail's filter actions that need a mail folder as parameter, e.g.Abstract base class for filter actions with a mail folder as parameter. More...
#include <kmfilteraction.h>
Inheritance diagram for KMFilterActionWithFolder:


Public Member Functions | |
KMFilterActionWithFolder (const char *aName, const QString aLabel) | |
virtual bool | isEmpty () const |
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) |
virtual const QString | argsAsString () const |
virtual const QString | displayString () const |
virtual bool | folderRemoved (KMFolder *aFolder, KMFolder *aNewFolder) |
Protected Attributes | |
QGuardedPtr< KMFolder > | mFolder |
QString | mFolderName |
Detailed Description
Abstract base class for KMail's filter actions that need a mail folder as parameter, e.g.Abstract base class for filter actions with a mail folder as parameter.'file into folder'. 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
- Author:
- Marc Mutz <Marc@Mutz.com>, based upon work by Stefan Taferner <taferner@kde.org>
- See also:
- KMFilterActionWithStringList KMFilterAction KMFilter
Definition at line 362 of file kmfilteraction.h.
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 248 of file kmfilteraction.cpp. |
Member Function Documentation
|
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 373 of file kmfilteraction.h. |
|
Creates a widget for setting the filter action parameter. Also sets the value of the widget. Reimplemented from KMFilterAction. Definition at line 254 of file kmfilteraction.cpp. References setParamWidgetValue(). |
|
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. Definition at line 262 of file kmfilteraction.cpp. |
|
The filter action shall set it's widget's contents from it's parameter.
Reimplemented from KMFilterAction. Definition at line 275 of file kmfilteraction.cpp. Referenced by createParamWidget(). |
|
The filter action shall clear it's parameter widget's contents.
Reimplemented from KMFilterAction. Definition at line 283 of file kmfilteraction.cpp. |
|
Read extra arguments from given string.
Implements KMFilterAction. Definition at line 288 of file kmfilteraction.cpp. |
|
Return extra arguments as string. Must not contain newlines. Implements KMFilterAction. Definition at line 299 of file kmfilteraction.cpp. |
|
Returns a translated string describing this filter for visualization purposes, e.g. in the filter log. Definition at line 309 of file kmfilteraction.cpp. References KMFilterAction::label(). |
|
Called from the filter when a folder is removed.
Tests if the folder Reimplemented from KMFilterAction. Definition at line 319 of file kmfilteraction.cpp. |
The documentation for this class was generated from the following files: