2006-06-06 02:14:42 -05:00
|
|
|
<!-- ##### SECTION Title ##### -->
|
|
|
|
NotifyNotification
|
|
|
|
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
2006-06-06 03:29:32 -05:00
|
|
|
A passive pop-up notification.
|
2006-06-06 02:14:42 -05:00
|
|
|
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
|
|
<para>
|
2006-06-06 03:29:32 -05:00
|
|
|
#NotifyNotification represents a passive pop-up notification. It can
|
|
|
|
contain summary text, body text, and an icon, as well as hints specifying
|
|
|
|
how the notification should be presented. The notification is rendered
|
|
|
|
by a notification daemon, and may present the notification in any number
|
|
|
|
of ways. As such, there is a clear separation of content and presentation,
|
|
|
|
and this API enforces that.
|
2006-06-06 02:14:42 -05:00
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### SECTION Stability_Level ##### -->
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO NOTIFY_EXPIRES_DEFAULT ##### -->
|
|
|
|
<para>
|
2006-06-06 03:29:32 -05:00
|
|
|
The default expiration time on a notification.
|
2006-06-06 02:14:42 -05:00
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO NOTIFY_EXPIRES_NEVER ##### -->
|
|
|
|
<para>
|
2006-06-06 03:29:32 -05:00
|
|
|
The notification never expires. It stays open until closed by the calling API
|
|
|
|
or the user.
|
2006-06-06 02:14:42 -05:00
|
|
|
</para>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### STRUCT NotifyNotification ##### -->
|
|
|
|
<para>
|
2006-06-06 03:29:32 -05:00
|
|
|
This is an opaque structure representing a notification. This should
|
|
|
|
not be used directly. Use the accessor functions below.
|
2006-06-06 02:14:42 -05:00
|
|
|
</para>
|
|
|
|
|
2006-06-06 14:45:19 -05:00
|
|
|
|
|
|
|
<!-- ##### SIGNAL NotifyNotification::closed ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@notifynotification: the object which received the signal.
|
|
|
|
|
|
|
|
<!-- ##### ARG NotifyNotification:attach-widget ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### ARG NotifyNotification:body ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### ARG NotifyNotification:icon-name ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2007-02-15 02:54:39 -06:00
|
|
|
<!-- ##### ARG NotifyNotification:status-icon ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
2006-06-06 14:45:19 -05:00
|
|
|
<!-- ##### ARG NotifyNotification:summary ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
2006-06-06 02:14:42 -05:00
|
|
|
|
|
|
|
<!-- ##### ENUM NotifyUrgency ##### -->
|
|
|
|
<para>
|
2006-06-06 03:29:32 -05:00
|
|
|
The urgency level of the notification.
|
2006-06-06 02:14:42 -05:00
|
|
|
</para>
|
|
|
|
|
|
|
|
@NOTIFY_URGENCY_LOW:
|
2006-06-06 03:29:32 -05:00
|
|
|
Low urgency. Used for unimportant notifications.
|
2006-06-06 02:14:42 -05:00
|
|
|
@NOTIFY_URGENCY_NORMAL:
|
2006-06-06 03:29:32 -05:00
|
|
|
Normal urgency. Used for most standard notifications.
|
2006-06-06 02:14:42 -05:00
|
|
|
@NOTIFY_URGENCY_CRITICAL:
|
2006-06-06 03:29:32 -05:00
|
|
|
Critical urgency. Used for very important notifications.
|
2006-06-06 02:14:42 -05:00
|
|
|
|
|
|
|
<!-- ##### USER_FUNCTION NotifyActionCallback ##### -->
|
|
|
|
<para>
|
2006-06-06 03:29:32 -05:00
|
|
|
An action callback function.
|
2006-06-06 02:14:42 -05:00
|
|
|
</para>
|
|
|
|
|
2006-06-06 03:29:32 -05:00
|
|
|
@Param1: The notification.
|
|
|
|
@Param2: The action ID.
|
|
|
|
@Param3: User data.
|
2006-06-06 02:14:42 -05:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### MACRO NOTIFY_ACTION_CALLBACK ##### -->
|
|
|
|
<para>
|
2006-06-06 03:29:32 -05:00
|
|
|
A convenience macro for casting a function to a #NotifyActionCallback. This
|
2006-06-06 04:17:21 -05:00
|
|
|
is much like G_CALLBACK().
|
2006-06-06 02:14:42 -05:00
|
|
|
</para>
|
|
|
|
|
2006-06-06 03:29:32 -05:00
|
|
|
@func: The function to cast.
|
2006-06-06 02:14:42 -05:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION notify_notification_new ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@summary:
|
|
|
|
@body:
|
|
|
|
@icon:
|
|
|
|
@attach:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION notify_notification_new_with_status_icon ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@summary:
|
|
|
|
@body:
|
|
|
|
@icon:
|
|
|
|
@status_icon:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION notify_notification_update ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@notification:
|
|
|
|
@summary:
|
|
|
|
@body:
|
|
|
|
@icon:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION notify_notification_attach_to_widget ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@notification:
|
|
|
|
@attach:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION notify_notification_attach_to_status_icon ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@notification:
|
|
|
|
@status_icon:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION notify_notification_set_geometry_hints ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@notification:
|
|
|
|
@screen:
|
2006-06-06 02:28:21 -05:00
|
|
|
@x:
|
|
|
|
@y:
|
2006-06-06 02:14:42 -05:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION notify_notification_show ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@notification:
|
|
|
|
@error:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION notify_notification_set_timeout ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@notification:
|
|
|
|
@timeout:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION notify_notification_set_category ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@notification:
|
|
|
|
@category:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION notify_notification_set_urgency ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@notification:
|
2006-06-06 03:29:32 -05:00
|
|
|
@urgency:
|
2006-06-06 02:14:42 -05:00
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION notify_notification_set_icon_from_pixbuf ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@notification:
|
|
|
|
@icon:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION notify_notification_set_hint_int32 ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@notification:
|
|
|
|
@key:
|
|
|
|
@value:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION notify_notification_set_hint_double ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@notification:
|
|
|
|
@key:
|
|
|
|
@value:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION notify_notification_set_hint_string ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@notification:
|
|
|
|
@key:
|
|
|
|
@value:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION notify_notification_set_hint_byte ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@notification:
|
|
|
|
@key:
|
|
|
|
@value:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION notify_notification_set_hint_byte_array ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@notification:
|
|
|
|
@key:
|
|
|
|
@value:
|
|
|
|
@len:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION notify_notification_clear_hints ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@notification:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION notify_notification_add_action ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@notification:
|
|
|
|
@action:
|
|
|
|
@label:
|
|
|
|
@callback:
|
|
|
|
@user_data:
|
|
|
|
@free_func:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION notify_notification_clear_actions ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@notification:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION notify_notification_close ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@notification:
|
|
|
|
@error:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|