mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-08-09 10:44:04 +02:00
GNotification: finish documentation
Add the missing documentation and add the section to the GIO reference docs. Fix up a few small documentation issues. https://bugzilla.gnome.org/show_bug.cgi?id=688492
This commit is contained in:
@@ -59,6 +59,8 @@ IGNORE_HFILES = \
|
|||||||
gnetworkingprivate.h \
|
gnetworkingprivate.h \
|
||||||
gnetworkmonitorbase.h \
|
gnetworkmonitorbase.h \
|
||||||
gnetworkmonitornetlink.h \
|
gnetworkmonitornetlink.h \
|
||||||
|
gnotificationbackend.h \
|
||||||
|
gnotification-private.h \
|
||||||
gpollfilemonitor.h \
|
gpollfilemonitor.h \
|
||||||
gregistrysettingsbackend.h \
|
gregistrysettingsbackend.h \
|
||||||
gsettingsbackendinternal.h \
|
gsettingsbackendinternal.h \
|
||||||
|
@@ -223,6 +223,7 @@
|
|||||||
<xi:include href="xml/gmenu.xml"/>
|
<xi:include href="xml/gmenu.xml"/>
|
||||||
<xi:include href="xml/gmenuexporter.xml"/>
|
<xi:include href="xml/gmenuexporter.xml"/>
|
||||||
<xi:include href="xml/gdbusmenumodel.xml"/>
|
<xi:include href="xml/gdbusmenumodel.xml"/>
|
||||||
|
<xi:include href="xml/gnotification.xml"/>
|
||||||
</chapter>
|
</chapter>
|
||||||
<chapter id="extending">
|
<chapter id="extending">
|
||||||
<title>Extending GIO</title>
|
<title>Extending GIO</title>
|
||||||
|
@@ -2980,6 +2980,9 @@ g_application_quit
|
|||||||
g_application_activate
|
g_application_activate
|
||||||
g_application_open
|
g_application_open
|
||||||
<SUBSECTION>
|
<SUBSECTION>
|
||||||
|
g_application_send_notification
|
||||||
|
g_application_withdraw_notification
|
||||||
|
<SUBSECTION>
|
||||||
g_application_run
|
g_application_run
|
||||||
g_application_set_default
|
g_application_set_default
|
||||||
g_application_get_default
|
g_application_get_default
|
||||||
@@ -4150,3 +4153,29 @@ G_SUBPROCESS_LAUNCHER
|
|||||||
G_TYPE_SUBPROCESS_LAUNCHER
|
G_TYPE_SUBPROCESS_LAUNCHER
|
||||||
g_subprocess_launcher_get_type
|
g_subprocess_launcher_get_type
|
||||||
</SECTION>
|
</SECTION>
|
||||||
|
|
||||||
|
<SECTION>
|
||||||
|
<FILE>gnotification</FILE>
|
||||||
|
<TITLE>GNotification</TITLE>
|
||||||
|
GNotification
|
||||||
|
g_notification_new
|
||||||
|
<SUBSECTION>
|
||||||
|
g_notification_set_title
|
||||||
|
g_notification_set_body
|
||||||
|
g_notification_set_icon
|
||||||
|
g_notification_set_urgent
|
||||||
|
<SUBSECTION>
|
||||||
|
g_notification_set_default_action
|
||||||
|
g_notification_set_default_action_and_target
|
||||||
|
g_notification_set_default_action_and_target_value
|
||||||
|
<SUBSECTION>
|
||||||
|
g_notification_add_button
|
||||||
|
g_notification_add_button_with_target
|
||||||
|
g_notification_add_button_with_target_value
|
||||||
|
<SUBSECTION Standard>
|
||||||
|
G_IS_NOTIFICATION
|
||||||
|
G_NOTIFICATION
|
||||||
|
G_TYPE_NOTIFICATION
|
||||||
|
G_TYPE_NOTIFICATION_BACKEND
|
||||||
|
g_notification_get_type
|
||||||
|
</SECTION>
|
||||||
|
@@ -62,7 +62,6 @@ typedef struct _GSettings GSettings;
|
|||||||
typedef struct _GPermission GPermission;
|
typedef struct _GPermission GPermission;
|
||||||
|
|
||||||
typedef struct _GMenuModel GMenuModel;
|
typedef struct _GMenuModel GMenuModel;
|
||||||
typedef struct _GNotificationBackend GNotificationBackend;
|
|
||||||
typedef struct _GNotification GNotification;
|
typedef struct _GNotification GNotification;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@@ -26,6 +26,44 @@
|
|||||||
#include "gicon.h"
|
#include "gicon.h"
|
||||||
#include "gaction.h"
|
#include "gaction.h"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* SECTION:gnotification
|
||||||
|
* @short_description: User Notifications (pop up messages)
|
||||||
|
*
|
||||||
|
* #GNotification is a mechanism for creating a notification to be shown
|
||||||
|
* to the user -- typically as a pop-up notification presented by the
|
||||||
|
* desktop environment shell.
|
||||||
|
*
|
||||||
|
* The key difference between #GNotification and other similar APIs is
|
||||||
|
* that, if supported by the desktop environment, notifications sent
|
||||||
|
* with #GNotification will persist after the application has exited,
|
||||||
|
* and even across system reboots.
|
||||||
|
*
|
||||||
|
* Since the user may click on a notification while the application is
|
||||||
|
* not running, applications using #GNotification should be able to be
|
||||||
|
* started as a D-Bus service, using #GApplication.
|
||||||
|
*
|
||||||
|
* 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
|
||||||
|
* through the notification itself, because the object will not exist if
|
||||||
|
* the application is autostarted as a result of a notification being
|
||||||
|
* clicked.
|
||||||
|
*
|
||||||
|
* A notification can be sent with g_application_send_notification().
|
||||||
|
*
|
||||||
|
* Since: 2.40
|
||||||
|
**/
|
||||||
|
|
||||||
|
/**
|
||||||
|
* GNotification:
|
||||||
|
*
|
||||||
|
* This structure type is private and should only be accessed using the
|
||||||
|
* public APIs.
|
||||||
|
*
|
||||||
|
* Since: 2.40
|
||||||
|
**/
|
||||||
|
|
||||||
typedef GObjectClass GNotificationClass;
|
typedef GObjectClass GNotificationClass;
|
||||||
|
|
||||||
struct _GNotification
|
struct _GNotification
|
||||||
@@ -131,7 +169,7 @@ g_notification_new (const gchar *title)
|
|||||||
return notification;
|
return notification;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/*< private >
|
||||||
* g_notification_get_title:
|
* g_notification_get_title:
|
||||||
* @notification: a #GNotification
|
* @notification: a #GNotification
|
||||||
*
|
*
|
||||||
@@ -152,7 +190,7 @@ g_notification_get_title (GNotification *notification)
|
|||||||
/**
|
/**
|
||||||
* g_notification_set_title:
|
* g_notification_set_title:
|
||||||
* @notification: a #GNotification
|
* @notification: a #GNotification
|
||||||
* title: the new title for @notification
|
* @title: the new title for @notification
|
||||||
*
|
*
|
||||||
* Sets the title of @notification to @title.
|
* Sets the title of @notification to @title.
|
||||||
*
|
*
|
||||||
@@ -170,7 +208,7 @@ g_notification_set_title (GNotification *notification,
|
|||||||
notification->title = g_strdup (title);
|
notification->title = g_strdup (title);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/*< private >
|
||||||
* g_notification_get_body:
|
* g_notification_get_body:
|
||||||
* @notification: a #GNotification
|
* @notification: a #GNotification
|
||||||
*
|
*
|
||||||
@@ -209,7 +247,7 @@ g_notification_set_body (GNotification *notification,
|
|||||||
notification->body = g_strdup (body);
|
notification->body = g_strdup (body);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/*< private >
|
||||||
* g_notification_get_icon:
|
* g_notification_get_icon:
|
||||||
* @notification: a #GNotification
|
* @notification: a #GNotification
|
||||||
*
|
*
|
||||||
@@ -248,7 +286,7 @@ g_notification_set_icon (GNotification *notification,
|
|||||||
notification->icon = g_object_ref (icon);
|
notification->icon = g_object_ref (icon);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/*< private >
|
||||||
* g_notification_get_urgent:
|
* g_notification_get_urgent:
|
||||||
* @notification: a #GNotification
|
* @notification: a #GNotification
|
||||||
*
|
*
|
||||||
|
Reference in New Issue
Block a user