libempathy/gossip-presence.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*
   3  * Copyright (C) 2004 Imendio AB
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License as
   7  * published by the Free Software Foundation; either version 2 of the
   8  * License, or (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public
  16  * License along with this program; if not, write to the
  17  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  18  * Boston, MA 02111-1307, USA.
  19  */
  20
  21 #ifndef __GOSSIP_PRESENCE_H__
  22 #define __GOSSIP_PRESENCE_H__
  23
  24 #include <glib-object.h>
  25
  26 G_BEGIN_DECLS
  27
  28 #define GOSSIP_TYPE_PRESENCE         (gossip_presence_get_type ())
  29 #define GOSSIP_PRESENCE(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), GOSSIP_TYPE_PRESENCE, GossipPresence))
  30 #define GOSSIP_PRESENCE_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST ((k), GOSSIP_TYPE_PRESENCE, GossipPresenceClass))
  31 #define GOSSIP_IS_PRESENCE(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), GOSSIP_TYPE_PRESENCE))
  32 #define GOSSIP_IS_PRESENCE_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), GOSSIP_TYPE_PRESENCE))
  33 #define GOSSIP_PRESENCE_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), GOSSIP_TYPE_PRESENCE, GossipPresenceClass))
  34
  35 typedef struct _GossipPresence      GossipPresence;
  36 typedef struct _GossipPresenceClass GossipPresenceClass;
  37
  38 struct _GossipPresence {
  39         GObject parent;
  40 };
  41
  42 struct _GossipPresenceClass {
  43         GObjectClass parent_class;
  44 };
  45
  46 typedef enum {
  47         GOSSIP_PRESENCE_STATE_AVAILABLE,
  48         GOSSIP_PRESENCE_STATE_BUSY,
  49         GOSSIP_PRESENCE_STATE_AWAY,
  50         GOSSIP_PRESENCE_STATE_EXT_AWAY,
  51         GOSSIP_PRESENCE_STATE_HIDDEN,      /* When you appear offline to others */
  52         GOSSIP_PRESENCE_STATE_UNAVAILABLE,
  53 } GossipPresenceState;
  54
  55 GType               gossip_presence_get_type                 (void) G_GNUC_CONST;
  56
  57 GossipPresence *    gossip_presence_new                      (void);
  58 GossipPresence *    gossip_presence_new_full                 (GossipPresenceState  state,
  59                                                               const gchar         *status);
  60
  61 const gchar *       gossip_presence_get_resource             (GossipPresence      *presence);
  62 GossipPresenceState gossip_presence_get_state                (GossipPresence      *presence);
  63 const gchar *       gossip_presence_get_status               (GossipPresence      *presence);
  64 gint                gossip_presence_get_priority             (GossipPresence      *presence);
  65
  66 void                gossip_presence_set_resource             (GossipPresence      *presence,
  67                                                               const gchar         *resource);
  68 void                gossip_presence_set_state                (GossipPresence      *presence,
  69                                                               GossipPresenceState  state);
  70 void                gossip_presence_set_status               (GossipPresence      *presence,
  71                                                               const gchar         *status);
  72 void                gossip_presence_set_priority             (GossipPresence      *presence,
  73                                                               gint                 priority);
  74 gboolean            gossip_presence_resource_equal           (gconstpointer        a,
  75                                                               gconstpointer        b);
  76 gint                gossip_presence_sort_func                (gconstpointer        a,
  77                                                               gconstpointer        b);
  78
  79 const gchar *       gossip_presence_state_get_default_status (GossipPresenceState  state);
  80
  81 G_END_DECLS
  82
  83 #endif /* __GOSSIP_PRESENCE_H__ */
  84