Merge branch 'Docs' into 'master'

docs: Improved documentation of GNotification

Closes #2405

See merge request GNOME/glib!2102
This commit is contained in:
Philip Withnall 2021-05-17 10:30:55 +00:00
commit 62571c71b5

View File

@ -43,6 +43,29 @@
* not running, applications using #GNotification should be able to be
* started as a D-Bus service, using #GApplication.
*
* In order for #GNotification to work, the application must have installed
* a `.desktop` file. For example:
* |[
* [Desktop Entry]
* Name=Test Application
* Comment=Description of what Test Application does
* Exec=gnome-test-application
* Icon=org.gnome.TestApplication
* Terminal=false
* Type=Application
* Categories=GNOME;GTK;TestApplication Category;
* StartupNotify=true
* DBusActivatable=true
* X-GNOME-UsesNotifications=true
* ]|
*
* The `X-GNOME-UsesNotifications` key indicates to GNOME Control Center
* that this application uses notifications, so it can be listed in the
* Control Centers Notifications panel.
*
* The `.desktop` file must be named as `org.gnome.TestApplication.desktop`,
* where `org.gnome.TestApplication` is the ID passed to g_application_new().
*
* User interaction with a notification (either the default action, or
* buttons) must be associated with actions on the application (ie:
* "app." actions). It is not possible to route user interaction