KDE PIM / Developers / API Docs / kmail

KMFilterActionWithUrl Class Reference

Abstract base class for KMail's filter actions that need a command line as parameter, e.g.Abstract base class for filter actions with a command line as parameter. More...

#include <kmfilteraction.h>

Inherits KMFilterAction.

Inherited by KMFilterActionWithCommand.

List of all members.

Public Member Functions

Protected Attributes


Detailed Description

Abstract base class for KMail's filter actions that need a command line as parameter, e.g.Abstract base class for filter actions with a command line as parameter.

'forward to'. Can create a

See also:
QLineEdit (are there better widgets in the depths of the kdelibs?) as parameter widget. A subclass of this must provide at least implementations for the following methods:


Constructor & Destructor Documentation

KMFilterActionWithUrl::KMFilterActionWithUrl 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.


Member Function Documentation

virtual bool KMFilterActionWithUrl::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.

QWidget * KMFilterActionWithUrl::createParamWidget QWidget *  parent  )  const [virtual]
 

Creates a widget for setting the filter action parameter.

Also sets the value of the widget.

Reimplemented from KMFilterAction.

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

void KMFilterActionWithUrl::setParamWidgetValue QWidget *  paramWidget  )  const [virtual]
 

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

Reimplemented from KMFilterAction.

void KMFilterActionWithUrl::clearParamWidget QWidget *  paramWidget  )  const [virtual]
 

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

Reimplemented from KMFilterAction.

void KMFilterActionWithUrl::argsFromString const QString  argsStr  )  [virtual]
 

Read extra arguments from given string.

Implements KMFilterAction.

const QString KMFilterActionWithUrl::argsAsString  )  const [virtual]
 

Return extra arguments as string.

Must not contain newlines.

Implements KMFilterAction.

const QString KMFilterActionWithUrl::displayString  )  const [virtual]
 

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

in the filter log.

Implements KMFilterAction.


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