kmail

KMFilterActionWithString Class Reference

#include <kmfilteraction.h>

Inheritance diagram for KMFilterActionWithString:

KMFilterAction KMFilterActionWithAddress KMFilterActionWithStringList List of all members.

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 222 of file kmfilteraction.h.


Public Member Functions

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

Protected Attributes

QString mParameter

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 178 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 233 of file kmfilteraction.h.

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

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 190 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 195 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 200 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 205 of file kmfilteraction.cpp.

const QString KMFilterActionWithString::argsAsString (  )  const [virtual]

Return extra arguments as string.

Must not contain newlines.

Implements KMFilterAction.

Definition at line 210 of file kmfilteraction.cpp.

const QString KMFilterActionWithString::displayString (  )  const [virtual]

Returns a translated string describing this filter for visualization purposes, e.g.

in the filter log.

Implements KMFilterAction.

Definition at line 215 of file kmfilteraction.cpp.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys