MailCommon::FilterActionWithCommand Class Reference

#include <filteractionwithcommand.h>

Inheritance diagram for MailCommon::FilterActionWithCommand:

Public Member Functions
	FilterActionWithCommand (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 ReturnCode	genericProcess (ItemContext &context, bool filtering) const
virtual void	setParamWidgetValue (QWidget *paramWidget) const
virtual QString	substituteCommandLineArgsFor (const KMime::Message::Ptr &aMsg, QList< KTemporaryFile * > &aTempFileList) const
Public Member Functions inherited from MailCommon::FilterActionWithUrl
	FilterActionWithUrl (const QString &name, const QString &label, QObject *parent=0)
	~FilterActionWithUrl ()
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 QString	argsAsStringReal () const
virtual bool	argsFromStringInteractive (const QString &argsStr, const QString &filterName)
virtual bool	folderRemoved (const Akonadi::Collection &aFolder, const Akonadi::Collection &aNewFolder)
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

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)
Protected Attributes inherited from MailCommon::FilterActionWithUrl
QString	mParameter
Properties inherited from QObject
	objectName

Detailed Description

Definition at line 29 of file filteractionwithcommand.h.

Constructor & Destructor Documentation

FilterActionWithCommand::FilterActionWithCommand	(	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 30 of file filteractionwithcommand.cpp.

Member Function Documentation

void FilterActionWithCommand::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::FilterActionWithUrl.

Definition at line 40 of file filteractionwithcommand.cpp.

void FilterActionWithCommand::clearParamWidget ( QWidget *  paramWidget ) const

virtual

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

Reimplemented from MailCommon::FilterActionWithUrl.

Definition at line 50 of file filteractionwithcommand.cpp.

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

virtual

Creates a widget for setting the filter action parameter.

Also sets the value of the widget.

Reimplemented from MailCommon::FilterActionWithUrl.

Definition at line 35 of file filteractionwithcommand.cpp.

FilterAction::ReturnCode FilterActionWithCommand::genericProcess ( ItemContext &  context, bool  filtering  ) const

virtual

Definition at line 173 of file filteractionwithcommand.cpp.

void FilterActionWithCommand::setParamWidgetValue ( QWidget *  paramWidget ) const

virtual

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

Reimplemented from MailCommon::FilterActionWithUrl.

Definition at line 45 of file filteractionwithcommand.cpp.

QString FilterActionWithCommand::substituteCommandLineArgsFor ( const KMime::Message::Ptr &  aMsg, QList< KTemporaryFile * > &  aTempFileList  ) const

virtual

Substitutes various placeholders for data from the message resp.

for filenames containing that data. Currently, only n is supported, where n in an integer >= 0. n gets substituted for the name of a tempfile holding the n'th message part, with n=0 meaning the body of the message.

Definition at line 69 of file filteractionwithcommand.cpp.

---

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

• filteractionwithcommand.h
• filteractionwithcommand.cpp