kmail Library API Documentation

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>

Inheritance diagram for KMFilterActionWithUOID:

KMFilterAction List of all members.

Public Member Functions

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

Protected Attributes

uint mParameter

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

Definition at line 260 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 137 of file kmfilteraction.cpp.

References KMFilterActionWithUOID().

Referenced by KMFilterActionWithUOID().


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.

Definition at line 271 of file kmfilteraction.h.

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

Read extra arguments from given string.

Implements KMFilterAction.

Definition at line 142 of file kmfilteraction.cpp.

References argsFromString().

Referenced by argsFromString().

const QString KMFilterActionWithUOID::argsAsString  )  const [virtual]
 

Return extra arguments as string.

Must not contain newlines.

Implements KMFilterAction.

Definition at line 147 of file kmfilteraction.cpp.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kmail Library Version 3.3.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Oct 21 19:46:52 2004 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003