kmail

KMFilterActionWithFolder Class Reference

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

#include <kmfilteraction.h>

Inheritance diagram for KMFilterActionWithFolder:

KMFilterAction

List of all members.


Public Member Functions

 KMFilterActionWithFolder (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
virtual bool folderRemoved (KMFolder *aFolder, KMFolder *aNewFolder)

Protected Attributes

QGuardedPtr< KMFoldermFolder
QString mFolderName

Detailed Description

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

'move into folder'. Can create a QComboBox as parameter widget. A subclass of this must provide at least implementations for the following methods:

Abstract base class for filter actions with a mail folder as parameter.
Author:
Marc Mutz <Marc@Mutz.com>, based upon work by Stefan Taferner <taferner@kde.org>
See also:
KMFilterActionWithStringList KMFilterAction KMFilter

Definition at line 392 of file kmfilteraction.h.


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.

Definition at line 296 of file kmfilteraction.cpp.


Member Function Documentation

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.

Definition at line 310 of file kmfilteraction.cpp.

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

Return extra arguments as string.

Must not contain newlines.

Implements KMFilterAction.

Definition at line 342 of file kmfilteraction.cpp.

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

Read extra arguments from given string.

Implements KMFilterAction.

Definition at line 329 of file kmfilteraction.cpp.

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

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

Reimplemented from KMFilterAction.

Definition at line 324 of file kmfilteraction.cpp.

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.

Definition at line 302 of file kmfilteraction.cpp.

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

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

in the filter log.

Implements KMFilterAction.

Definition at line 352 of file kmfilteraction.cpp.

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.

Definition at line 362 of file kmfilteraction.cpp.

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.

Definition at line 403 of file kmfilteraction.h.

void KMFilterActionWithFolder::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 316 of file kmfilteraction.cpp.


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