libempathy-gtk/empathy-individual-store.h

   1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
   2 /*
   3  * Copyright (C) 2005-2007 Imendio AB
   4  * Copyright (C) 2007-2010 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., 51 Franklin St, Fifth Floor,
  19  * Boston, MA  02110-1301  USA
  20  *
  21  * Authors: Mikael Hallendal <micke@imendio.com>
  22  *          Martyn Russell <martyn@imendio.com>
  23  *          Xavier Claessens <xclaesse@gmail.com>
  24  *          Travis Reitter <travis.reitter@collabora.co.uk>
  25  */
  26
  27 #ifndef __EMPATHY_INDIVIDUAL_STORE_H__
  28 #define __EMPATHY_INDIVIDUAL_STORE_H__
  29
  30 #include <gtk/gtk.h>
  31
  32 G_BEGIN_DECLS
  33 #define EMPATHY_TYPE_INDIVIDUAL_STORE         (empathy_individual_store_get_type ())
  34 #define EMPATHY_INDIVIDUAL_STORE(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), EMPATHY_TYPE_INDIVIDUAL_STORE, EmpathyIndividualStore))
  35 #define EMPATHY_INDIVIDUAL_STORE_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), EMPATHY_TYPE_INDIVIDUAL_STORE, EmpathyIndividualStoreClass))
  36 #define EMPATHY_IS_INDIVIDUAL_STORE(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), EMPATHY_TYPE_INDIVIDUAL_STORE))
  37 #define EMPATHY_IS_INDIVIDUAL_STORE_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), EMPATHY_TYPE_INDIVIDUAL_STORE))
  38 #define EMPATHY_INDIVIDUAL_STORE_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), EMPATHY_TYPE_INDIVIDUAL_STORE, EmpathyIndividualStoreClass))
  39
  40 typedef struct _EmpathyIndividualStore EmpathyIndividualStore;
  41 typedef struct _EmpathyIndividualStoreClass EmpathyIndividualStoreClass;
  42 typedef struct _EmpathyIndividualStorePriv EmpathyIndividualStorePriv;
  43
  44 typedef enum
  45 {
  46   EMPATHY_INDIVIDUAL_STORE_SORT_STATE,
  47   EMPATHY_INDIVIDUAL_STORE_SORT_NAME
  48 } EmpathyIndividualStoreSort;
  49
  50 typedef enum
  51 {
  52   EMPATHY_INDIVIDUAL_STORE_COL_ICON_STATUS,
  53   EMPATHY_INDIVIDUAL_STORE_COL_PIXBUF_AVATAR,
  54   EMPATHY_INDIVIDUAL_STORE_COL_PIXBUF_AVATAR_VISIBLE,
  55   EMPATHY_INDIVIDUAL_STORE_COL_NAME,
  56   EMPATHY_INDIVIDUAL_STORE_COL_PRESENCE_TYPE,
  57   EMPATHY_INDIVIDUAL_STORE_COL_STATUS,
  58   EMPATHY_INDIVIDUAL_STORE_COL_COMPACT,
  59   EMPATHY_INDIVIDUAL_STORE_COL_INDIVIDUAL,
  60   EMPATHY_INDIVIDUAL_STORE_COL_IS_GROUP,
  61   EMPATHY_INDIVIDUAL_STORE_COL_IS_ACTIVE,
  62   EMPATHY_INDIVIDUAL_STORE_COL_IS_ONLINE,
  63   EMPATHY_INDIVIDUAL_STORE_COL_IS_SEPARATOR,
  64   EMPATHY_INDIVIDUAL_STORE_COL_CAN_AUDIO_CALL,
  65   EMPATHY_INDIVIDUAL_STORE_COL_CAN_VIDEO_CALL,
  66   EMPATHY_INDIVIDUAL_STORE_COL_IS_FAKE_GROUP,
  67   EMPATHY_INDIVIDUAL_STORE_COL_CLIENT_TYPES,
  68   EMPATHY_INDIVIDUAL_STORE_COL_EVENT_COUNT,
  69   EMPATHY_INDIVIDUAL_STORE_COL_COUNT,
  70 } EmpathyIndividualStoreCol;
  71
  72 #define EMPATHY_INDIVIDUAL_STORE_UNGROUPED _("Ungrouped")
  73 #define EMPATHY_INDIVIDUAL_STORE_FAVORITE  _("Favorite People")
  74 #define EMPATHY_INDIVIDUAL_STORE_PEOPLE_NEARBY _("People Nearby")
  75
  76 struct _EmpathyIndividualStore
  77 {
  78   GtkTreeStore parent;
  79   EmpathyIndividualStorePriv *priv;
  80 };
  81
  82 struct _EmpathyIndividualStoreClass
  83 {
  84   GtkTreeStoreClass parent_class;
  85
  86   void (*reload_individuals) (EmpathyIndividualStore *self);
  87   gboolean (*initial_loading) (EmpathyIndividualStore *self);
  88 };
  89
  90 GType
  91 empathy_individual_store_get_type (void) G_GNUC_CONST;
  92
  93 gboolean empathy_individual_store_get_show_avatars (
  94     EmpathyIndividualStore *store);
  95
  96 void empathy_individual_store_set_show_avatars (EmpathyIndividualStore *store,
  97     gboolean show_avatars);
  98
  99 gboolean empathy_individual_store_get_show_groups (
 100     EmpathyIndividualStore *store);
 101
 102 void empathy_individual_store_set_show_groups (EmpathyIndividualStore *store,
 103     gboolean show_groups);
 104
 105 gboolean empathy_individual_store_get_is_compact (
 106     EmpathyIndividualStore *store);
 107
 108 void empathy_individual_store_set_is_compact (EmpathyIndividualStore *store,
 109     gboolean is_compact);
 110
 111 gboolean empathy_individual_store_get_show_protocols (
 112     EmpathyIndividualStore *store);
 113
 114 void empathy_individual_store_set_show_protocols (
 115     EmpathyIndividualStore *store,
 116     gboolean show_protocols);
 117
 118 EmpathyIndividualStoreSort empathy_individual_store_get_sort_criterium (
 119     EmpathyIndividualStore *store);
 120
 121 void empathy_individual_store_set_sort_criterium (
 122     EmpathyIndividualStore *store,
 123     EmpathyIndividualStoreSort sort_criterium);
 124
 125 gboolean empathy_individual_store_row_separator_func (GtkTreeModel *model,
 126     GtkTreeIter *iter,
 127     gpointer data);
 128
 129 gchar *empathy_individual_store_get_parent_group (GtkTreeModel *model,
 130     GtkTreePath *path,
 131     gboolean *path_is_group,
 132     gboolean *is_fake_group);
 133
 134 GdkPixbuf *empathy_individual_store_get_individual_status_icon (
 135     EmpathyIndividualStore *store,
 136     FolksIndividual *individual);
 137
 138 void individual_store_add_individual_and_connect (EmpathyIndividualStore *self,
 139     FolksIndividual *individual);
 140
 141 void individual_store_remove_individual_and_disconnect (
 142     EmpathyIndividualStore *self,
 143     FolksIndividual *individual);
 144
 145 /* protected */
 146
 147 void empathy_individual_store_disconnect_individual (
 148     EmpathyIndividualStore *self,
 149     FolksIndividual *individual);
 150
 151 void empathy_individual_store_remove_individual (EmpathyIndividualStore *self,
 152     FolksIndividual *individual);
 153
 154 void empathy_individual_store_add_individual (EmpathyIndividualStore *self,
 155     FolksIndividual *individual);
 156
 157 void empathy_individual_store_refresh_individual (EmpathyIndividualStore *self,
 158     FolksIndividual *individual);
 159
 160 G_END_DECLS
 161 #endif /* __EMPATHY_INDIVIDUAL_STORE_H__ */