libempathy-gtk/empathy-notify-manager.h

   1 /*
   2  * Copyright (C) 2009 Collabora Ltd.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17  *
  18  * Authors: Guillaume Desmottes <guillaume.desmottes@collabora.co.uk>
  19  */
  20
  21 #ifndef __EMPATHY_NOTIFY_MANAGER_H__
  22 #define __EMPATHY_NOTIFY_MANAGER_H__
  23
  24 #include <libnotify/notification.h>
  25
  26 #include "empathy-contact.h"
  27
  28 G_BEGIN_DECLS
  29
  30 #define EMPATHY_NOTIFY_MANAGER_CAP_ACTIONS             "actions"
  31 #define EMPATHY_NOTIFY_MANAGER_CAP_BODY                "body"
  32 #define EMPATHY_NOTIFY_MANAGER_CAP_BODY_HYPERLINKS     "body-hyperlinks"
  33 #define EMPATHY_NOTIFY_MANAGER_CAP_BODY_IMAGES         "body-images"
  34 #define EMPATHY_NOTIFY_MANAGER_CAP_BODY_MARKUP         "body-markup"
  35 #define EMPATHY_NOTIFY_MANAGER_CAP_CATEGORY            "category"
  36 #define EMPATHY_NOTIFY_MANAGER_CAP_ICON_MULTI          "icon-multi"
  37 #define EMPATHY_NOTIFY_MANAGER_CAP_ICON_STATIC         "icon-static"
  38 #define EMPATHY_NOTIFY_MANAGER_CAP_IMAGE_SVG_XML       "image/svg+xml"
  39 #define EMPATHY_NOTIFY_MANAGER_CAP_SOUND                "sound"
  40 #define EMPATHY_NOTIFY_MANAGER_CAP_DESKTOP_ENTRY       "desktop-entry"
  41 /* notify-osd specific */
  42 #define EMPATHY_NOTIFY_MANAGER_CAP_X_CANONICAL_APPEND              "x-canonical-append"
  43 #define EMPATHY_NOTIFY_MANAGER_CAP_X_CANONICAL_PRIVATE_ICON_ONLY   "x-canonical-private-icon-only"
  44 #define EMPATHY_NOTIFY_MANAGER_CAP_X_CANONICAL_PRIVATE_SYNCHRONOUS "x-canonical-private-synchronous"
  45 #define EMPATHY_NOTIFY_MANAGER_CAP_X_CANONICAL_TRUNCATION          "x-canonical-truncation"
  46
  47 /* Categories associated with EMPATHY_NOTIFY_MANAGER_CAP_CATEGORY.
  48  * Uses x-empathy as prefix for unofficial categories. See
  49  * http://www.galago-project.org/specs/notification/0.9/x211.html */
  50 #define EMPATHY_NOTIFICATION_CATEGORY_CHAT             "im.received"
  51 #define EMPATHY_NOTIFICATION_CATEGORY_PRESENCE_ONLINE  "presence.online"
  52 #define EMPATHY_NOTIFICATION_CATEGORY_PRESENCE_OFFLINE "presence.offline"
  53 /* Yes, these two are the same. */
  54 #define EMPATHY_NOTIFICATION_CATEGORY_VOIP             "x-empathy.call.incoming"
  55 #define EMPATHY_NOTIFICATION_CATEGORY_CALL             "x-empathy.call.incoming"
  56 #define EMPATHY_NOTIFICATION_CATEGORY_TRANSFER         "x-empathy.transfer.incoming"
  57 #define EMPATHY_NOTIFICATION_CATEGORY_INVITATION       "x-empathy.im.room-invitation"
  58 #define EMPATHY_NOTIFICATION_CATEGORY_AUTH             "x-empathy.network.auth-request"
  59 #define EMPATHY_NOTIFICATION_CATEGORY_SUBSCRIPTION     "x-empathy.im.subscription-request"
  60 #define EMPATHY_NOTIFICATION_CATEGORY_MENTIONED        "x-empathy.im.mentioned"
  61
  62 #define EMPATHY_TYPE_NOTIFY_MANAGER         (empathy_notify_manager_get_type ())
  63 #define EMPATHY_NOTIFY_MANAGER(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), EMPATHY_TYPE_NOTIFY_MANAGER, EmpathyNotifyManager))
  64 #define EMPATHY_NOTIFY_MANAGER_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), EMPATHY_TYPE_NOTIFY_MANAGER, EmpathyNotifyManagerClass))
  65 #define EMPATHY_IS_NOTIFY_MANAGER(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), EMPATHY_TYPE_NOTIFY_MANAGER))
  66 #define EMPATHY_IS_NOTIFY_MANAGER_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), EMPATHY_TYPE_NOTIFY_MANAGER))
  67 #define EMPATHY_NOTIFY_MANAGER_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), EMPATHY_TYPE_NOTIFY_MANAGER, EmpathyNotifyManagerClass))
  68
  69 /* FIXME: this should *really* belong to libnotify. */
  70 typedef enum {
  71     EMPATHY_NOTIFICATION_CLOSED_INVALID = 0,
  72     EMPATHY_NOTIFICATION_CLOSED_EXPIRED = 1,
  73     EMPATHY_NOTIFICATION_CLOSED_DISMISSED = 2,
  74     EMPATHY_NOTIFICATION_CLOSED_PROGRAMMATICALY = 3,
  75     EMPATHY_NOTIFICATION_CLOSED_RESERVED = 4
  76 } EmpathyNotificationClosedReason;
  77
  78 typedef struct _EmpathyNotifyManager      EmpathyNotifyManager;
  79 typedef struct _EmpathyNotifyManagerClass EmpathyNotifyManagerClass;
  80
  81 struct _EmpathyNotifyManager
  82 {
  83   GObject parent;
  84   gpointer priv;
  85 };
  86
  87 struct _EmpathyNotifyManagerClass
  88 {
  89  GObjectClass parent_class;
  90 };
  91
  92 GType empathy_notify_manager_get_type (void) G_GNUC_CONST;
  93
  94 /* Get the notify_manager singleton */
  95 EmpathyNotifyManager * empathy_notify_manager_dup_singleton (void);
  96
  97 gboolean empathy_notify_manager_has_capability (EmpathyNotifyManager *self,
  98     const gchar *cap);
  99
 100 gboolean empathy_notify_manager_notification_is_enabled  (
 101     EmpathyNotifyManager *self);
 102
 103 GdkPixbuf * empathy_notify_manager_get_pixbuf_for_notification (
 104     EmpathyNotifyManager *self,
 105     EmpathyContact *contact,
 106     const char *icon_name);
 107
 108 NotifyNotification * empathy_notify_manager_create_notification (
 109     const gchar *summary,
 110     const char *body,
 111     const gchar *icon);
 112
 113 G_END_DECLS
 114
 115 #endif /* __EMPATHY_NOTIFY_MANAGER_H__ */