#include <kmfilteraction.h>
Public Member Functions | |
| KMFilterActionWithAddress (const char *aName, const TQString aLabel) | |
| virtual TQWidget * | createParamWidget (TQWidget *parent) const |
| virtual void | applyParamWidgetValue (TQWidget *paramWidget) |
| virtual void | setParamWidgetValue (TQWidget *paramWidget) const |
| virtual void | clearParamWidget (TQWidget *paramWidget) const |
 Public Member Functions inherited from KMFilterActionWithString | |
| KMFilterActionWithString (const char *aName, const TQString aLabel) | |
| virtual bool | isEmpty () const |
| virtual void | argsFromString (const TQString argsStr) |
| virtual const TQString | argsAsString () const |
| virtual const TQString | displayString () const |
| Public Member Functions inherited from KMFilterAction | |
| KMFilterAction (const char *aName, const TQString aLabel) | |
| const TQString | label () const |
| const TQString | name () const |
| virtual ReturnCode | process (KMMessage *msg) const =0 |
| virtual void | processAsync (KMMessage *msg) const |
| virtual bool | requiresBody (KMMsgBase *msgBase) const |
| virtual bool | folderRemoved (KMFolder *aFolder, KMFolder *aNewFolder) |
Additional Inherited Members | |
| Public Types inherited from KMFilterAction | |
| enum | ReturnCode { ErrorNeedComplete = 0x1 , GoOn = 0x2 , ErrorButGoOn = 0x4 , CriticalError = 0x8 } |
| Static Public Member Functions inherited from KMFilterAction | |
| static KMFilterAction * | newAction () |
| static int | tempOpenFolder (KMFolder *aFolder) |
| static void | sendMDN (KMMessage *msg, KMime::MDN::DispositionType d, const TQValueList< KMime::MDN::DispositionModifier > &m=TQValueList< KMime::MDN::DispositionModifier >()) |
| Protected Attributes inherited from KMFilterActionWithString | |
| TQString | mParameter |
Detailed Description
Abstract base class for KMail's filter actions that need a mail address as parameter, e.g.
'forward to'. Can create a TQComboBox (capable of completion from the address book) as parameter widget. A subclass of this must provide at least implementations for the following methods:
- virtual KMFilterAction::ReturnCodes KMFilterAction::process
- static KMFilterAction::newAction
Abstract base class for filter actions with a mail address as parameter.
- See also
- KMFilterActionWithString KMFilterAction KMFilter
Definition at line 463 of file kmfilteraction.h.
Constructor & Destructor Documentation
◆ KMFilterActionWithAddress()
| KMFilterActionWithAddress::KMFilterActionWithAddress | ( | const char * | aName, |
| const TQString | 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 378 of file kmfilteraction.cpp.
Member Function Documentation
◆ applyParamWidgetValue()
|
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 390 of file kmfilteraction.cpp.
◆ clearParamWidget()
|
virtual |
The filter action shall clear it's parameter widget's contents.
Reimplemented from KMFilterActionWithString.
Definition at line 400 of file kmfilteraction.cpp.
◆ createParamWidget()
|
virtual |
Creates a widget for setting the filter action parameter.
Also sets the value of the widget.
Reimplemented from KMFilterActionWithString.
Definition at line 383 of file kmfilteraction.cpp.
◆ setParamWidgetValue()
|
virtual |
The filter action shall set it's widget's contents from it's parameter.
Reimplemented from KMFilterActionWithString.
Definition at line 395 of file kmfilteraction.cpp.
The documentation for this class was generated from the following files: