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 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
  33 #include "empathy-avatar.h"
  34 #include "empathy-presence.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 };
  51
  52 struct _EmpathyContactClass {
  53         GObjectClass parent_class;
  54 };
  55
  56 GType             empathy_contact_get_type     (void) G_GNUC_CONST;
  57 EmpathyContact *  empathy_contact_new          (McAccount       *account);
  58 EmpathyContact *  empathy_contact_new_full     (McAccount       *account,
  59                                                 const gchar     *id,
  60                                                 const gchar     *name);
  61 const gchar *     empathy_contact_get_id       (EmpathyContact  *contact);
  62 void              empathy_contact_set_id       (EmpathyContact  *contact,
  63                                                 const gchar     *id);
  64 const gchar *     empathy_contact_get_name     (EmpathyContact  *contact);
  65 void              empathy_contact_set_name     (EmpathyContact  *contact,
  66                                                 const gchar     *name);
  67 EmpathyAvatar *   empathy_contact_get_avatar   (EmpathyContact  *contact);
  68 void              empathy_contact_set_avatar   (EmpathyContact  *contact,
  69                                                 EmpathyAvatar   *avatar);
  70 McAccount *       empathy_contact_get_account  (EmpathyContact  *contact);
  71 void              empathy_contact_set_account  (EmpathyContact  *contact,
  72                                                 McAccount       *account);
  73 EmpathyPresence * empathy_contact_get_presence (EmpathyContact  *contact);
  74 void              empathy_contact_set_presence (EmpathyContact  *contact,
  75                                                 EmpathyPresence *presence);
  76 guint             empathy_contact_get_handle   (EmpathyContact  *contact);
  77 void              empathy_contact_set_handle   (EmpathyContact  *contact,
  78                                                 guint            handle);
  79 gboolean          empathy_contact_is_user      (EmpathyContact  *contact);
  80 void              empathy_contact_set_is_user  (EmpathyContact  *contact,
  81                                                 gboolean         is_user);
  82 gboolean          empathy_contact_is_online    (EmpathyContact  *contact);
  83 const gchar *     empathy_contact_get_status   (EmpathyContact  *contact);
  84 gboolean          empathy_contact_equal        (gconstpointer    v1,
  85                                                 gconstpointer    v2);
  86 guint             empathy_contact_hash         (gconstpointer    key);
  87
  88 G_END_DECLS
  89
  90 #endif /* __EMPATHY_CONTACT_H__ */
  91