MailCommon::FilterActionWithUOID Class Reference

#include <filteractionwithuoid.h>

Inheritance diagram for MailCommon::FilterActionWithUOID:

Public Member Functions
	FilterActionWithUOID (const QString &name, const QString &label, QObject *parent=0)
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 void	applyParamWidgetValue (QWidget *paramWidget)
virtual QString	argsAsStringReal () const
virtual bool	argsFromStringInteractive (const QString &argsStr, const QString &filterName)
virtual void	clearParamWidget (QWidget *paramWidget) const
virtual QWidget *	createParamWidget (QWidget *parent) const
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 void	setParamWidgetValue (QWidget *paramWidget) const
virtual QString	sieveCode () const
virtual QStringList	sieveRequires () const

Protected Attributes
uint	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 free-form string as parameter.

Abstract base class for mail 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:

• virtual FilterAction::ReturnCodes FilterAction::process
• static FilterAction::newAction
• the ParamWidget methods.

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

FilterAction Filter

Definition at line 41 of file filteractionwithuoid.h.

Constructor & Destructor Documentation

FilterActionWithUOID::FilterActionWithUOID	(	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 26 of file filteractionwithuoid.cpp.

Member Function Documentation

QString FilterActionWithUOID::argsAsString ( ) const

virtual

Return extra arguments as string.

Must not contain newlines.

Implements MailCommon::FilterAction.

Definition at line 41 of file filteractionwithuoid.cpp.

void FilterActionWithUOID::argsFromString ( const QString &  argsStr )

virtual

Read extra arguments from given string.

Implements MailCommon::FilterAction.

Definition at line 36 of file filteractionwithuoid.cpp.

QString FilterActionWithUOID::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 46 of file filteractionwithuoid.cpp.

bool FilterActionWithUOID::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 31 of file filteractionwithuoid.cpp.

Member Data Documentation

uint MailCommon::FilterActionWithUOID::mParameter

protected

Definition at line 72 of file filteractionwithuoid.h.

---

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

• filteractionwithuoid.h
• filteractionwithuoid.cpp