#include <filteractionaddtoaddressbook.h>

Inheritance diagram for MailCommon::FilterActionAddToAddressBook:

Public Member Functions
	FilterActionAddToAddressBook (QObject *parent=0)

void	applyParamWidgetValue (QWidget *paramWidget)

QString	argsAsString () const

void	argsFromString (const QString &argsStr)

void	clearParamWidget (QWidget *paramWidget) const

QWidget *	createParamWidget (QWidget *parent) const

bool	isEmpty () const

ReturnCode	process (ItemContext &context, bool applyOnOutbound) const

SearchRule::RequiredPart	requiredPart () const

void	setParamWidgetValue (QWidget *paramWidget) const

Public Member Functions inherited from MailCommon::FilterActionWithStringList
	FilterActionWithStringList (const QString &name, const QString &label, QObject *parent=0)

Public Member Functions inherited from MailCommon::FilterActionWithString
	FilterActionWithString (const QString &name, const QString &label, QObject *parent=0)

virtual QString	displayString () 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 QString	sieveCode () const

virtual QStringList	sieveRequires () const

Static Public Member Functions
static FilterAction *	newAction ()

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 >())

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 31 of file filteractionaddtoaddressbook.h.

Constructor & Destructor Documentation

FilterActionAddToAddressBook::FilterActionAddToAddressBook ( QObject * parent = 0 )

explicit

Definition at line 42 of file filteractionaddtoaddressbook.cpp.

Member Function Documentation

void FilterActionAddToAddressBook::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::FilterActionWithStringList.

Definition at line 160 of file filteractionaddtoaddressbook.cpp.

QString FilterActionAddToAddressBook::argsAsString ( ) const

virtual

Return extra arguments as string.

Must not contain newlines.

Reimplemented from MailCommon::FilterActionWithString.

Definition at line 198 of file filteractionaddtoaddressbook.cpp.

void FilterActionAddToAddressBook::argsFromString ( const QString & argsStr )

virtual

Read extra arguments from given string.

Reimplemented from MailCommon::FilterActionWithStringList.

Definition at line 218 of file filteractionaddtoaddressbook.cpp.

void FilterActionAddToAddressBook::clearParamWidget ( QWidget * paramWidget ) const

virtual

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

Reimplemented from MailCommon::FilterActionWithStringList.

Definition at line 187 of file filteractionaddtoaddressbook.cpp.

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

virtual

Creates a widget for setting the filter action parameter.

Also sets the value of the widget.

Reimplemented from MailCommon::FilterActionWithStringList.

Definition at line 97 of file filteractionaddtoaddressbook.cpp.

bool FilterActionAddToAddressBook::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 54 of file filteractionaddtoaddressbook.cpp.

FilterAction * FilterActionAddToAddressBook::newAction ( )

static

Definition at line 37 of file filteractionaddtoaddressbook.cpp.

FilterAction::ReturnCode FilterActionAddToAddressBook::process	(	ItemContext &	context,
		bool	applyOnOutbound
	)		const

virtual

Execute action on given message (inside the item context).

Returns CriticalError if a critical error has occurred (eg. disk full), ErrorButGoOn if there was a non-critical error (e.g. invalid address in 'forward' action), ErrorNeedComplete if a complete message is required, GoOn if the message shall be processed by further filters and Ok otherwise.

Implements MailCommon::FilterAction.

Definition at line 59 of file filteractionaddtoaddressbook.cpp.

SearchRule::RequiredPart FilterActionAddToAddressBook::requiredPart ( ) const

virtual

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

See SearchRule::RequiredPart

Implements MailCommon::FilterAction.

Definition at line 91 of file filteractionaddtoaddressbook.cpp.

void FilterActionAddToAddressBook::setParamWidgetValue ( QWidget * paramWidget ) const

virtual

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

Reimplemented from MailCommon::FilterActionWithStringList.