kmail

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

#include <kmfilteraction.h>

Inheritance diagram for KMFilterActionWithUrl:
KMFilterAction

Public Member Functions

 KMFilterActionWithUrl (const char *aName, const TQString aLabel)
 
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 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 bool folderRemoved (KMFolder *aFolder, KMFolder *aNewFolder)
 

Protected Attributes

TQString 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 command line as parameter, e.g.

'forward to'. Can create a TQLineEdit (are there better widgets in the depths of the tdelibs?) as parameter widget. A subclass of this must provide at least implementations for the following methods:

The implementation of KMFilterAction::process should take the command line specified in mParameter, make all required modifications and stream the resulting command line into mProcess. Then you can start the command with mProcess.start().

Abstract base class for filter actions with a command line 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
KMFilterActionWithString KMFilterAction KMFilter TDEProcess

Definition at line 514 of file kmfilteraction.h.

Constructor & Destructor Documentation

◆ KMFilterActionWithUrl()

KMFilterActionWithUrl::KMFilterActionWithUrl ( 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 1913 of file kmfilteraction.cpp.

Member Function Documentation

◆ applyParamWidgetValue()

void KMFilterActionWithUrl::applyParamWidgetValue ( TQWidget *  paramWidget)
virtual

The filter action shall set it's parameter from the widget's contents.

It is allowed that the value is read by the action before this function is called.

Reimplemented from KMFilterAction.

Definition at line 1930 of file kmfilteraction.cpp.

◆ argsAsString()

const TQString KMFilterActionWithUrl::argsAsString ( ) const
virtual

Return extra arguments as string.

Must not contain newlines.

Implements KMFilterAction.

Definition at line 1950 of file kmfilteraction.cpp.

◆ argsFromString()

void KMFilterActionWithUrl::argsFromString ( const TQString  argsStr)
virtual

Read extra arguments from given string.

Implements KMFilterAction.

Definition at line 1945 of file kmfilteraction.cpp.

◆ clearParamWidget()

void KMFilterActionWithUrl::clearParamWidget ( TQWidget *  paramWidget) const
virtual

The filter action shall clear it's parameter widget's contents.

Reimplemented from KMFilterAction.

Definition at line 1940 of file kmfilteraction.cpp.

◆ createParamWidget()

TQWidget * KMFilterActionWithUrl::createParamWidget ( TQWidget *  parent) const
virtual

Creates a widget for setting the filter action parameter.

Also sets the value of the widget.

Reimplemented from KMFilterAction.

Definition at line 1922 of file kmfilteraction.cpp.

◆ displayString()

const TQString KMFilterActionWithUrl::displayString ( ) const
virtual

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

in the filter log.

Implements KMFilterAction.

Definition at line 1955 of file kmfilteraction.cpp.

◆ isEmpty()

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

◆ setParamWidgetValue()

void KMFilterActionWithUrl::setParamWidgetValue ( TQWidget *  paramWidget) const
virtual

The filter action shall set it's widget's contents from it's parameter.

Reimplemented from KMFilterAction.

Definition at line 1935 of file kmfilteraction.cpp.

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