libempathy-gtk/empathy-roster-model.h

   1 /*
   2  * empathy-roster-model.h
   3  *
   4  * Copyright (C) 2012 Collabora Ltd. <http://www.collabora.co.uk/>
   5  *
   6  * This library is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * This library 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  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with this library; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  */
  20 #ifndef __EMPATHY_ROSTER_MODEL_H__
  21 #define __EMPATHY_ROSTER_MODEL_H__
  22
  23 #include <folks/folks.h>
  24
  25 G_BEGIN_DECLS
  26
  27 #define EMPATHY_ROSTER_MODEL_GROUP_TOP_GROUP _("Top Contacts")
  28 #define EMPATHY_ROSTER_MODEL_GROUP_PEOPLE_NEARBY _("People Nearby")
  29 #define EMPATHY_ROSTER_MODEL_GROUP_UNGROUPED _("Ungrouped")
  30
  31 typedef struct _EmpathyRosterModel EmpathyRosterModel;
  32 typedef struct _EmpathyRosterModelInterface EmpathyRosterModelInterface;
  33
  34 struct _EmpathyRosterModelInterface
  35 {
  36   /*<private>*/
  37   GTypeInterface g_iface;
  38
  39   /* Virtual table */
  40   GList * (* get_individuals) (EmpathyRosterModel *self);
  41   GList * (*dup_groups_for_individual) (EmpathyRosterModel *self,
  42       FolksIndividual *individual);
  43 };
  44
  45 GType empathy_roster_model_get_type (void);
  46
  47 /* TYPE MACROS */
  48 #define EMPATHY_TYPE_ROSTER_MODEL \
  49   (empathy_roster_model_get_type ())
  50 #define EMPATHY_ROSTER_MODEL(obj) \
  51   (G_TYPE_CHECK_INSTANCE_CAST((obj), \
  52     EMPATHY_TYPE_ROSTER_MODEL, \
  53     EmpathyRosterModel))
  54 #define EMPATHY_IS_ROSTER_MODEL(obj) \
  55   (G_TYPE_CHECK_INSTANCE_TYPE((obj), \
  56     EMPATHY_TYPE_ROSTER_MODEL))
  57 #define EMPATHY_ROSTER_MODEL_GET_IFACE(obj) \
  58   (G_TYPE_INSTANCE_GET_INTERFACE ((obj), \
  59     EMPATHY_TYPE_ROSTER_MODEL, \
  60     EmpathyRosterModelInterface))
  61
  62 /* Restricted */
  63
  64 void empathy_roster_model_fire_individual_added (EmpathyRosterModel *self,
  65     FolksIndividual *individual);
  66
  67 void empathy_roster_model_fire_individual_removed (EmpathyRosterModel *self,
  68     FolksIndividual *individual);
  69
  70 void empathy_roster_model_fire_groups_changed (EmpathyRosterModel *self,
  71     FolksIndividual *individual,
  72     const gchar *group,
  73     gboolean is_member);
  74
  75 /* Public API */
  76 GList * empathy_roster_model_get_individuals (EmpathyRosterModel *self);
  77
  78 GList * empathy_roster_model_dup_groups_for_individual (
  79     EmpathyRosterModel *self,
  80     FolksIndividual *individual);
  81
  82 G_END_DECLS
  83
  84 #endif /* #ifndef __EMPATHY_ROSTER_MODEL_H__*/