KDE 4.2 API Reference kmail
KMFilterActionWithFolder Class Reference
#include <kmfilteraction.h>
Detailed Description
Abstract base class for KMail's filter actions that need a mail folder as parameter, e.g.'move 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
Definition at line 390 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 | folderRemoved (KMFolder *aFolder, KMFolder *aNewFolder) |
| virtual bool | isEmpty () const |
| KMFilterActionWithFolder (const char *aName, const QString &aLabel) | |
| virtual void | setParamWidgetValue (QWidget *paramWidget) const |
Protected Attributes | |
| QPointer< KMFolder > | mFolder |
| QString | mFolderName |
Constructor & Destructor Documentation
| KMFilterActionWithFolder::KMFilterActionWithFolder | ( | 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 286 of file kmfilteraction.cpp.
Member Function Documentation
| void KMFilterActionWithFolder::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.
Definition at line 300 of file kmfilteraction.cpp.
| const QString KMFilterActionWithFolder::argsAsString | ( | ) | const [virtual] |
Return extra arguments as string.
Must not contain newlines.
Implements KMFilterAction.
Definition at line 332 of file kmfilteraction.cpp.
| void KMFilterActionWithFolder::argsFromString | ( | const QString & | argsStr | ) | [virtual] |
Read extra arguments from given string.
Implements KMFilterAction.
Definition at line 319 of file kmfilteraction.cpp.
| void KMFilterActionWithFolder::clearParamWidget | ( | QWidget * | paramWidget | ) | const [virtual] |
The filter action shall clear it's parameter widget's contents.
Reimplemented from KMFilterAction.
Definition at line 314 of file kmfilteraction.cpp.
Creates a widget for setting the filter action parameter.
Also sets the value of the widget.
Reimplemented from KMFilterAction.
Definition at line 292 of file kmfilteraction.cpp.
| const QString KMFilterActionWithFolder::displayString | ( | ) | const [virtual] |
Returns a translated string describing this filter for visualization purposes, e.g.
in the filter log.
Implements KMFilterAction.
Definition at line 342 of file kmfilteraction.cpp.
| bool KMFilterActionWithFolder::folderRemoved | ( | KMFolder * | aFolder, | |
| KMFolder * | aNewFolder | |||
| ) | [virtual] |
Called from the filter when a folder is removed.
Tests if the folder aFolder is used and changes to aNewFolder in this case. Returns true if a change was made.
Reimplemented from KMFilterAction.
Definition at line 352 of file kmfilteraction.cpp.
| virtual bool KMFilterActionWithFolder::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 401 of file kmfilteraction.h.
| void KMFilterActionWithFolder::setParamWidgetValue | ( | QWidget * | paramWidget | ) | const [virtual] |
The filter action shall set it's widget's contents from it's parameter.
Reimplemented from KMFilterAction.
Definition at line 306 of file kmfilteraction.cpp.
Member Data Documentation
QPointer<KMFolder> KMFilterActionWithFolder::mFolder [protected] |
Definition at line 436 of file kmfilteraction.h.
QString KMFilterActionWithFolder::mFolderName [protected] |
Definition at line 437 of file kmfilteraction.h.
The documentation for this class was generated from the following files:
