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:

List of all members.


Public Member Functions

virtual void applyParamWidgetValue (QWidget *paramWidget)
virtual void argsFromString (const QString argsStr)
virtual void clearParamWidget (QWidget *paramWidget) const
virtual QWidgetcreateParamWidget (QWidget *parent) const
 KMFilterActionWithStringList (const char *aName, const QString aLabel)
virtual void setParamWidgetValue (QWidget *paramWidget) const

Protected Attributes

QStringList 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 QComboBox as parameter widget. A subclass of this must provide at least implementations for the following methods:

Additionally, it's constructor should populate the QStringList 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 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 246 of file kmfilteraction.cpp.


Member Function Documentation

void KMFilterActionWithStringList::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 KMFilterActionWithString.

Definition at line 259 of file kmfilteraction.cpp.

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

Read extra arguments from given string.

Reimplemented from KMFilterActionWithString.

Definition at line 275 of file kmfilteraction.cpp.

void KMFilterActionWithStringList::clearParamWidget ( QWidget paramWidget  )  const [virtual]

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

Reimplemented from KMFilterActionWithString.

Definition at line 270 of file kmfilteraction.cpp.

QWidget * KMFilterActionWithStringList::createParamWidget ( QWidget 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 251 of file kmfilteraction.cpp.

void KMFilterActionWithStringList::setParamWidgetValue ( QWidget paramWidget  )  const [virtual]

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

Reimplemented from KMFilterActionWithString.

Definition at line 264 of file kmfilteraction.cpp.


Member Data Documentation


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