KDE PIM / Developers / API Docs / kmail

KMFilterActionWithUOID Class Reference

Abstract base class for KMail's filter actions that need a parameter that has a UOID, e.g. Abstract base class for filter actions with a free-form string as parameter. More...

#include <kmfilteraction.h>

Inherits KMFilterAction.

Inherited by KMFilterActionIdentity.

List of all members.

Public Member Functions

Protected Attributes


Detailed Description

Abstract base class for KMail's filter actions that need a parameter that has a UOID, e.g. Abstract base class for filter actions with a free-form string as parameter.

"set identity". 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:
KMFilterAction KMFilter


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.


Member Function Documentation

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.

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

Read extra arguments from given string.

Implements KMFilterAction.

const QString KMFilterActionWithUOID::argsAsString  )  const [virtual]
 

Return extra arguments as string.

Must not contain newlines.

Implements KMFilterAction.

const QString KMFilterActionWithUOID::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: