KMFilterActionWithString Class Reference
Abstract base class for KMail's filter actions that need a free-form parameter, e.g.Abstract base class for filter actions with a free-form string as parameter. More...
#include <kmfilteraction.h>
Inherits KMFilterAction.
Inherited by KMFilterActionReplyTo, KMFilterActionTransport, KMFilterActionWithAddress, and KMFilterActionWithStringList.
Public Member Functions
- KMFilterActionWithString (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
Protected Attributes
Detailed Description
Abstract base class for KMail's filter actions that need a free-form parameter, e.g.Abstract base class for filter actions with a free-form string as parameter.'set transport' or 'set reply to'. Can create a
- See also:
- QLineEdit as parameter widget. A subclass of this must provide at least implementations for the following methods:
- virtual
- See also:
- KMFilterAction::ReturnCodes
- static
- See also:
- KMFilterAction::newAction
- Author:
- Marc Mutz <Marc@Mutz.com>, based upon work by Stefan Taferner <taferner@kde.org>
- See also:
- KMFilterAction KMFilter
Constructor & Destructor Documentation
|
Initialize filter action with (english) name This is the name under which this action is known in the config file. |
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. |
|
Creates a widget for setting the filter action parameter. Also sets the value of the widget. Reimplemented from KMFilterAction. Reimplemented in KMFilterActionWithStringList, and KMFilterActionWithAddress. |
|
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 KMFilterActionWithStringList, and KMFilterActionWithAddress. |
|
The filter action shall set it's widget's contents from it's parameter.
Reimplemented from KMFilterAction. Reimplemented in KMFilterActionWithStringList, and KMFilterActionWithAddress. |
|
The filter action shall clear it's parameter widget's contents.
Reimplemented from KMFilterAction. Reimplemented in KMFilterActionWithStringList, and KMFilterActionWithAddress. |
|
Read extra arguments from given string.
Implements KMFilterAction. Reimplemented in KMFilterActionWithStringList. |
|
Return extra arguments as string. Must not contain newlines. Implements KMFilterAction. |
|
Returns a translated string describing this filter for visualization purposes, e.g. in the filter log. Implements KMFilterAction. |
The documentation for this class was generated from the following files:
- kmfilteraction.h
- kmfilteraction.cpp