MailCommon::FilterActionWithCommand Class Reference

#include <filteractionwithcommand.h>

Inheritance diagram for MailCommon::FilterActionWithCommand:

Public Member Functions
	FilterActionWithCommand (const QString &name, const QString &label, QObject *parent=0)
virtual void	applyParamWidgetValue (QWidget *paramWidget)
virtual void	clearParamWidget (QWidget *paramWidget) const
virtual QWidget *	createParamWidget (QWidget *parent) const
virtual ReturnCode	genericProcess (ItemContext &context, bool filtering) const
virtual void	setParamWidgetValue (QWidget *paramWidget) const
virtual QString	substituteCommandLineArgsFor (const KMime::Message::Ptr &aMsg, QList< KTemporaryFile * > &aTempFileList) const
Public Member Functions inherited from MailCommon::FilterActionWithUrl
	FilterActionWithUrl (const QString &name, const QString &label, QObject *parent=0)
	~FilterActionWithUrl ()
virtual QString	argsAsString () const
virtual void	argsFromString (const QString &argsStr)
virtual QString	displayString () const
virtual bool	isEmpty () 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

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 >())
Protected Attributes inherited from MailCommon::FilterActionWithUrl
QString	mParameter

Detailed Description

Definition at line 29 of file filteractionwithcommand.h.

Constructor & Destructor Documentation

FilterActionWithCommand::FilterActionWithCommand	(	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 30 of file filteractionwithcommand.cpp.

Member Function Documentation

void FilterActionWithCommand::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::FilterActionWithUrl.

Definition at line 40 of file filteractionwithcommand.cpp.

void FilterActionWithCommand::clearParamWidget ( QWidget *  paramWidget ) const

virtual

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

Reimplemented from MailCommon::FilterActionWithUrl.

Definition at line 50 of file filteractionwithcommand.cpp.

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

virtual

Creates a widget for setting the filter action parameter.

Also sets the value of the widget.

Reimplemented from MailCommon::FilterActionWithUrl.

Definition at line 35 of file filteractionwithcommand.cpp.

FilterAction::ReturnCode FilterActionWithCommand::genericProcess ( ItemContext &  context, bool  filtering  ) const

virtual

Definition at line 173 of file filteractionwithcommand.cpp.

void FilterActionWithCommand::setParamWidgetValue ( QWidget *  paramWidget ) const

virtual

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

Reimplemented from MailCommon::FilterActionWithUrl.

Definition at line 45 of file filteractionwithcommand.cpp.

QString FilterActionWithCommand::substituteCommandLineArgsFor ( const KMime::Message::Ptr &  aMsg, QList< KTemporaryFile * > &  aTempFileList  ) const

virtual

Substitutes various placeholders for data from the message resp.

for filenames containing that data. Currently, only n is supported, where n in an integer >= 0. n gets substituted for the name of a tempfile holding the n'th message part, with n=0 meaning the body of the message.

Definition at line 69 of file filteractionwithcommand.cpp.

---

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

• filteractionwithcommand.h
• filteractionwithcommand.cpp