kmail
KMFilterActionWithUrl Class Reference
Abstract base class for KMail's filter actions that need a command line as parameter, e.g. More...
#include <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 |
| KMFilterActionWithUrl (const char *aName, const QString aLabel) | |
| virtual void | setParamWidgetValue (QWidget *paramWidget) const |
| ~KMFilterActionWithUrl () | |
Protected Attributes | |
| QString | mParameter |
Detailed Description
Abstract base class for KMail's filter actions that need a command line as parameter, e.g.'forward to'. Can create a QLineEdit (are there better widgets in the depths of the kdelibs?) as parameter widget. A subclass of this must provide at least implementations for the following methods:
- virtual KMFilterAction::ReturnCodes KMFilterAction::process
- static KMFilterAction::newAction
mProcess. Then you can start the command with mProcess.start().Abstract base class for filter actions with a command line as parameter.
- See also:
- KMFilterActionWithString KMFilterAction KMFilter KProcess
Definition at line 514 of file kmfilteraction.h.
Constructor & Destructor Documentation
| KMFilterActionWithUrl::KMFilterActionWithUrl | ( | 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 1835 of file kmfilteraction.cpp.
| KMFilterActionWithUrl::~KMFilterActionWithUrl | ( | ) |
Definition at line 1840 of file kmfilteraction.cpp.
Member Function Documentation
| void KMFilterActionWithUrl::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 KMFilterActionWithCommand.
Definition at line 1852 of file kmfilteraction.cpp.
| const QString KMFilterActionWithUrl::argsAsString | ( | ) | const [virtual] |
Return extra arguments as string.
Must not contain newlines.
Implements KMFilterAction.
Definition at line 1872 of file kmfilteraction.cpp.
| void KMFilterActionWithUrl::argsFromString | ( | const QString | argsStr | ) | [virtual] |
Read extra arguments from given string.
Implements KMFilterAction.
Definition at line 1867 of file kmfilteraction.cpp.
| void KMFilterActionWithUrl::clearParamWidget | ( | QWidget * | paramWidget | ) | const [virtual] |
The filter action shall clear it's parameter widget's contents.
Reimplemented from KMFilterAction.
Reimplemented in KMFilterActionWithCommand.
Definition at line 1862 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 KMFilterActionWithCommand.
Definition at line 1844 of file kmfilteraction.cpp.
| const QString KMFilterActionWithUrl::displayString | ( | ) | const [virtual] |
Returns a translated string describing this filter for visualization purposes, e.g.
in the filter log.
Implements KMFilterAction.
Definition at line 1877 of file kmfilteraction.cpp.
| virtual bool KMFilterActionWithUrl::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 525 of file kmfilteraction.h.
| void KMFilterActionWithUrl::setParamWidgetValue | ( | QWidget * | paramWidget | ) | const [virtual] |
The filter action shall set it's widget's contents from it's parameter.
Reimplemented from KMFilterAction.
Reimplemented in KMFilterActionWithCommand.
Definition at line 1857 of file kmfilteraction.cpp.
Member Data Documentation
QString KMFilterActionWithUrl::mParameter [protected] |
Definition at line 555 of file kmfilteraction.h.
The documentation for this class was generated from the following files:
