notification.h File Reference

Notification object. More...

#include <glib.h>
#include <glib-object.h>
#include <gtk/gtk.h>

Go to the source code of this file.

Data Structures
struct	_NotifyNotification
struct	_NotifyNotificationClass
Defines
#define	NOTIFY_EXPIRES_DEFAULT   -1
#define	NOTIFY_EXPIRES_NEVER   0
#define	NOTIFY_TYPE_NOTIFICATION   (notify_notification_get_type ())
#define	NOTIFY_NOTIFICATION(o)
#define	NOTIFY_NOTIFICATION_CLASS(k)
#define	NOTIFY_IS_NOTIFICATION(o)   (G_TYPE_CHECK_INSTANCE_TYPE ((o), NOTIFY_TYPE_NOTIFICATION))
#define	NOTIFY_IS_NOTIFICATION_CLASS(k)   (G_TYPE_CHECK_CLASS_TYPE ((k), NOTIFY_TYPE_NOTIFICATION))
#define	NOTIFY_NOTIFICATION_GET_CLASS(o)
#define	NOTIFY_ACTION_CALLBACK(func)   ((NotifyActionCallback)(func))
Typedefs
typedef _NotifyNotification	NotifyNotification
typedef _NotifyNotificationClass	NotifyNotificationClass
typedef _NotifyNotificationPrivate	NotifyNotificationPrivate
typedef void(*	NotifyActionCallback )(NotifyNotification *, gchar *, gpointer)
Enumerations
enum	NotifyUrgency { NOTIFY_URGENCY_LOW, NOTIFY_URGENCY_NORMAL, NOTIFY_URGENCY_CRITICAL }
	Notification urgency levels. More...
Functions
GType	notify_notification_get_type ()
NotifyNotification *	notify_notification_new (const gchar *summary, const gchar *message, const gchar *icon, GtkWidget *attach)
gboolean	notify_notification_update (NotifyNotification *notification, const gchar *summary, const gchar *message, const gchar *icon)
void	notify_notification_attach_to_widget (NotifyNotification *notification, GtkWidget *attach)
gboolean	notify_notification_show (NotifyNotification *notification, GError **error)
void	notify_notification_set_timeout (NotifyNotification *notification, gint timeout)
void	notify_notification_set_category (NotifyNotification *notification, const char *category)
void	notify_notification_set_urgency (NotifyNotification *notification, NotifyUrgency l)
void	notify_notification_set_icon_from_pixbuf (NotifyNotification *notification, GdkPixbuf *icon)
void	notify_notification_set_hint_int32 (NotifyNotification *notification, const gchar *key, gint value)
void	notify_notification_set_hint_double (NotifyNotification *notification, const gchar *key, gdouble value)
void	notify_notification_set_hint_string (NotifyNotification *notification, const gchar *key, const gchar *value)
void	notify_notification_set_hint_byte (NotifyNotification *notification, const gchar *key, guchar value)
void	notify_notification_set_hint_byte_array (NotifyNotification *notification, const gchar *key, const guchar *value, gsize len)
void	notify_notification_clear_hints (NotifyNotification *notification)
void	notify_notification_add_action (NotifyNotification *notification, const char *action, const char *label, NotifyActionCallback callback, gpointer user_data, GFreeFunc free_func)
void	notify_notification_clear_actions (NotifyNotification *notification)
gboolean	notify_notification_close (NotifyNotification *notification, GError **error)

---

Detailed Description

Notification object.

Copyright:

(C) 2006 Christian Hammond

Copyright:

(C) 2006 John Palmieri

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

Definition in file notification.h.

---

Define Documentation

#define NOTIFY_ACTION_CALLBACK (  func   )     ((NotifyActionCallback)(func))

Definition at line 81 of file notification.h.

#define NOTIFY_EXPIRES_DEFAULT   -1

Definition at line 31 of file notification.h.

#define NOTIFY_EXPIRES_NEVER   0

Definition at line 32 of file notification.h.

#define NOTIFY_IS_NOTIFICATION (  o   )     (G_TYPE_CHECK_INSTANCE_TYPE ((o), NOTIFY_TYPE_NOTIFICATION))

Definition at line 41 of file notification.h.

#define NOTIFY_IS_NOTIFICATION_CLASS (  k   )     (G_TYPE_CHECK_CLASS_TYPE ((k), NOTIFY_TYPE_NOTIFICATION))

Definition at line 43 of file notification.h.

#define NOTIFY_NOTIFICATION (  o   )

Value: (G_TYPE_CHECK_INSTANCE_CAST ((o), NOTIFY_TYPE_NOTIFICATION, \ NotifyNotification)) Definition at line 35 of file notification.h.

#define NOTIFY_NOTIFICATION_CLASS (  k   )

Value: (G_TYPE_CHECK_CLASS_CAST((k), NOTIFY_TYPE_NOTIFICATION, \ NotifyNotificationClass)) Definition at line 38 of file notification.h.

#define NOTIFY_NOTIFICATION_GET_CLASS (  o   )

Value: (G_TYPE_INSTANCE_GET_CLASS ((o), NOTIFY_TYPE_NOTIFICATION, \ NotifyNotificationClass)) Definition at line 45 of file notification.h.

#define NOTIFY_TYPE_NOTIFICATION   (notify_notification_get_type ())

Definition at line 34 of file notification.h.

---

Typedef Documentation

typedef void(* NotifyActionCallback)(NotifyNotification *, gchar *, gpointer)

Definition at line 79 of file notification.h.

typedef struct _NotifyNotification NotifyNotification

Definition at line 50 of file notification.h.

typedef struct _NotifyNotificationClass NotifyNotificationClass

Definition at line 51 of file notification.h.

typedef struct _NotifyNotificationPrivate NotifyNotificationPrivate

Definition at line 52 of file notification.h.

---

Enumeration Type Documentation

enum NotifyUrgency

Notification urgency levels. Enumerator: NOTIFY_URGENCY_LOW  Low urgency. NOTIFY_URGENCY_NORMAL  Normal urgency. NOTIFY_URGENCY_CRITICAL  Critical urgency. Definition at line 71 of file notification.h.

---

Function Documentation

void notify_notification_add_action (  NotifyNotification *  notification, const char *  action, const char *  label, NotifyActionCallback  callback, gpointer  user_data, GFreeFunc  free_func )

void notify_notification_attach_to_widget (  NotifyNotification *  notification, GtkWidget *  attach )

void notify_notification_clear_actions (  NotifyNotification *  notification  )

void notify_notification_clear_hints (  NotifyNotification *  notification  )

gboolean notify_notification_close (  NotifyNotification *  notification, GError **  error )

GType notify_notification_get_type (   )

NotifyNotification* notify_notification_new (  const gchar *  summary, const gchar *  message, const gchar *  icon, GtkWidget *  attach )

void notify_notification_set_category (  NotifyNotification *  notification, const char *  category )

void notify_notification_set_hint_byte (  NotifyNotification *  notification, const gchar *  key, guchar  value )

void notify_notification_set_hint_byte_array (  NotifyNotification *  notification, const gchar *  key, const guchar *  value, gsize  len )

void notify_notification_set_hint_double (  NotifyNotification *  notification, const gchar *  key, gdouble  value )

void notify_notification_set_hint_int32 (  NotifyNotification *  notification, const gchar *  key, gint  value )

void notify_notification_set_hint_string (  NotifyNotification *  notification, const gchar *  key, const gchar *  value )

void notify_notification_set_icon_from_pixbuf (  NotifyNotification *  notification, GdkPixbuf *  icon )

void notify_notification_set_timeout (  NotifyNotification *  notification, gint  timeout )

void notify_notification_set_urgency (  NotifyNotification *  notification, NotifyUrgency  l )

gboolean notify_notification_show (  NotifyNotification *  notification, GError **  error )

gboolean notify_notification_update (  NotifyNotification *  notification, const gchar *  summary, const gchar *  message, const gchar *  icon )

---