MailCommon::FilterActionStatus Class Reference

#include <filteractionstatus.h>

Inheritance diagram for MailCommon::FilterActionStatus:

Public Member Functions
	FilterActionStatus (const QString &name, const QString &label, QObject *parent=0)
QString	argsAsString () const
void	argsFromString (const QString &argsStr)
QString	displayString () const
bool	isEmpty () const
SearchRule::RequiredPart	requiredPart () const
Public Member Functions inherited from MailCommon::FilterActionWithStringList
	FilterActionWithStringList (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 void	setParamWidgetValue (QWidget *paramWidget) const
Public Member Functions inherited from MailCommon::FilterActionWithString
	FilterActionWithString (const QString &name, const QString &label, QObject *parent=0)
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 QString	sieveCode () const
virtual QStringList	sieveRequires () const

Static Public Member Functions
static QString	realStatusString (const QString &statusStr)
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 >())

Static Public Attributes
static Akonadi::MessageStatus	stati []
static int	StatiCount = sizeof( MailCommon::FilterActionStatus::stati ) / sizeof( Akonadi::MessageStatus )

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 ()
Protected Attributes inherited from MailCommon::FilterActionWithStringList
QStringList	mParameterList
Protected Attributes inherited from MailCommon::FilterActionWithString
QString	mParameter

Detailed Description

Definition at line 26 of file filteractionstatus.h.

Constructor & Destructor Documentation

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

Definition at line 41 of file filteractionstatus.cpp.

Member Function Documentation

QString FilterActionStatus::argsAsString ( ) const

virtual

Return extra arguments as string.

Must not contain newlines.

Reimplemented from MailCommon::FilterActionWithString.

Definition at line 99 of file filteractionstatus.cpp.

void FilterActionStatus::argsFromString ( const QString &  argsStr )

virtual

Read extra arguments from given string.

Reimplemented from MailCommon::FilterActionWithStringList.

Definition at line 82 of file filteractionstatus.cpp.

QString FilterActionStatus::displayString ( ) const

virtual

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

in the filter log.

Reimplemented from MailCommon::FilterActionWithString.

Definition at line 108 of file filteractionstatus.cpp.

bool FilterActionStatus::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::FilterActionWithString.

Definition at line 66 of file filteractionstatus.cpp.

QString FilterActionStatus::realStatusString ( const QString &  statusStr )

static

Definition at line 71 of file filteractionstatus.cpp.

SearchRule::RequiredPart FilterActionStatus::requiredPart ( ) const

virtual

Returns the required part from the item that is needed for the action to operate.

See SearchRule::RequiredPart

Implements MailCommon::FilterAction.

Reimplemented in MailCommon::FilterActionUnsetStatus.

Definition at line 61 of file filteractionstatus.cpp.

Member Data Documentation

Akonadi::MessageStatus MailCommon::FilterActionStatus::stati

static

Initial value:

=
{
    Akonadi::MessageStatus::statusImportant(),
    Akonadi::MessageStatus::statusRead(),
    Akonadi::MessageStatus::statusUnread(),
    Akonadi::MessageStatus::statusReplied(),
    Akonadi::MessageStatus::statusForwarded(),
    Akonadi::MessageStatus::statusWatched(),
    Akonadi::MessageStatus::statusIgnored(),
    Akonadi::MessageStatus::statusSpam(),
    Akonadi::MessageStatus::statusHam(),
    Akonadi::MessageStatus::statusToAct()
}

Definition at line 39 of file filteractionstatus.h.

int MailCommon::FilterActionStatus::StatiCount = sizeof( MailCommon::FilterActionStatus::stati ) / sizeof( Akonadi::MessageStatus )

static

Definition at line 40 of file filteractionstatus.h.

---

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

• filteractionstatus.h
• filteractionstatus.cpp