kmail

KMFilterActionWithUOID Class Reference

Abstract base class for KMail's filter actions that need a parameter that has a UOID, e.g. More...

#include <kmfilteraction.h>

Inheritance diagram for KMFilterActionWithUOID:

Inheritance graph
[legend]

List of all members.


Public Member Functions

virtual const QString argsAsString () const
virtual void argsFromString (const QString argsStr)
virtual const QString displayString () const
virtual bool isEmpty () const
 KMFilterActionWithUOID (const char *aName, const QString aLabel)

Protected Attributes

uint mParameter

Detailed Description

Abstract base class for KMail's filter actions that need a parameter that has a UOID, e.g.

"set identity". A subclass of this must provide at least implementations for the following methods:

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

Definition at line 286 of file kmfilteraction.h.

Constructor & Destructor Documentation

KMFilterActionWithUOID::KMFilterActionWithUOID ( 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 167 of file kmfilteraction.cpp.

Member Function Documentation

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

Return extra arguments as string.

Must not contain newlines.

Implements KMFilterAction.

Definition at line 177 of file kmfilteraction.cpp.

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

Read extra arguments from given string.

Implements KMFilterAction.

Definition at line 172 of file kmfilteraction.cpp.

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

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

in the filter log.

Implements KMFilterAction.

Definition at line 182 of file kmfilteraction.cpp.

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

Member Data Documentation

uint KMFilterActionWithUOID::mParameter [protected]

Definition at line 310 of file kmfilteraction.h.

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