KNotificationPlugin Class Reference

#include <KNotificationPlugin>

Inheritance diagram for KNotificationPlugin:

Signals
void	actionInvoked (int id, const QString &action)
void	finished (KNotification *notification)
void	replied (int id, const QString &text)
void	xdgActivationTokenReceived (int id, const QString &token)

Public Member Functions
	KNotificationPlugin (QObject *parent=nullptr, const QVariantList &args=QVariantList())
virtual void	close (KNotification *notification)
virtual void	notify (KNotification *notification, const KNotifyConfig &notifyConfig)=0
virtual QString	optionName ()=0
virtual void	update (KNotification *notification, const KNotifyConfig &notifyConfig)
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 Member Functions
void	finish (KNotification *notification)
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)

Static Protected Member Functions
static QString	stripRichText (const QString &s)

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList
Properties inherited from QObject
	objectName
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)

Detailed Description

abstract class for KNotification actions

A KNotificationPlugin is responsible of notification presentation. You can subclass it to have your own presentation of a notification.

You should reimplement the KNotificationPlugin::notify method to display the notification.

Porting from KF5 to KF6:

The signature of the virtual method KNotificationPlugin::notify(KNotification *notification, KNotifyConfig *) was changed to KNotificationPlugin::notify(KNotification *notification, const KNotifyConfig &).

The signature of the virtual method KNotificationPlugin::update(KNotification *notification, KNotifyConfig *) was changed to KNotificationPlugin::update(KNotification *notification, const KNotifyConfig &).

Author

Olivier Goffart <ogoffart at kde.org>

Definition at line 43 of file knotificationplugin.h.

Constructor & Destructor Documentation

KNotificationPlugin()

KNotificationPlugin::KNotificationPlugin	(	QObject *	parent = nullptr,
		const QVariantList &	args = QVariantList() )

Definition at line 13 of file knotificationplugin.cpp.

~KNotificationPlugin()

KNotificationPlugin::~KNotificationPlugin ( )

override

Definition at line 20 of file knotificationplugin.cpp.

Member Function Documentation

actionInvoked

void KNotificationPlugin::actionInvoked ( int id, const QString & action )

signal

emit this signal if one action was invoked

Parameters

id	is the id of the notification
action	is the action number. zero for the default action

close()

void KNotificationPlugin::close ( KNotification * notification )

virtual

This function is called when the notification has been closed.

Definition at line 30 of file knotificationplugin.cpp.

finish()

void KNotificationPlugin::finish ( KNotification * notification )

protected

emit the finished signal you MUST call this function for each call to notify(), even if you do nothing there

call it when the presentation is finished (because the user closed the popup or the sound is finished)

If your presentation is synchronous, you can even call this function from the notify() call itself

Definition at line 35 of file knotificationplugin.cpp.

finished

void KNotificationPlugin::finished ( KNotification * notification )

signal

the presentation is finished.

notify()

virtual void KNotificationPlugin::notify ( KNotification * notification, const KNotifyConfig & notifyConfig )

pure virtual

This function is called when the notification is sent.

(or re-sent) You should implement this function to display a notification

for each call to this function (even for re-notification), you MUST call finish(KNotification*)

Parameters

notification	is the KNotification object
notifyConfig	is the configuration of the notification

optionName()

virtual QString KNotificationPlugin::optionName ( )

pure virtual

return the name of this plugin.

this is the name that should appear in the .notifyrc file, in the field Action=... if a notification is set to use this plugin

stripRichText()

static QString KNotificationPlugin::stripRichText ( const QString & s )

inlinestaticprotected

Definition at line 92 of file knotificationplugin.h.

update()

void KNotificationPlugin::update ( KNotification * notification, const KNotifyConfig & notifyConfig )

virtual

This function is called when the notification has changed (such as the text or the icon)

Definition at line 24 of file knotificationplugin.cpp.

---

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

• knotificationplugin.h
• knotificationplugin.cpp