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 #include <libempathy/empathy-individual-manager.h>
  33
  34 G_BEGIN_DECLS
  35 #define EMPATHY_TYPE_INDIVIDUAL_STORE         (empathy_individual_store_get_type ())
  36 #define EMPATHY_INDIVIDUAL_STORE(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), EMPATHY_TYPE_INDIVIDUAL_STORE, EmpathyIndividualStore))
  37 #define EMPATHY_INDIVIDUAL_STORE_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), EMPATHY_TYPE_INDIVIDUAL_STORE, EmpathyIndividualStoreClass))
  38 #define EMPATHY_IS_INDIVIDUAL_STORE(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), EMPATHY_TYPE_INDIVIDUAL_STORE))
  39 #define EMPATHY_IS_INDIVIDUAL_STORE_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), EMPATHY_TYPE_INDIVIDUAL_STORE))
  40 #define EMPATHY_INDIVIDUAL_STORE_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), EMPATHY_TYPE_INDIVIDUAL_STORE, EmpathyIndividualStoreClass))
  41 typedef struct _EmpathyIndividualStore EmpathyIndividualStore;
  42 typedef struct _EmpathyIndividualStoreClass EmpathyIndividualStoreClass;
  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_FLAGS,
  67   EMPATHY_INDIVIDUAL_STORE_COL_IS_FAKE_GROUP,
  68   EMPATHY_INDIVIDUAL_STORE_COL_COUNT,
  69 } EmpathyIndividualStoreCol;
  70
  71 #define EMPATHY_INDIVIDUAL_STORE_UNGROUPED _("Ungrouped")
  72 #define EMPATHY_INDIVIDUAL_STORE_FAVORITE  _("Favorite People")
  73 #define EMPATHY_INDIVIDUAL_STORE_PEOPLE_NEARBY _("People Nearby")
  74
  75 struct _EmpathyIndividualStore
  76 {
  77   GtkTreeStore parent;
  78   gpointer priv;
  79 };
  80
  81 struct _EmpathyIndividualStoreClass
  82 {
  83   GtkTreeStoreClass parent_class;
  84 };
  85
  86 GType
  87 empathy_individual_store_get_type (void) G_GNUC_CONST;
  88
  89 EmpathyIndividualStore *empathy_individual_store_new (
  90     EmpathyIndividualManager *manager);
  91
  92 EmpathyIndividualManager *empathy_individual_store_get_manager (
  93     EmpathyIndividualStore *store);
  94
  95 gboolean empathy_individual_store_get_show_avatars (
  96     EmpathyIndividualStore *store);
  97
  98 void empathy_individual_store_set_show_avatars (EmpathyIndividualStore *store,
  99     gboolean show_avatars);
 100
 101 gboolean empathy_individual_store_get_show_groups (
 102     EmpathyIndividualStore *store);
 103
 104 void empathy_individual_store_set_show_groups (EmpathyIndividualStore *store,
 105     gboolean show_groups);
 106
 107 gboolean empathy_individual_store_get_is_compact (
 108     EmpathyIndividualStore *store);
 109
 110 void empathy_individual_store_set_is_compact (EmpathyIndividualStore *store,
 111     gboolean is_compact);
 112
 113 gboolean empathy_individual_store_get_show_protocols (
 114     EmpathyIndividualStore *store);
 115
 116 void empathy_individual_store_set_show_protocols (
 117     EmpathyIndividualStore *store,
 118     gboolean show_protocols);
 119
 120 EmpathyIndividualStoreSort empathy_individual_store_get_sort_criterium (
 121     EmpathyIndividualStore *store);
 122
 123 void empathy_individual_store_set_sort_criterium (
 124     EmpathyIndividualStore *store,
 125     EmpathyIndividualStoreSort sort_criterium);
 126
 127 gboolean empathy_individual_store_row_separator_func (GtkTreeModel *model,
 128     GtkTreeIter *iter,
 129     gpointer data);
 130
 131 gchar *empathy_individual_store_get_parent_group (GtkTreeModel *model,
 132     GtkTreePath *path,
 133     gboolean *path_is_group,
 134     gboolean *is_fake_group);
 135
 136 GdkPixbuf *empathy_individual_store_get_individual_status_icon (
 137     EmpathyIndividualStore *store,
 138     FolksIndividual *individual);
 139
 140 G_END_DECLS
 141 #endif /* __EMPATHY_INDIVIDUAL_STORE_H__ */