libempathy/empathy-contact.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*
   3  * Copyright (C) 2004 Imendio AB
   4  * Copyright (C) 2007-2008 Collabora Ltd.
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License as
   8  * published by the Free Software Foundation; either version 2 of the
   9  * License, or (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public
  17  * License along with this program; if not, write to the
  18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19  * Boston, MA 02111-1307, USA.
  20  *
  21  * Authors: Mikael Hallendal <micke@imendio.com>
  22  *          Martyn Russell <martyn@imendio.com>
  23  *          Xavier Claessens <xclaesse@gmail.com>
  24  */
  25
  26 #ifndef __EMPATHY_CONTACT_H__
  27 #define __EMPATHY_CONTACT_H__
  28
  29 #include <glib-object.h>
  30
  31 #include <libmissioncontrol/mc-account.h>
  32 #include <libmissioncontrol/mission-control.h>
  33
  34 #include "empathy-avatar.h"
  35
  36 G_BEGIN_DECLS
  37
  38 #define EMPATHY_TYPE_CONTACT         (empathy_contact_get_type ())
  39 #define EMPATHY_CONTACT(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), EMPATHY_TYPE_CONTACT, EmpathyContact))
  40 #define EMPATHY_CONTACT_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST ((k), EMPATHY_TYPE_CONTACT, EmpathyContactClass))
  41 #define EMPATHY_IS_CONTACT(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), EMPATHY_TYPE_CONTACT))
  42 #define EMPATHY_IS_CONTACT_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), EMPATHY_TYPE_CONTACT))
  43 #define EMPATHY_CONTACT_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), EMPATHY_TYPE_CONTACT, EmpathyContactClass))
  44
  45 typedef struct _EmpathyContact      EmpathyContact;
  46 typedef struct _EmpathyContactClass EmpathyContactClass;
  47
  48 struct _EmpathyContact {
  49         GObject parent;
  50         gpointer priv;
  51 };
  52
  53 struct _EmpathyContactClass {
  54         GObjectClass parent_class;
  55 };
  56
  57 typedef enum {
  58         EMPATHY_CAPABILITIES_NONE = 0,
  59         EMPATHY_CAPABILITIES_AUDIO = 1 << 0,
  60         EMPATHY_CAPABILITIES_VIDEO = 1 << 1,
  61         EMPATHY_CAPABILITIES_UNKNOWN = 1 << 7
  62 } EmpathyCapabilities;
  63
  64 typedef enum {
  65         EMPATHY_CONTACT_READY_NONE = 0,
  66         EMPATHY_CONTACT_READY_ID = 1 << 0,
  67         EMPATHY_CONTACT_READY_HANDLE = 1 << 1,
  68         EMPATHY_CONTACT_READY_NAME = 1 << 2,
  69         EMPATHY_CONTACT_READY_ALL = (1 << 3) - 1,
  70 } EmpathyContactReady;
  71
  72 GType               empathy_contact_get_type           (void) G_GNUC_CONST;
  73 EmpathyContact *    empathy_contact_new                (McAccount           *account);
  74 EmpathyContact *    empathy_contact_new_full           (McAccount           *account,
  75                                                         const gchar         *id,
  76                                                         const gchar         *name);
  77 const gchar *       empathy_contact_get_id             (EmpathyContact      *contact);
  78 void                empathy_contact_set_id             (EmpathyContact      *contact,
  79                                                         const gchar         *id);
  80 const gchar *       empathy_contact_get_name           (EmpathyContact      *contact);
  81 void                empathy_contact_set_name           (EmpathyContact      *contact,
  82                                                         const gchar         *name);
  83 EmpathyAvatar *     empathy_contact_get_avatar         (EmpathyContact      *contact);
  84 void                empathy_contact_set_avatar         (EmpathyContact      *contact,
  85                                                         EmpathyAvatar       *avatar);
  86 McAccount *         empathy_contact_get_account        (EmpathyContact      *contact);
  87 void                empathy_contact_set_account        (EmpathyContact      *contact,
  88                                                         McAccount           *account);
  89 McPresence          empathy_contact_get_presence       (EmpathyContact      *contact);
  90 void                empathy_contact_set_presence       (EmpathyContact      *contact,
  91                                                         McPresence           presence);
  92 const gchar *       empathy_contact_get_presence_message (EmpathyContact    *contact);
  93 void                empathy_contact_set_presence_message (EmpathyContact    *contact,
  94                                                         const gchar         *message);
  95 guint               empathy_contact_get_handle         (EmpathyContact      *contact);
  96 void                empathy_contact_set_handle         (EmpathyContact      *contact,
  97                                                         guint                handle);
  98 EmpathyCapabilities empathy_contact_get_capabilities   (EmpathyContact      *contact);
  99 void                empathy_contact_set_capabilities   (EmpathyContact      *contact,
 100                                                         EmpathyCapabilities  capabilities);
 101 EmpathyContactReady empathy_contact_get_ready          (EmpathyContact      *contact);
 102 gboolean            empathy_contact_is_user            (EmpathyContact      *contact);
 103 void                empathy_contact_set_is_user        (EmpathyContact      *contact,
 104                                                         gboolean             is_user);
 105 gboolean            empathy_contact_is_online          (EmpathyContact      *contact);
 106 const gchar *       empathy_contact_get_status         (EmpathyContact      *contact);
 107 gboolean            empathy_contact_can_voip           (EmpathyContact      *contact);
 108 gboolean            empathy_contact_equal              (gconstpointer        v1,
 109                                                         gconstpointer        v2);
 110 guint               empathy_contact_hash               (gconstpointer        key);
 111 void                empathy_contact_run_until_ready    (EmpathyContact      *contact,
 112                                                         EmpathyContactReady  ready,
 113                                                         GMainLoop          **loop);
 114
 115 G_END_DECLS
 116
 117 #endif /* __EMPATHY_CONTACT_H__ */
 118