kmail Library API Documentation

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. Abstract base class for filter actions with a fixed set of string parameters. More...

#include <kmfilteraction.h>

Inheritance diagram for KMFilterActionWithStringList:

KMFilterActionWithString KMFilterAction List of all members.

Public Methods

 KMFilterActionWithStringList (const char *aName, const QString aLabel)
virtual QWidgetcreateParamWidget (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)

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. Abstract base class for filter actions with a fixed set of string parameters.

'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.

Author:
Marc Mutz <Marc@Mutz.com>, based upon work by Stefan Taferner <taferner@kde.org>
See also:
KMFilterActionWithString KMFilterActionWithFolder KMFilterAction KMFilter

Definition at line 309 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 199 of file kmfilteraction.cpp.


Member Function Documentation

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 204 of file kmfilteraction.cpp.

References QComboBox::insertStringList(), and setParamWidgetValue().

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 212 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 217 of file kmfilteraction.cpp.

Referenced by createParamWidget().

void KMFilterActionWithStringList::clearParamWidget QWidget   paramWidget const [virtual]
 

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

Reimplemented from KMFilterActionWithString.

Definition at line 223 of file kmfilteraction.cpp.

void KMFilterActionWithStringList::argsFromString const QString    argsStr [virtual]
 

Read extra arguments from given string.

Reimplemented from KMFilterActionWithString.

Definition at line 228 of file kmfilteraction.cpp.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kmail Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat May 1 11:37:36 2004 by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2003