kmail

Public Member Functions | List of all members
KMFilterActionWithNone Class Reference

#include <kmfilteraction.h>

Inheritance diagram for KMFilterActionWithNone:
KMFilterAction

Public Member Functions

 KMFilterActionWithNone (const char *aName, const TQString aLabel)
 
virtual void argsFromString (const TQString)
 
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 bool isEmpty () 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)
 

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 no parameter, e.g.

"Confirm Delivery". Creates an (empty) TQWidget as parameter widget. A subclass of this must provide at least implementations for the following methods:

Abstract base class for filter actions with no 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 181 of file kmfilteraction.h.

Constructor & Destructor Documentation

◆ KMFilterActionWithNone()

KMFilterActionWithNone::KMFilterActionWithNone ( 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 153 of file kmfilteraction.cpp.

Member Function Documentation

◆ argsAsString()

virtual const TQString KMFilterActionWithNone::argsAsString ( ) const
inlinevirtual

Return extra arguments as string.

Must not contain newlines. We return TQString(), because we have no parameter.

Implements KMFilterAction.

Definition at line 194 of file kmfilteraction.h.

◆ argsFromString()

virtual void KMFilterActionWithNone::argsFromString ( const  TQString)
inlinevirtual

Read extra arguments from given string.

This type of filter action has no parameters, so this is a no-op.

Implements KMFilterAction.

Definition at line 190 of file kmfilteraction.h.

◆ displayString()

const TQString KMFilterActionWithNone::displayString ( ) const
virtual

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

in the filter log.

Implements KMFilterAction.

Definition at line 158 of file kmfilteraction.cpp.

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