libempathy/empathy-contact-list.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*
   3  * Copyright (C) 2007-2008 Collabora Ltd.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2.1 of the License, or (at your option) any later version.
   9  *
  10  * This library 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  * Lesser General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU Lesser General Public
  16  * License along with this library; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  18  *
  19  * Authors: Xavier Claessens <xclaesse@gmail.com>
  20  */
  21
  22 #ifndef __EMPATHY_CONTACT_LIST_H__
  23 #define __EMPATHY_CONTACT_LIST_H__
  24
  25 #include <glib-object.h>
  26
  27 #include "empathy-types.h"
  28 #include "empathy-contact.h"
  29
  30 G_BEGIN_DECLS
  31
  32 #define EMPATHY_TYPE_CONTACT_LIST         (empathy_contact_list_get_type ())
  33 #define EMPATHY_CONTACT_LIST(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), EMPATHY_TYPE_CONTACT_LIST, EmpathyContactList))
  34 #define EMPATHY_IS_CONTACT_LIST(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), EMPATHY_TYPE_CONTACT_LIST))
  35 #define EMPATHY_CONTACT_LIST_GET_IFACE(o) (G_TYPE_INSTANCE_GET_INTERFACE ((o), EMPATHY_TYPE_CONTACT_LIST, EmpathyContactListIface))
  36
  37 typedef enum {
  38         EMPATHY_CONTACT_LIST_CAN_ADD            = 1 << 0,
  39         EMPATHY_CONTACT_LIST_CAN_REMOVE         = 1 << 1,
  40         EMPATHY_CONTACT_LIST_CAN_ALIAS          = 1 << 2,
  41         EMPATHY_CONTACT_LIST_CAN_GROUP          = 1 << 3,
  42 } EmpathyContactListFlags;
  43
  44 typedef struct _EmpathyContactListIface EmpathyContactListIface;
  45
  46 struct _EmpathyContactListIface {
  47         GTypeInterface   base_iface;
  48
  49         /* VTabled */
  50         void             (*add)               (EmpathyContactList *list,
  51                                                EmpathyContact     *contact,
  52                                                const gchar        *message);
  53         void             (*remove)            (EmpathyContactList *list,
  54                                                EmpathyContact     *contact,
  55                                                const gchar        *message);
  56         GList *          (*get_members)       (EmpathyContactList *list);
  57         GList *          (*get_pendings)      (EmpathyContactList *list);
  58         GList *          (*get_all_groups)    (EmpathyContactList *list);
  59         GList *          (*get_groups)        (EmpathyContactList *list,
  60                                                EmpathyContact     *contact);
  61         void             (*add_to_group)      (EmpathyContactList *list,
  62                                                EmpathyContact     *contact,
  63                                                const gchar        *group);
  64         void             (*remove_from_group) (EmpathyContactList *list,
  65                                                EmpathyContact     *contact,
  66                                                const gchar        *group);
  67         void             (*rename_group)      (EmpathyContactList *list,
  68                                                const gchar        *old_group,
  69                                                const gchar        *new_group);
  70         void             (*remove_group)      (EmpathyContactList *list,
  71                                                const gchar        *group);
  72         EmpathyContactListFlags
  73                          (*get_flags)         (EmpathyContactList *list);
  74         gboolean         (*is_favourite)      (EmpathyContactList *list,
  75                                                EmpathyContact     *contact);
  76         void             (*add_favourite)     (EmpathyContactList *list,
  77                                                EmpathyContact     *contact);
  78         void             (*remove_favourite)  (EmpathyContactList *list,
  79                                                EmpathyContact     *contact);
  80 };
  81
  82 GType    empathy_contact_list_get_type          (void) G_GNUC_CONST;
  83 void     empathy_contact_list_add               (EmpathyContactList *list,
  84                                                  EmpathyContact     *contact,
  85                                                  const gchar        *message);
  86 void     empathy_contact_list_remove            (EmpathyContactList *list,
  87                                                  EmpathyContact     *contact,
  88                                                  const gchar        *message);
  89 GList *  empathy_contact_list_get_members       (EmpathyContactList *list);
  90 GList *  empathy_contact_list_get_pendings      (EmpathyContactList *list);
  91 GList *  empathy_contact_list_get_all_groups    (EmpathyContactList *list);
  92 GList *  empathy_contact_list_get_groups        (EmpathyContactList *list,
  93                                                  EmpathyContact     *contact);
  94 void     empathy_contact_list_add_to_group      (EmpathyContactList *list,
  95                                                  EmpathyContact     *contact,
  96                                                  const gchar        *group);
  97 void     empathy_contact_list_remove_from_group (EmpathyContactList *list,
  98                                                  EmpathyContact     *contact,
  99                                                  const gchar        *group);
 100 void     empathy_contact_list_rename_group      (EmpathyContactList *list,
 101                                                  const gchar        *old_group,
 102                                                  const gchar        *new_group);
 103 void     empathy_contact_list_remove_group      (EmpathyContactList *list,
 104                                                  const gchar        *group);
 105
 106 EmpathyContactListFlags
 107          empathy_contact_list_get_flags         (EmpathyContactList *list);
 108
 109 gboolean empathy_contact_list_is_favourite      (EmpathyContactList *list,
 110                                                  EmpathyContact     *contact);
 111
 112 void     empathy_contact_list_add_to_favourites (EmpathyContactList *list,
 113                                                  EmpathyContact     *contact);
 114
 115 void     empathy_contact_list_remove_from_favourites
 116                                                 (EmpathyContactList *list,
 117                                                  EmpathyContact     *contact);
 118
 119
 120 G_END_DECLS
 121
 122 #endif /* __EMPATHY_CONTACT_LIST_H__ */
 123