MailCommon::FilterActionWithString Class Reference

#include <filteractionwithstring.h>

Inheritance diagram for MailCommon::FilterActionWithString:

Public Member Functions
	FilterActionWithString (const QString &name, const QString &label, QObject *parent=nullptr)
void	applyParamWidgetValue (QWidget *paramWidget) override
QString	argsAsString () const override
void	argsFromString (const QString &argsStr) override
void	clearParamWidget (QWidget *paramWidget) const override
QWidget *	createParamWidget (QWidget *parent) const override
QString	displayString () const override
bool	isEmpty () const override
void	setParamWidgetValue (QWidget *paramWidget) const override
Public Member Functions inherited from MailCommon::FilterAction
	FilterAction (const QString &name, const QString &label, QObject *parent=nullptr)
	~FilterAction () override
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)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Protected Attributes
QString	mParameter

Additional Inherited Members
Public Types inherited from MailCommon::FilterAction
enum	ReturnCode { ErrorNeedComplete = 0x1 , GoOn = 0x2 , ErrorButGoOn = 0x4 , CriticalError = 0x8 }
Public Types inherited from QObject
typedef	QObjectList
Properties inherited from QObject
	objectName
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
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
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)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

Abstract base class for filter actions with a free-form string as parameter.

Abstract base class for mail filter actions that need a free-form parameter, e.g. 'set transport' or 'set reply to'. Can create a QLineEdit 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

FilterAction Filter

Definition at line 28 of file filteractionwithstring.h.

Constructor & Destructor Documentation

FilterActionWithString()

FilterActionWithString::FilterActionWithString	(	const QString &	name,
		const QString &	label,
		QObject *	parent = nullptr )

Creates a new filter action.

The action is initialized with an identifier name and an i18n'd label.

Definition at line 14 of file filteractionwithstring.cpp.

Member Function Documentation

applyParamWidgetValue()

void FilterActionWithString::applyParamWidgetValue ( QWidget * paramWidget )

overridevirtual

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.

Reimplemented in MailCommon::FilterActionWithStringList.

Definition at line 37 of file filteractionwithstring.cpp.

argsAsString()

QString FilterActionWithString::argsAsString ( ) const

nodiscardoverridevirtual

Return extra arguments as string.

Must not contain newlines.

Implements MailCommon::FilterAction.

Definition at line 57 of file filteractionwithstring.cpp.

argsFromString()

void FilterActionWithString::argsFromString ( const QString & argsStr )

overridevirtual

Read extra arguments from given string.

Implements MailCommon::FilterAction.

Reimplemented in MailCommon::FilterActionWithStringList.

Definition at line 52 of file filteractionwithstring.cpp.

clearParamWidget()

void FilterActionWithString::clearParamWidget ( QWidget * paramWidget ) const

overridevirtual

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

Reimplemented from MailCommon::FilterAction.

Reimplemented in MailCommon::FilterActionWithStringList.

Definition at line 47 of file filteractionwithstring.cpp.

createParamWidget()

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

nodiscardoverridevirtual

Creates a widget for setting the filter action parameter.

Also sets the value of the widget.

Reimplemented from MailCommon::FilterAction.

Reimplemented in MailCommon::FilterActionWithStringList.

Definition at line 24 of file filteractionwithstring.cpp.

displayString()

QString FilterActionWithString::displayString ( ) const

nodiscardoverridevirtual

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

in the filter log.

Implements MailCommon::FilterAction.

Definition at line 62 of file filteractionwithstring.cpp.

isEmpty()

bool FilterActionWithString::isEmpty ( ) const

nodiscardoverridevirtual

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 19 of file filteractionwithstring.cpp.

setParamWidgetValue()

void FilterActionWithString::setParamWidgetValue ( QWidget * paramWidget ) const

overridevirtual

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

Reimplemented from MailCommon::FilterAction.

Reimplemented in MailCommon::FilterActionWithStringList.

Definition at line 42 of file filteractionwithstring.cpp.

Member Data Documentation

mParameter

QString MailCommon::FilterActionWithString::mParameter

protected

Definition at line 78 of file filteractionwithstring.h.

---

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

• filteractionwithstring.h
• filteractionwithstring.cpp