kmail

KMFilterActionWithStringList Class Reference

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

#include <kmfilteraction.h>

Inheritance diagram for KMFilterActionWithStringList:
KMFilterActionWithString KMFilterAction

List of all members.

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)

Protected Attributes

TQStringList mParameterList

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@Mutz.com>, based upon work by Stefan Taferner <taferner@kde.org>
See also:
KMFilterActionWithString KMFilterActionWithFolder KMFilterAction KMFilter

Definition at line 339 of file kmfilteraction.h.


Constructor & Destructor Documentation

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

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.

void KMFilterActionWithStringList::argsFromString ( const TQString  argsStr  )  [virtual]

Read extra arguments from given string.

Reimplemented from KMFilterActionWithString.

Definition at line 278 of file kmfilteraction.cpp.

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.

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.

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: