Martchus
/
qtutilities
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add documentation about D-Bus notification actions

This commit is contained in:
Martchus 2017-08-20 02:03:21 +02:00
parent 53f114b1bd
commit d441590274
1 changed files with 15 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
misc/dbusnotification.h
View File

@ -116,8 +116,7 @@ inline const QString &DBusNotification::icon() const
* \brief Sets the icon name.
* \remarks
* The specified \a icon should be either an URI (file:// is the only URI schema
* supported
* right now) or a name in an icon theme.
* supported right now) or a name in an icon theme.
*/
inline void DBusNotification::setIcon(const QString &icon)
{
@ -134,11 +133,25 @@ inline void DBusNotification::setTimeout(int timeout)
m_timeout = timeout;
}
/*!
* \brief Returns the actions for the notification.
*
* The actions are a list of action IDs and action names. The ID is returned by
* the actionInvoked() signal if an action is triggered. The action name is the
* user-visible name of the notification.
*
* Example: { QStringLiteral("dismiss"), tr("Dismiss notification"),
* QStringLiteral("details"), tr("Show details") }
*/
inline const QStringList &DBusNotification::actions() const
{
return m_actions;
}
/*!
* \brief Sets the actions for the notification.
* \sa see actions() for details and an example
*/
inline void DBusNotification::setActions(const QStringList &actions)
{
m_actions = actions;