MailCommon::FilterActionWithUrl Class Reference

#include <filteractionwithurl.h>

Inheritance diagram for MailCommon::FilterActionWithUrl:

Public Member Functions
	FilterActionWithUrl (const QString &name, const QString &label, QObject *parent=0)
	~FilterActionWithUrl ()
virtual void	applyParamWidgetValue (QWidget *paramWidget)
virtual QString	argsAsString () const
virtual void	argsFromString (const QString &argsStr)
virtual void	clearParamWidget (QWidget *paramWidget) const
virtual QWidget *	createParamWidget (QWidget *parent) const
virtual QString	displayString () const
virtual bool	isEmpty () const
virtual void	setParamWidgetValue (QWidget *paramWidget) const
Public Member Functions inherited from MailCommon::FilterAction
	FilterAction (const QString &name, const QString &label, QObject *parent=0)
virtual	~FilterAction ()
virtual QString	argsAsStringReal () const
virtual bool	argsFromStringInteractive (const QString &argsStr, const QString &filterName)
virtual bool	folderRemoved (const Akonadi::Collection &aFolder, const Akonadi::Collection &aNewFolder)
QString	label () const
QString	name () const
virtual ReturnCode	process (ItemContext &context, bool applyOnOutbound) const =0
virtual SearchRule::RequiredPart	requiredPart () const =0
virtual QString	sieveCode () const
virtual QStringList	sieveRequires () const

Protected Attributes
QString	mParameter

Additional Inherited Members
Public Types inherited from MailCommon::FilterAction
enum	ReturnCode { ErrorNeedComplete = 0x1, GoOn = 0x2, ErrorButGoOn = 0x4, CriticalError = 0x8 }
Signals inherited from MailCommon::FilterAction
void	filterActionModified ()
Static Public Member Functions inherited from MailCommon::FilterAction
static FilterAction *	newAction ()
static void	sendMDN (const Akonadi::Item &item, KMime::MDN::DispositionType d, const QList< KMime::MDN::DispositionModifier > &m=QList< KMime::MDN::DispositionModifier >())

Detailed Description

Abstract base class for filter actions with a command line as parameter.

Abstract base class for mail filter actions that need a command line as parameter, e.g. 'forward to'. Can create a QLineEdit (are there better widgets in the depths of the kdelibs?) as parameter widget. A subclass of this must provide at least implementations for the following methods:

• virtual FilterAction::ReturnCodes FilterAction::process
• static FilterAction::newAction

The implementation of FilterAction::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().

Author

Marc Mutz mutz@.nosp@m.kde..nosp@m.org, based upon work by Stefan Taferner tafer.nosp@m.ner@.nosp@m.kde.o.nosp@m.rg

See also

FilterActionWithString FilterAction Filter KProcess

Definition at line 47 of file filteractionwithurl.h.

Constructor & Destructor Documentation

FilterActionWithUrl::FilterActionWithUrl	(	const QString &	name,
		const QString &	label,
		QObject *	parent = 0
	)

Creates a new filter action.

The action is initialized with an identifier name and an i18n'd label.

Definition at line 28 of file filteractionwithurl.cpp.

FilterActionWithUrl::~FilterActionWithUrl

(

)

Destroys the filter action.

Definition at line 33 of file filteractionwithurl.cpp.

Member Function Documentation

void FilterActionWithUrl::applyParamWidgetValue ( QWidget *  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 MailCommon::FilterAction.

Reimplemented in MailCommon::FilterActionWithCommand.

Definition at line 53 of file filteractionwithurl.cpp.

QString FilterActionWithUrl::argsAsString ( ) const

virtual

Return extra arguments as string.

Must not contain newlines.

Implements MailCommon::FilterAction.

Definition at line 75 of file filteractionwithurl.cpp.

void FilterActionWithUrl::argsFromString ( const QString &  argsStr )

virtual

Implements MailCommon::FilterAction.

Definition at line 70 of file filteractionwithurl.cpp.

void FilterActionWithUrl::clearParamWidget ( QWidget *  paramWidget ) const

virtual

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

Reimplemented from MailCommon::FilterAction.

Reimplemented in MailCommon::FilterActionWithCommand.

Definition at line 65 of file filteractionwithurl.cpp.

QWidget * FilterActionWithUrl::createParamWidget ( QWidget *  parent ) const

virtual

Creates a widget for setting the filter action parameter.

Also sets the value of the widget.

Reimplemented from MailCommon::FilterAction.

Reimplemented in MailCommon::FilterActionWithCommand.

Definition at line 42 of file filteractionwithurl.cpp.

QString FilterActionWithUrl::displayString ( ) const

virtual

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

in the filter log.

Implements MailCommon::FilterAction.

Definition at line 80 of file filteractionwithurl.cpp.

bool FilterActionWithUrl::isEmpty ( ) const

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 MailCommon::FilterAction.

Definition at line 37 of file filteractionwithurl.cpp.

void FilterActionWithUrl::setParamWidgetValue ( QWidget *  paramWidget ) const

virtual

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

Reimplemented from MailCommon::FilterAction.

Reimplemented in MailCommon::FilterActionWithCommand.

Definition at line 60 of file filteractionwithurl.cpp.

Member Data Documentation

QString MailCommon::FilterActionWithUrl::mParameter

protected

Definition at line 102 of file filteractionwithurl.h.

---

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

• filteractionwithurl.h
• filteractionwithurl.cpp