kmail

KMFilterActionWithStringList Class Reference

#include <kmfilteraction.h>

Inheritance diagram for KMFilterActionWithStringList:
KMFilterActionWithString KMFilterAction

Public Member Functions

 KMFilterActionWithStringList (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
 
virtual void argsFromString (const TQString argsStr)
 
- Public Member Functions inherited from KMFilterActionWithString
 KMFilterActionWithString (const char *aName, const TQString aLabel)
 
virtual bool isEmpty () const
 
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)
 

Protected Attributes

TQStringList mParameterList
 
- Protected Attributes inherited from KMFilterActionWithString
TQString mParameter
 

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 KMFilterActionnewAction ()
 
static int tempOpenFolder (KMFolder *aFolder)
 
static void sendMDN (KMMessage *msg, KMime::MDN::DispositionType d, const TQValueList< KMime::MDN::DispositionModifier > &m=TQValueList< KMime::MDN::DispositionModifier >())
 

Detailed Description

Abstract base class for KMail's filter actions that need a parameter which can be chosen from a fixed set, e.g.

'set identity'. Can create a TQComboBox as parameter widget. A subclass of this must provide at least implementations for the following methods:

Additionally, it's constructor should populate the TQStringList mParameterList with the valid parameter strings. The combobox will then contain be populated automatically with those strings. The default string will be the first one.

Abstract base class for filter actions with a fixed set of string parameters.

Author
Marc Mutz Marc@.nosp@m.Mutz.nosp@m..com, based upon work by Stefan Taferner tafer.nosp@m.ner@.nosp@m.kde.o.nosp@m.rg
See also
KMFilterActionWithString KMFilterActionWithFolder KMFilterAction KMFilter

Definition at line 339 of file kmfilteraction.h.

Constructor & Destructor Documentation

◆ KMFilterActionWithStringList()

KMFilterActionWithStringList::KMFilterActionWithStringList ( 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 249 of file kmfilteraction.cpp.

Member Function Documentation

◆ applyParamWidgetValue()

void KMFilterActionWithStringList::applyParamWidgetValue ( TQWidget *  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 KMFilterActionWithString.

Definition at line 262 of file kmfilteraction.cpp.

◆ argsFromString()

void KMFilterActionWithStringList::argsFromString ( const TQString  argsStr)
virtual

Read extra arguments from given string.

Reimplemented from KMFilterActionWithString.

Definition at line 278 of file kmfilteraction.cpp.

◆ clearParamWidget()

void KMFilterActionWithStringList::clearParamWidget ( TQWidget *  paramWidget) const
virtual

The filter action shall clear it's parameter widget's contents.

Reimplemented from KMFilterActionWithString.

Definition at line 273 of file kmfilteraction.cpp.

◆ createParamWidget()

TQWidget * KMFilterActionWithStringList::createParamWidget ( TQWidget *  parent) const
virtual

Creates a widget for setting the filter action parameter.

Also sets the value of the widget.

Reimplemented from KMFilterActionWithString.

Definition at line 254 of file kmfilteraction.cpp.

◆ setParamWidgetValue()

void KMFilterActionWithStringList::setParamWidgetValue ( TQWidget *  paramWidget) const
virtual

The filter action shall set it's widget's contents from it's parameter.

Reimplemented from KMFilterActionWithString.

Definition at line 267 of file kmfilteraction.cpp.


The documentation for this class was generated from the following files: