kmail

Public Member Functions | Protected Attributes | List of all members
KMFilterActionWithUOID Class Reference

#include <kmfilteraction.h>

Inheritance diagram for KMFilterActionWithUOID:
KMFilterAction

Public Member Functions

 KMFilterActionWithUOID (const char *aName, const TQString aLabel)
 
virtual bool isEmpty () const
 
virtual void argsFromString (const TQString argsStr)
 
virtual const TQString argsAsString () const
 
virtual const TQString displayString () const
 
- Public Member Functions inherited from KMFilterAction
 KMFilterAction (const char *aName, const TQString aLabel)
 
const TQString label () const
 
const TQString name () const
 
virtual ReturnCode process (KMMessage *msg) const =0
 
virtual void processAsync (KMMessage *msg) const
 
virtual bool requiresBody (KMMsgBase *msgBase) const
 
virtual TQWidget * createParamWidget (TQWidget *parent) const
 
virtual void applyParamWidgetValue (TQWidget *paramWidget)
 
virtual void setParamWidgetValue (TQWidget *paramWidget) const
 
virtual void clearParamWidget (TQWidget *paramWidget) const
 
virtual bool folderRemoved (KMFolder *aFolder, KMFolder *aNewFolder)
 

Protected Attributes

uint mParameter
 

Additional Inherited Members

- Public Types inherited from KMFilterAction
enum  ReturnCode { ErrorNeedComplete = 0x1 , GoOn = 0x2 , ErrorButGoOn = 0x4 , CriticalError = 0x8 }
 
- Static Public Member Functions inherited from KMFilterAction
static KMFilterAction * newAction ()
 
static int tempOpenFolder (KMFolder *aFolder)
 
static void sendMDN (KMMessage *msg, KMime::MDN::DispositionType d, const TQValueList< KMime::MDN::DispositionModifier > &m=TQValueList< KMime::MDN::DispositionModifier >())
 

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@.nosp@m.Mutz.nosp@m..com, based upon work by Stefan Taferner tafer.nosp@m.ner@.nosp@m.kde.o.nosp@m.rg
See also
KMFilterAction KMFilter

Definition at line 286 of file kmfilteraction.h.

Constructor & Destructor Documentation

◆ KMFilterActionWithUOID()

KMFilterActionWithUOID::KMFilterActionWithUOID ( const char *  aName,
const TQString  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 170 of file kmfilteraction.cpp.

Member Function Documentation

◆ argsAsString()

const TQString KMFilterActionWithUOID::argsAsString ( ) const
virtual

Return extra arguments as string.

Must not contain newlines.

Implements KMFilterAction.

Definition at line 180 of file kmfilteraction.cpp.

◆ argsFromString()

void KMFilterActionWithUOID::argsFromString ( const TQString  argsStr)
virtual

Read extra arguments from given string.

Implements KMFilterAction.

Definition at line 175 of file kmfilteraction.cpp.

◆ displayString()

const TQString 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 185 of file kmfilteraction.cpp.

◆ isEmpty()

virtual bool KMFilterActionWithUOID::isEmpty ( ) const
inlinevirtual

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.

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