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 struct _EmpathyContactListIface EmpathyContactListIface;
  38
  39 struct _EmpathyContactListIface {
  40         GTypeInterface   base_iface;
  41
  42         /* VTabled */
  43         void             (*add)               (EmpathyContactList *list,
  44                                                EmpathyContact     *contact,
  45                                                const gchar        *message);
  46         void             (*remove)            (EmpathyContactList *list,
  47                                                EmpathyContact     *contact,
  48                                                const gchar        *message);
  49         GList *          (*get_members)       (EmpathyContactList *list);
  50         GList *          (*get_pendings)      (EmpathyContactList *list);
  51         GList *          (*get_groups)        (EmpathyContactList *list,
  52                                                EmpathyContact     *contact);
  53         void             (*add_to_group)      (EmpathyContactList *list,
  54                                                EmpathyContact     *contact,
  55                                                const gchar        *group);
  56         void             (*remove_from_group) (EmpathyContactList *list,
  57                                                EmpathyContact     *contact,
  58                                                const gchar        *group);
  59         void             (*rename_group)      (EmpathyContactList *list,
  60                                                const gchar        *old_group,
  61                                                const gchar        *new_group);
  62         void             (*remove_group)      (EmpathyContactList *list,
  63                                                const gchar        *group);
  64 };
  65
  66 GType    empathy_contact_list_get_type          (void) G_GNUC_CONST;
  67 void     empathy_contact_list_add               (EmpathyContactList *list,
  68                                                  EmpathyContact     *contact,
  69                                                  const gchar        *message);
  70 void     empathy_contact_list_remove            (EmpathyContactList *list,
  71                                                  EmpathyContact     *contact,
  72                                                  const gchar        *message);
  73 GList *  empathy_contact_list_get_members       (EmpathyContactList *list);
  74 GList *  empathy_contact_list_get_pendings      (EmpathyContactList *list);
  75 GList *  empathy_contact_list_get_groups        (EmpathyContactList *list,
  76                                                  EmpathyContact     *contact);
  77 void     empathy_contact_list_add_to_group      (EmpathyContactList *list,
  78                                                  EmpathyContact     *contact,
  79                                                  const gchar        *group);
  80 void     empathy_contact_list_remove_from_group (EmpathyContactList *list,
  81                                                  EmpathyContact     *contact,
  82                                                  const gchar        *group);
  83 void     empathy_contact_list_rename_group      (EmpathyContactList *list,
  84                                                  const gchar        *old_group,
  85                                                  const gchar        *new_group);
  86 void     empathy_contact_list_remove_group      (EmpathyContactList *list,
  87                                                  const gchar        *group);
  88
  89 G_END_DECLS
  90
  91 #endif /* __EMPATHY_CONTACT_LIST_H__ */
  92