#include <filteractionaddheader.h>

Inheritance diagram for MailCommon::FilterActionAddHeader:

Public Member Functions
	FilterActionAddHeader (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

QString	displayString () const

QString	informationAboutNotValidAction () const

bool	isEmpty () const

ReturnCode	process (ItemContext &context, bool applyOnOutbound) const

SearchRule::RequiredPart	requiredPart () const

void	setParamWidgetValue (QWidget *paramWidget) const

QString	sieveCode () const

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

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

Public Member Functions inherited from QObject
	QObject (QObject *parent)

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

bool	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

bool	disconnect (const char signal, const QObject receiver, const char *method)

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () 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 >())

Static Public Member Functions inherited from QObject
bool	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

bool	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

QString	tr (const char sourceText, const char disambiguation, int n)

QString	trUtf8 (const char sourceText, const char disambiguation, int n)

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 Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Protected Attributes inherited from MailCommon::FilterActionWithStringList
QStringList	mParameterList

Protected Attributes inherited from MailCommon::FilterActionWithString
QString	mParameter

Properties inherited from QObject
	objectName

Detailed Description

Definition at line 31 of file filteractionaddheader.h.

Constructor & Destructor Documentation

FilterActionAddHeader::FilterActionAddHeader ( QObject * parent = 0 )

explicit

Definition at line 34 of file filteractionaddheader.cpp.

Member Function Documentation

void FilterActionAddHeader::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 139 of file filteractionaddheader.cpp.

QString FilterActionAddHeader::argsAsString ( ) const

virtual

Return extra arguments as string.

Must not contain newlines.

Reimplemented from MailCommon::FilterActionWithString.

Definition at line 167 of file filteractionaddheader.cpp.

void FilterActionAddHeader::argsFromString ( const QString & argsStr )

virtual

Read extra arguments from given string.

Reimplemented from MailCommon::FilterActionWithStringList.

Definition at line 181 of file filteractionaddheader.cpp.

void FilterActionAddHeader::clearParamWidget ( QWidget * paramWidget ) const

virtual

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

Reimplemented from MailCommon::FilterActionWithStringList.

Definition at line 150 of file filteractionaddheader.cpp.

QWidget * FilterActionAddHeader::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 74 of file filteractionaddheader.cpp.

QString FilterActionAddHeader::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 176 of file filteractionaddheader.cpp.

QString FilterActionAddHeader::informationAboutNotValidAction ( ) const

virtual

Reimplemented from MailCommon::FilterAction.

Definition at line 221 of file filteractionaddheader.cpp.

bool FilterActionAddHeader::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 47 of file filteractionaddheader.cpp.

FilterAction * FilterActionAddHeader::newAction ( )

static

Definition at line 202 of file filteractionaddheader.cpp.

FilterAction::ReturnCode FilterActionAddHeader::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 52 of file filteractionaddheader.cpp.

SearchRule::RequiredPart FilterActionAddHeader::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 161 of file filteractionaddheader.cpp.

void FilterActionAddHeader::setParamWidgetValue ( QWidget * paramWidget ) const

virtual

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

Reimplemented from MailCommon::FilterActionWithStringList.