Qt Utilities
5.7.1
Common Qt related C++ classes and routines used by my applications such as dialogs, widgets and models
|
The DBusNotification class emits D-Bus notifications. More...
#include <dbusnotification.h>
Public Slots | |
bool | show () |
Shows the notification. More... | |
bool | show (const QString &message) |
Updates the message and shows/updates the notification. More... | |
bool | update (const QString &line) |
Updates the message and shows/updates the notification. More... | |
void | hide () |
Hides the notification (if still visible). More... | |
Signals | |
void | shown () |
Emitted when the notification could be shown successful. More... | |
void | error () |
Emitted when the notification couldn't be shown. More... | |
void | closed (NotificationCloseReason reason) |
Emitted when the notification has been closed. More... | |
void | actionInvoked (const QString &action) |
Emitted when action has been invoked. More... | |
Public Member Functions | |
DBusNotification (const QString &title, NotificationIcon icon=NotificationIcon::Information, int timeout=10000, QObject *parent=nullptr) | |
Creates a new notification (which is not shown instantly). More... | |
DBusNotification (const QString &title, const QString &icon, int timeout=10000, QObject *parent=nullptr) | |
Creates a new notification (which is not shown instantly). More... | |
~DBusNotification () | |
Closes the notification if still shown and delete the object. More... | |
const QString & | title () const |
void | setTitle (const QString &title) |
const QString & | message () const |
void | setMessage (const QString &message) |
Sets the message to be shown. More... | |
const QString & | icon () const |
void | setIcon (const QString &icon) |
Sets the icon name. More... | |
void | setIcon (NotificationIcon icon) |
Sets the icon to one of the pre-defined notification icons. More... | |
int | timeout () const |
void | setTimeout (int timeout) |
Sets the number of milliseconds the notification will be visible after calling show(). More... | |
const QStringList & | actions () const |
void | setActions (const QStringList &actions) |
Sets the list of available actions. More... | |
const QVariantMap & | hints () const |
QVariantMap & | hints () |
bool | isVisible () const |
Returns whether the notification is (still) visible. More... | |
void | deleteOnCloseOrError () |
Makes the notification object delete itself when the notification has been closed or an error occured. More... | |
Static Public Member Functions | |
static bool | isAvailable () |
Returns whether the notification D-Bus daemon is running. More... | |
Properties | |
QString | title |
QString | message |
Returns the assigned message. More... | |
QString | icon |
Returns the icon name. More... | |
int | timeout |
Returns the number of milliseconds the notification will be visible after calling show(). More... | |
QStringList | actions |
Returns the assigned actions. More... | |
bool | visible |
The DBusNotification class emits D-Bus notifications.
D-Bus notifications are only available if the library has been compiled with support for it by specifying CMake option DBUS_NOTIFICATIONS
. If support is available, the macro QT_UTILITIES_SUPPORT_DBUS_NOTIFICATIONS
is defined.
Usage
First create a new instance. The constructor allows to set basic parameters. To set more parameters, use setter methods. Call show() to actually show the notification. This method can also be used to update the currently shown notification (it will not be updated automatically by just using the setter methods).
Definition at line 19 of file dbusnotification.h.
|
explicit |
Creates a new notification (which is not shown instantly).
Definition at line 44 of file dbusnotification.cpp.
|
explicit |
Creates a new notification (which is not shown instantly).
Definition at line 58 of file dbusnotification.cpp.
MiscUtils::DBusNotification::~DBusNotification | ( | ) |
Closes the notification if still shown and delete the object.
Definition at line 85 of file dbusnotification.cpp.
|
signal |
Emitted when action has been invoked.
const QStringList& MiscUtils::DBusNotification::actions | ( | ) | const |
|
signal |
Emitted when the notification has been closed.
void MiscUtils::DBusNotification::deleteOnCloseOrError | ( | ) |
Makes the notification object delete itself when the notification has been closed or an error occured.
Definition at line 126 of file dbusnotification.cpp.
|
signal |
Emitted when the notification couldn't be shown.
|
slot |
Hides the notification (if still visible).
Definition at line 197 of file dbusnotification.cpp.
|
inline |
Definition at line 147 of file dbusnotification.h.
|
inline |
Definition at line 152 of file dbusnotification.h.
const QString& MiscUtils::DBusNotification::icon | ( | ) | const |
|
static |
Returns whether the notification D-Bus daemon is running.
Definition at line 97 of file dbusnotification.cpp.
|
inline |
Returns whether the notification is (still) visible.
Definition at line 157 of file dbusnotification.h.
const QString& MiscUtils::DBusNotification::message | ( | ) | const |
|
inline |
Sets the list of available actions.
QStringList({QStringLiteral("first_id"), tr("First action"), QStringLiteral("second_id"), tr("Second action"), ...})
Definition at line 142 of file dbusnotification.h.
|
inline |
Sets the icon name.
Definition at line 122 of file dbusnotification.h.
void MiscUtils::DBusNotification::setIcon | ( | NotificationIcon | icon | ) |
Sets the icon to one of the pre-defined notification icons.
Definition at line 106 of file dbusnotification.cpp.
|
inline |
|
inline |
Sets the number of milliseconds the notification will be visible after calling show().
Definition at line 132 of file dbusnotification.h.
|
inline |
Definition at line 91 of file dbusnotification.h.
|
slot |
Shows the notification.
Definition at line 139 of file dbusnotification.cpp.
|
slot |
Updates the message and shows/updates the notification.
Definition at line 160 of file dbusnotification.cpp.
|
signal |
Emitted when the notification could be shown successful.
int MiscUtils::DBusNotification::timeout | ( | ) | const |
const QString& MiscUtils::DBusNotification::title | ( | ) | const |
|
slot |
Updates the message and shows/updates the notification.
Definition at line 178 of file dbusnotification.cpp.
|
inlinereadwrite |
Returns the assigned actions.
Definition at line 25 of file dbusnotification.h.
|
inlinereadwrite |
Returns the icon name.
Definition at line 23 of file dbusnotification.h.
|
inlinereadwrite |
Returns the assigned message.
Definition at line 22 of file dbusnotification.h.
|
inlinereadwrite |
Returns the number of milliseconds the notification will be visible after calling show().
Definition at line 24 of file dbusnotification.h.
|
inlinereadwrite |
Definition at line 21 of file dbusnotification.h.
|
read |
Definition at line 26 of file dbusnotification.h.