KDE PIM / Developers / API Docs / kmail

KMFilterActionWithFolder Class Reference

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

#include <kmfilteraction.h>

Inherits KMFilterAction.

Inherited by KMFilterActionCopy, and KMFilterActionMove.

List of all members.

Public Member Functions

Protected Attributes


Detailed Description

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

'move into folder'. Can create a

See also:
QComboBox 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:
KMFilterActionWithStringList KMFilterAction KMFilter


Constructor & Destructor Documentation

KMFilterActionWithFolder::KMFilterActionWithFolder 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 KMFilterActionWithFolder::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 * KMFilterActionWithFolder::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 KMFilterActionWithFolder::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 KMFilterActionWithFolder::setParamWidgetValue QWidget *  paramWidget  )  const [virtual]
 

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

Reimplemented from KMFilterAction.

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

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

Reimplemented from KMFilterAction.

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

Read extra arguments from given string.

Implements KMFilterAction.

const QString KMFilterActionWithFolder::argsAsString  )  const [virtual]
 

Return extra arguments as string.

Must not contain newlines.

Implements KMFilterAction.

const QString KMFilterActionWithFolder::displayString  )  const [virtual]
 

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

in the filter log.

Implements KMFilterAction.

bool KMFilterActionWithFolder::folderRemoved KMFolder aFolder,
KMFolder aNewFolder
[virtual]
 

Called from the filter when a folder is removed.

Tests if the folder aFolder is used and changes to aNewFolder in this case. Returns TRUE if a change was made.

Reimplemented from KMFilterAction.


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