kmail

KMFilterActionWithTest Class Reference

Inheritance diagram for KMFilterActionWithTest:

KMFilterAction List of all members.

Detailed Description

Definition at line 595 of file kmfilteraction.h.


Public Member Functions

 KMFilterActionWithTest (const char *aName, const QString aLabel)
 ~KMFilterActionWithTest ()
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

KMFilterActionWithTest::KMFilterActionWithTest ( 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 1738 of file kmfilteraction.cpp.


Member Function Documentation

virtual bool KMFilterActionWithTest::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 606 of file kmfilteraction.h.

QWidget * KMFilterActionWithTest::createParamWidget ( QWidget *  parent  )  const [virtual]

Creates a widget for setting the filter action parameter.

Also sets the value of the widget.

Reimplemented from KMFilterAction.

Definition at line 1747 of file kmfilteraction.cpp.

void KMFilterActionWithTest::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.

Definition at line 1755 of file kmfilteraction.cpp.

void KMFilterActionWithTest::setParamWidgetValue ( QWidget *  paramWidget  )  const [virtual]

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

Reimplemented from KMFilterAction.

Definition at line 1760 of file kmfilteraction.cpp.

void KMFilterActionWithTest::clearParamWidget ( QWidget *  paramWidget  )  const [virtual]

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

Reimplemented from KMFilterAction.

Definition at line 1765 of file kmfilteraction.cpp.

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

Read extra arguments from given string.

Implements KMFilterAction.

Definition at line 1770 of file kmfilteraction.cpp.

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

Return extra arguments as string.

Must not contain newlines.

Implements KMFilterAction.

Definition at line 1775 of file kmfilteraction.cpp.

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

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

in the filter log.

Implements KMFilterAction.

Definition at line 1780 of file kmfilteraction.cpp.


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