KNotificationPlugin

Search for usage in LXR

#include <KNotificationPlugin>

Inheritance diagram for KNotificationPlugin:

Signals

void actionInvoked (int id, int 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, KNotifyConfig *notifyConfig)=0
 
virtual QString optionName ()=0
 
virtual void update (KNotification *notification, KNotifyConfig *config)
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () 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 ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, 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
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 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
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (const QObject *object)
 
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 setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () 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
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Static Protected Member Functions

static QString stripRichText (const QString &s)
 

Additional Inherited Members

- 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)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 

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.

Author
Olivier Goffart <ogoffart at kde.org>

Definition at line 35 of file knotificationplugin.h.

Member Function Documentation

◆ actionInvoked

void KNotificationPlugin::actionInvoked ( int  id,
int  action 
)
signal

emit this signal if one action was invoked

Parameters
idis the id of the notification
actionis 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,
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
notificationis the KNotification object
notifyConfigis 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

◆ update()

void KNotificationPlugin::update ( KNotification notification,
KNotifyConfig config 
)
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:
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu May 26 2022 03:53:59 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.