MailCommon::FilterActionWithFolder Class Reference

#include <filteractionwithfolder.h>

Inheritance diagram for MailCommon::FilterActionWithFolder:

Public Member Functions
	FilterActionWithFolder (const QString &name, const QString &label, QObject *parent=0)
virtual void	applyParamWidgetValue (QWidget *paramWidget)
virtual QString	argsAsString () const
virtual QString	argsAsStringReal () const
virtual void	argsFromString (const QString &argsStr)
virtual bool	argsFromStringInteractive (const QString &argsStr, const QString &filterName)
virtual void	clearParamWidget (QWidget *paramWidget) const
virtual QWidget *	createParamWidget (QWidget *parent) const
virtual QString	displayString () const
virtual bool	folderRemoved (const Akonadi::Collection &aFolder, const Akonadi::Collection &aNewFolder)
virtual bool	isEmpty () const
virtual void	setParamWidgetValue (QWidget *paramWidget) const
Public Member Functions inherited from MailCommon::FilterAction
	FilterAction (const QString &name, const QString &label, QObject *parent=0)
virtual	~FilterAction ()
virtual QString	informationAboutNotValidAction () const
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
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

Protected Attributes
Akonadi::Collection	mFolder

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 >())
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)
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)
Properties inherited from QObject
	objectName

Detailed Description

Abstract base class for filter actions with a mail folder as parameter.

Abstract base class for mail filter actions that need a mail folder as parameter, e.g. 'move into folder'. Can create a KComboBox as parameter widget. A subclass of this must provide at least implementations for the following methods:

• virtual FilterAction::ReturnCodes FilterAction::process
• static FilterAction::newAction

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

FilterActionWithStringList FilterAction Filter

Definition at line 41 of file filteractionwithfolder.h.

Constructor & Destructor Documentation

FilterActionWithFolder::FilterActionWithFolder	(	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 32 of file filteractionwithfolder.cpp.

Member Function Documentation

void FilterActionWithFolder::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::FilterAction.

Definition at line 55 of file filteractionwithfolder.cpp.

QString FilterActionWithFolder::argsAsString ( ) const

virtual

Return extra arguments as string.

Must not contain newlines.

Implements MailCommon::FilterAction.

Definition at line 109 of file filteractionwithfolder.cpp.

QString FilterActionWithFolder::argsAsStringReal ( ) const

virtual

Reimplemented from MailCommon::FilterAction.

Definition at line 91 of file filteractionwithfolder.cpp.

void FilterActionWithFolder::argsFromString ( const QString &  argsStr )

virtual

Read extra arguments from given string.

Implements MailCommon::FilterAction.

Definition at line 98 of file filteractionwithfolder.cpp.

bool FilterActionWithFolder::argsFromStringInteractive ( const QString &  argsStr, const QString &  filterName  )

virtual

Read extra arguments from given string.

Return true if we need to update config file

Reimplemented from MailCommon::FilterAction.

Definition at line 70 of file filteractionwithfolder.cpp.

void FilterActionWithFolder::clearParamWidget ( QWidget *  paramWidget ) const

virtual

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

Reimplemented from MailCommon::FilterAction.

Definition at line 65 of file filteractionwithfolder.cpp.

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

virtual

Creates a widget for setting the filter action parameter.

Also sets the value of the widget.

Reimplemented from MailCommon::FilterAction.

Definition at line 42 of file filteractionwithfolder.cpp.

QString FilterActionWithFolder::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 118 of file filteractionwithfolder.cpp.

bool FilterActionWithFolder::folderRemoved ( const Akonadi::Collection &  aFolder, const Akonadi::Collection &  aNewFolder  )

virtual

Called from the filter when a folder is removed.

Tests if the folder aFolder is used and changes to aNewFolder in this case. Returns true if a change was made.

Reimplemented from MailCommon::FilterAction.

Definition at line 127 of file filteractionwithfolder.cpp.

bool FilterActionWithFolder::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 37 of file filteractionwithfolder.cpp.

void FilterActionWithFolder::setParamWidgetValue ( QWidget *  paramWidget ) const

virtual

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

Reimplemented from MailCommon::FilterAction.

Definition at line 60 of file filteractionwithfolder.cpp.

Member Data Documentation

Akonadi::Collection MailCommon::FilterActionWithFolder::mFolder

protected

Definition at line 102 of file filteractionwithfolder.h.

---

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

• filteractionwithfolder.h
• filteractionwithfolder.cpp