libempathy-gtk/empathy-protocol-chooser.c

   1 /* -*- Mode: C; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2; -*- */
   2 /*
   3  * Copyright (C) 2007-2009 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  *          Jonny Lamb <jonny.lamb@collabora.co.uk>
  21  */
  22
  23 #include <config.h>
  24
  25 #include <string.h>
  26
  27 #include <telepathy-glib/util.h>
  28
  29 #include <gtk/gtk.h>
  30
  31 #include <libempathy/empathy-utils.h>
  32 #include <libempathy/empathy-connection-managers.h>
  33
  34 #include "empathy-protocol-chooser.h"
  35 #include "empathy-ui-utils.h"
  36
  37 #define DEBUG_FLAG EMPATHY_DEBUG_ACCOUNT
  38 #include <libempathy/empathy-debug.h>
  39
  40 /**
  41  * SECTION:empathy-protocol-chooser
  42  * @title: EmpathyProtocolChooser
  43  * @short_description: A widget used to choose from a list of protocols
  44  * @include: libempathy-gtk/empathy-protocol-chooser.h
  45  *
  46  * #EmpathyProtocolChooser is a widget which extends #GtkComboBox to provides a
  47  * chooser of available protocols.
  48  */
  49
  50 /**
  51  * EmpathyProtocolChooser:
  52  * @parent: parent object
  53  *
  54  * Widget which extends #GtkComboBox to provide a chooser of available
  55  * protocols.
  56  */
  57
  58 #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyProtocolChooser)
  59 typedef struct
  60 {
  61   GtkListStore *store;
  62   gboolean dispose_run;
  63   EmpathyConnectionManagers *cms;
  64
  65 } EmpathyProtocolChooserPriv;
  66
  67 enum
  68 {
  69   COL_ICON,
  70   COL_LABEL,
  71   COL_CM,
  72   COL_PROTOCOL,
  73   COL_COUNT
  74 };
  75
  76 G_DEFINE_TYPE (EmpathyProtocolChooser, empathy_protocol_chooser,
  77     GTK_TYPE_COMBO_BOX);
  78
  79 static gint
  80 protocol_chooser_sort_protocol_value (TpConnectionManagerProtocol *protocol)
  81 {
  82   guint i;
  83   const gchar *names[] = {
  84     "jabber",
  85     "salut",
  86     "gtalk",
  87     NULL
  88   };
  89
  90   for (i = 0 ; names[i]; i++)
  91     {
  92       if (strcmp (protocol->name, names[i]) == 0)
  93         return i;
  94     }
  95
  96   return i;
  97 }
  98
  99 static gint
 100 protocol_chooser_sort_func (GtkTreeModel *model,
 101     GtkTreeIter  *iter_a,
 102     GtkTreeIter  *iter_b,
 103     gpointer      user_data)
 104 {
 105   TpConnectionManagerProtocol *protocol_a;
 106   TpConnectionManagerProtocol *protocol_b;
 107   gint cmp;
 108
 109   gtk_tree_model_get (model, iter_a,
 110       COL_PROTOCOL, &protocol_a,
 111       -1);
 112   gtk_tree_model_get (model, iter_b,
 113       COL_PROTOCOL, &protocol_b,
 114       -1);
 115
 116   cmp = protocol_chooser_sort_protocol_value (protocol_a);
 117   cmp -= protocol_chooser_sort_protocol_value (protocol_b);
 118   if (cmp == 0)
 119     {
 120       cmp = strcmp (protocol_a->name, protocol_b->name);
 121     }
 122
 123   return cmp;
 124 }
 125
 126 static void
 127 protocol_choosers_add_cm (EmpathyProtocolChooser *chooser,
 128     TpConnectionManager *cm)
 129 {
 130   EmpathyProtocolChooserPriv *priv = GET_PRIV (chooser);
 131   const TpConnectionManagerProtocol * const *iter;
 132
 133   for (iter = cm->protocols; iter != NULL && *iter != NULL; iter++)
 134     {
 135       const TpConnectionManagerProtocol *proto = *iter;
 136       gchar *icon_name;
 137       gchar *display_name;
 138
 139
 140       icon_name = g_strdup_printf ("im-%s", proto->name);
 141
 142       if (!tp_strdiff (cm->name, "haze"))
 143         display_name = g_strdup_printf ("%s (Haze)", proto->name);
 144       else
 145         display_name = g_strdup (proto->name);
 146
 147       gtk_list_store_insert_with_values (priv->store, NULL, 0,
 148           COL_ICON, icon_name,
 149           COL_LABEL, display_name,
 150           COL_CM, cm,
 151           COL_PROTOCOL, proto,
 152           -1);
 153
 154       g_free (display_name);
 155       g_free (icon_name);
 156     }
 157 }
 158
 159 static void
 160 protocol_chooser_add_cms_list (EmpathyProtocolChooser *protocol_chooser,
 161     GList *cms)
 162 {
 163   GList *l;
 164
 165   for (l = cms; l != NULL; l = l->next)
 166     protocol_choosers_add_cm (protocol_chooser, l->data);
 167
 168   gtk_combo_box_set_active (GTK_COMBO_BOX (protocol_chooser), 0);
 169 }
 170
 171 static void
 172 protocol_chooser_cms_ready_cb (EmpathyConnectionManagers *cms,
 173     GParamSpec *pspec,
 174     EmpathyProtocolChooser *protocol_chooser)
 175 {
 176   if (empathy_connection_managers_is_ready (cms))
 177     protocol_chooser_add_cms_list
 178         (protocol_chooser, empathy_connection_managers_get_cms (cms));
 179 }
 180
 181 static void
 182 protocol_chooser_constructed (GObject *object)
 183 {
 184   EmpathyProtocolChooser *protocol_chooser;
 185   EmpathyProtocolChooserPriv *priv;
 186   GtkCellRenderer *renderer;
 187
 188   priv = GET_PRIV (object);
 189   protocol_chooser = EMPATHY_PROTOCOL_CHOOSER (object);
 190
 191   /* set up combo box with new store */
 192   priv->store = gtk_list_store_new (COL_COUNT,
 193           G_TYPE_STRING,    /* Icon name */
 194           G_TYPE_STRING,    /* Label     */
 195           G_TYPE_OBJECT,    /* CM */
 196           G_TYPE_POINTER);  /* protocol   */
 197
 198   gtk_combo_box_set_model (GTK_COMBO_BOX (object),
 199       GTK_TREE_MODEL (priv->store));
 200
 201   renderer = gtk_cell_renderer_pixbuf_new ();
 202   gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (object), renderer, FALSE);
 203   gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (object), renderer,
 204       "icon-name", COL_ICON,
 205       NULL);
 206   g_object_set (renderer, "stock-size", GTK_ICON_SIZE_BUTTON, NULL);
 207
 208   renderer = gtk_cell_renderer_text_new ();
 209   gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (object), renderer, TRUE);
 210   gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (object), renderer,
 211       "text", COL_LABEL,
 212       NULL);
 213
 214   /* Set the protocol sort function */
 215   gtk_tree_sortable_set_sort_func (GTK_TREE_SORTABLE (priv->store),
 216       COL_PROTOCOL,
 217       protocol_chooser_sort_func,
 218       NULL, NULL);
 219   gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (priv->store),
 220       COL_PROTOCOL,
 221       GTK_SORT_ASCENDING);
 222
 223   if (empathy_connection_managers_is_ready (priv->cms))
 224     protocol_chooser_add_cms_list (protocol_chooser,
 225         empathy_connection_managers_get_cms (priv->cms));
 226   else
 227     g_signal_connect (priv->cms, "notify::ready",
 228         G_CALLBACK (protocol_chooser_cms_ready_cb), protocol_chooser);
 229
 230   if (G_OBJECT_CLASS (empathy_protocol_chooser_parent_class)->constructed)
 231     G_OBJECT_CLASS (empathy_protocol_chooser_parent_class)->constructed (object);
 232 }
 233
 234 static void
 235 empathy_protocol_chooser_init (EmpathyProtocolChooser *protocol_chooser)
 236 {
 237   EmpathyProtocolChooserPriv *priv =
 238     G_TYPE_INSTANCE_GET_PRIVATE (protocol_chooser,
 239         EMPATHY_TYPE_PROTOCOL_CHOOSER, EmpathyProtocolChooserPriv);
 240
 241   priv->dispose_run = FALSE;
 242   priv->cms = empathy_connection_managers_dup_singleton ();
 243
 244   protocol_chooser->priv = priv;
 245 }
 246
 247 static void
 248 protocol_chooser_dispose (GObject *object)
 249 {
 250   EmpathyProtocolChooser *protocol_chooser = EMPATHY_PROTOCOL_CHOOSER (object);
 251   EmpathyProtocolChooserPriv *priv = GET_PRIV (protocol_chooser);
 252
 253   if (priv->dispose_run)
 254     return;
 255
 256   priv->dispose_run = TRUE;
 257
 258   if (priv->store)
 259     {
 260       g_object_unref (priv->store);
 261       priv->store = NULL;
 262     }
 263
 264   if (priv->cms)
 265     {
 266       g_object_unref (priv->cms);
 267       priv->cms = NULL;
 268     }
 269
 270   (G_OBJECT_CLASS (empathy_protocol_chooser_parent_class)->dispose) (object);
 271 }
 272
 273 static void
 274 empathy_protocol_chooser_class_init (EmpathyProtocolChooserClass *klass)
 275 {
 276   GObjectClass *object_class = G_OBJECT_CLASS (klass);
 277
 278   object_class->constructed = protocol_chooser_constructed;
 279   object_class->dispose = protocol_chooser_dispose;
 280
 281   g_type_class_add_private (object_class, sizeof (EmpathyProtocolChooserPriv));
 282 }
 283
 284 /* public methods */
 285
 286 /**
 287  * empathy_protocol_chooser_get_selected_protocol:
 288  * @protocol_chooser: an #EmpathyProtocolChooser
 289  *
 290  * Returns a pointer to the selected #TpConnectionManagerProtocol in
 291  * @protocol_chooser.
 292  *
 293  * Return value: a pointer to the selected #TpConnectionManagerProtocol
 294  */
 295 TpConnectionManager *empathy_protocol_chooser_dup_selected (
 296     EmpathyProtocolChooser *protocol_chooser,
 297     TpConnectionManagerProtocol **protocol)
 298 {
 299   EmpathyProtocolChooserPriv *priv = GET_PRIV (protocol_chooser);
 300   GtkTreeIter iter;
 301   TpConnectionManager *cm = NULL;
 302
 303   g_return_val_if_fail (EMPATHY_IS_PROTOCOL_CHOOSER (protocol_chooser), NULL);
 304
 305   if (gtk_combo_box_get_active_iter (GTK_COMBO_BOX (protocol_chooser), &iter))
 306     {
 307       gtk_tree_model_get (GTK_TREE_MODEL (priv->store), &iter,
 308           COL_CM, &cm,
 309           -1);
 310
 311       if (protocol != NULL)
 312         gtk_tree_model_get (GTK_TREE_MODEL (priv->store), &iter,
 313             COL_PROTOCOL, protocol,
 314             -1);
 315     }
 316
 317   return cm;
 318 }
 319
 320 /**
 321  * empathy_protocol_chooser_new:
 322  *
 323  * Triggers the creation of a new #EmpathyProtocolChooser.
 324  *
 325  * Return value: a new #EmpathyProtocolChooser widget
 326  */
 327
 328 GtkWidget *
 329 empathy_protocol_chooser_new (void)
 330 {
 331   return GTK_WIDGET (g_object_new (EMPATHY_TYPE_PROTOCOL_CHOOSER, NULL));
 332 }