CdosNotifyActionCallback ()

void
(*CdosNotifyActionCallback) (CdosNotifyNotification *notification,
                             char *action,
                             gpointer user_data);

An action callback function.

CDOS_NOTIFY_ACTION_CALLBACK()

#define CDOS_NOTIFY_ACTION_CALLBACK(func) ((CdosNotifyActionCallback)(func))

A convenience macro for casting a function to a CdosNotifyActionCallback. This is much like G_CALLBACK().

cdos_notify_notification_new ()

CdosNotifyNotification *
cdos_notify_notification_new (const char *summary,
                              const char *body,
                              const char *icon);

Creates a new CdosNotifyNotification. The summary text is required, but all other parameters are optional.

cdos_notify_notification_update ()

gboolean
cdos_notify_notification_update (CdosNotifyNotification *notification,
                                 const char *summary,
                                 const char *body,
                                 const char *icon);

Updates the notification text and icon. This won't send the update out and display it on the screen. For that, you will need to call cdos_notify_notification_show().

cdos_notify_notification_show ()

gboolean
cdos_notify_notification_show (CdosNotifyNotification *notification,
                               GError **error);

Tells the notification server to display the notification on the screen.

cdos_notify_notification_set_timeout ()

void
cdos_notify_notification_set_timeout (CdosNotifyNotification *notification,
                                      gint timeout);

Sets the timeout of the notification. To set the default time, pass CDOS_NOTIFY_EXPIRES_DEFAULT as timeout . To set the notification to never expire, pass CDOS_NOTIFY_EXPIRES_NEVER.

Note that the timeout may be ignored by the server.

cdos_notify_notification_set_category ()

void
cdos_notify_notification_set_category (CdosNotifyNotification *notification,
                                       const char *category);

Sets the category of this notification. This can be used by the notification server to filter or display the data in a certain way.

cdos_notify_notification_set_urgency ()

void
cdos_notify_notification_set_urgency (CdosNotifyNotification *notification,
                                      CdosNotifyUrgency urgency);

Sets the urgency level of this notification.

See: CdosNotifyUrgency

cdos_notify_notification_set_image_from_pixbuf ()

void
cdos_notify_notification_set_image_from_pixbuf
                               (CdosNotifyNotification *notification,
                                GdkPixbuf *pixbuf);

Sets the image in the notification from a GdkPixbuf.

cdos_notify_notification_set_icon_from_pixbuf ()

void
cdos_notify_notification_set_icon_from_pixbuf
                               (CdosNotifyNotification *notification,
                                GdkPixbuf *icon);

Sets the icon in the notification from a GdkPixbuf.

cdos_notify_notification_set_hint_int32 ()

void
cdos_notify_notification_set_hint_int32
                               (CdosNotifyNotification *notification,
                                const char *key,
                                gint value);

Sets a hint with a 32-bit integer value.

cdos_notify_notification_set_hint_uint32 ()

void
cdos_notify_notification_set_hint_uint32
                               (CdosNotifyNotification *notification,
                                const char *key,
                                guint value);

Sets a hint with an unsigned 32-bit integer value.

cdos_notify_notification_set_hint_double ()

void
cdos_notify_notification_set_hint_double
                               (CdosNotifyNotification *notification,
                                const char *key,
                                gdouble value);

Sets a hint with a double value.

cdos_notify_notification_set_hint_string ()

void
cdos_notify_notification_set_hint_string
                               (CdosNotifyNotification *notification,
                                const char *key,
                                const char *value);

Sets a hint with a string value.

cdos_notify_notification_set_hint_byte ()

void
cdos_notify_notification_set_hint_byte
                               (CdosNotifyNotification *notification,
                                const char *key,
                                guchar value);

Sets a hint with a byte value.

cdos_notify_notification_set_hint_byte_array ()

void
cdos_notify_notification_set_hint_byte_array
                               (CdosNotifyNotification *notification,
                                const char *key,
                                const guchar *value,
                                gsize len);

Sets a hint with a byte array value. The length of value must be passed as len .

cdos_notify_notification_set_hint ()

void
cdos_notify_notification_set_hint (CdosNotifyNotification *notification,
                                   const char *key,
                                   GVariant *value);

Sets a hint for key with value value . If value is NULL, a previously set hint for key is unset.

If value is floating, it is consumed.

Since: 0.6

cdos_notify_notification_set_app_name ()

void
cdos_notify_notification_set_app_name (CdosNotifyNotification *notification,
                                       const char *app_name);

Sets the application name for the notification. If this function is not called or if app_name is NULL, the application name will be set from the value used in cdos_notify_init() or overridden with cdos_notify_set_app_name().

Since: 0.7.3

cdos_notify_notification_clear_hints ()

void
cdos_notify_notification_clear_hints (CdosNotifyNotification *notification);

Clears all hints from the notification.

cdos_notify_notification_add_action ()

void
cdos_notify_notification_add_action (CdosNotifyNotification *notification,
                                     const char *action,
                                     const char *label,
                                     CdosNotifyActionCallback callback,
                                     gpointer user_data,
                                     GFreeFunc free_func);

Adds an action to a notification. When the action is invoked, the specified callback function will be called, along with the value passed to user_data .

cdos_notify_notification_clear_actions ()

void
cdos_notify_notification_clear_actions
                               (CdosNotifyNotification *notification);

Clears all actions from the notification.

cdos_notify_notification_close ()

gboolean
cdos_notify_notification_close (CdosNotifyNotification *notification,
                                GError **error);

Synchronously tells the notification server to hide the notification on the screen.

cdos_notify_notification_get_closed_reason ()

gint
cdos_notify_notification_get_closed_reason
                               (const CdosNotifyNotification *notification);

Returns the closed reason code for the notification. This is valid only after the "closed" signal is emitted.

CDOS_NOTIFY_EXPIRES_DEFAULT

#define CDOS_NOTIFY_EXPIRES_DEFAULT -1

The default expiration time on a notification.

CDOS_NOTIFY_EXPIRES_NEVER

#define CDOS_NOTIFY_EXPIRES_NEVER    0

The notification never expires. It stays open until closed by the calling API or the user.

CDOS_NOTIFY_TYPE_NOTIFICATION

#define CDOS_NOTIFY_TYPE_NOTIFICATION         (cdos_notify_notification_get_type ())

enum CdosNotifyUrgency

The urgency level of the notification.

The “app-name” property

  “app-name”                 gchar *

The application name to use for this notification.

Flags: Read / Write

Default value: NULL

The “body” property

  “body”                     gchar *

The message body text.

Flags: Read / Write / Construct

Default value: NULL

The “closed-reason” property

  “closed-reason”            gint

The reason code for why the notification was closed.

Flags: Read

Allowed values: >= -1

Default value: -1

The “icon-name” property

  “icon-name”                gchar *

The icon filename or icon theme-compliant name.

Flags: Read / Write / Construct

Default value: NULL

The “id” property

  “id”                       gint

The notification ID.

Flags: Read / Write / Construct

Allowed values: >= 0

Default value: 0

The “summary” property

  “summary”                  gchar *

The summary text.

Flags: Read / Write / Construct

Default value: NULL

The “closed” signal

void
user_function (CdosNotifyNotification *cdosnotifynotification,
               gpointer                user_data)

Flags: Run First