kmail Library API Documentation

KMFilterActionWithString Class Reference

Abstract base class for KMail's filter actions that need a free-form parameter, e.g. Abstract base class for filter actions with a free-form string as parameter. More...

#include <kmfilteraction.h>

Inheritance diagram for KMFilterActionWithString:

KMFilterAction KMFilterActionWithAddress KMFilterActionWithStringList List of all members.

Public Methods

 KMFilterActionWithString (const char *aName, const QString aLabel)
virtual bool isEmpty () const
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)
virtual const QString argsAsString () const

Protected Attributes

QString mParameter

Detailed Description

Abstract base class for KMail's filter actions that need a free-form parameter, e.g. Abstract base class for filter actions with a free-form string as parameter.

'set transport' or 'set reply to'. Can create a QLineEdit as parameter widget. A subclass of this must provide at least implementations for the following methods:

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

Definition at line 200 of file kmfilteraction.h.


Constructor & Destructor Documentation

KMFilterActionWithString::KMFilterActionWithString 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 156 of file kmfilteraction.cpp.


Member Function Documentation

virtual bool KMFilterActionWithString::isEmpty   const [inline, virtual]
 

Determines whether this action is valid.

But this is just a quick test. Eg., actions that have a mail address as parameter shouldn't try real address validation, but only check if the string representation is empty.

Reimplemented from KMFilterAction.

Definition at line 211 of file kmfilteraction.h.

References QString::stripWhiteSpace().

QWidget * KMFilterActionWithString::createParamWidget QWidget   parent const [virtual]
 

Creates a widget for setting the filter action parameter.

Also sets the value of the widget.

Reimplemented from KMFilterAction.

Reimplemented in KMFilterActionWithStringList, and KMFilterActionWithAddress.

Definition at line 161 of file kmfilteraction.cpp.

References QLineEdit::setText().

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

Reimplemented in KMFilterActionWithStringList, and KMFilterActionWithAddress.

Definition at line 168 of file kmfilteraction.cpp.

void KMFilterActionWithString::setParamWidgetValue QWidget   paramWidget const [virtual]
 

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

Reimplemented from KMFilterAction.

Reimplemented in KMFilterActionWithStringList, and KMFilterActionWithAddress.

Definition at line 173 of file kmfilteraction.cpp.

void KMFilterActionWithString::clearParamWidget QWidget   paramWidget const [virtual]
 

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

Reimplemented from KMFilterAction.

Reimplemented in KMFilterActionWithStringList, and KMFilterActionWithAddress.

Definition at line 178 of file kmfilteraction.cpp.

void KMFilterActionWithString::argsFromString const QString    argsStr [virtual]
 

Read extra arguments from given string.

Implements KMFilterAction.

Reimplemented in KMFilterActionWithStringList.

Definition at line 183 of file kmfilteraction.cpp.

const QString KMFilterActionWithString::argsAsString   const [virtual]
 

Return extra arguments as string.

Must not contain newlines.

Implements KMFilterAction.

Definition at line 188 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