1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
3 * Copyright (C) 2005-2007 Imendio AB
4 * Copyright (C) 2007-2008 Collabora Ltd.
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.
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.
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
21 * Authors: Martyn Russell <martyn@imendio.com>
22 * Xavier Claessens <xclaesse@gmail.com>
29 #include <glib/gi18n-lib.h>
32 #include <libempathy/empathy-account-manager.h>
33 #include <libempathy/empathy-utils.h>
35 #include "empathy-ui-utils.h"
36 #include "empathy-account-chooser.h"
39 * SECTION:empathy-account-chooser
40 * @title:EmpathyAccountChooser
41 * @short_description: A widget used to choose from a list of accounts
42 * @include: libempathy-gtk/empathy-account-chooser.h
44 * #EmpathyAccountChooser is a widget which extends #GtkComboBox to provide
45 * a chooser of available accounts.
49 * EmpathyAccountChooser:
50 * @parent: parent object
52 * Widget which extends #GtkComboBox to provide a chooser of available accounts.
55 #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyAccountChooser)
57 EmpathyAccountManager *manager;
58 gboolean set_active_item;
59 gboolean has_all_option;
60 EmpathyAccountChooserFilterFunc filter;
62 } EmpathyAccountChooserPriv;
65 EmpathyAccountChooser *chooser;
66 EmpathyAccount *account;
73 COL_ACCOUNT_ENABLED, /* Usually tied to connected state */
78 static void account_chooser_finalize (GObject *object);
79 static void account_chooser_get_property (GObject *object,
83 static void account_chooser_set_property (GObject *object,
87 static void account_chooser_setup (EmpathyAccountChooser *chooser);
88 static void account_chooser_account_created_cb (EmpathyAccountManager *manager,
89 EmpathyAccount *account,
90 EmpathyAccountChooser *chooser);
91 static void account_chooser_account_add_foreach (EmpathyAccount *account,
92 EmpathyAccountChooser *chooser);
93 static void account_chooser_account_deleted_cb (EmpathyAccountManager *manager,
94 EmpathyAccount *account,
95 EmpathyAccountChooser *chooser);
96 static void account_chooser_account_remove_foreach (EmpathyAccount *account,
97 EmpathyAccountChooser *chooser);
98 static void account_chooser_update_iter (EmpathyAccountChooser *chooser,
100 static void account_chooser_connection_changed_cb (EmpathyAccountManager *manager,
101 EmpathyAccount *account,
102 TpConnectionStatusReason reason,
103 TpConnectionStatus new_status,
104 TpConnectionStatus old_status,
105 EmpathyAccountChooser *chooser);
106 static gboolean account_chooser_separator_func (GtkTreeModel *model,
108 EmpathyAccountChooser *chooser);
109 static gboolean account_chooser_set_account_foreach (GtkTreeModel *model,
112 SetAccountData *data);
119 G_DEFINE_TYPE (EmpathyAccountChooser, empathy_account_chooser, GTK_TYPE_COMBO_BOX);
122 empathy_account_chooser_class_init (EmpathyAccountChooserClass *klass)
124 GObjectClass *object_class = G_OBJECT_CLASS (klass);
126 object_class->finalize = account_chooser_finalize;
127 object_class->get_property = account_chooser_get_property;
128 object_class->set_property = account_chooser_set_property;
131 * EmpathyAccountChooser:has-all-option:
133 * Have an additional option in the list to mean all accounts.
135 g_object_class_install_property (object_class,
137 g_param_spec_boolean ("has-all-option",
139 "Have a separate option in the list to mean ALL accounts",
143 g_type_class_add_private (object_class, sizeof (EmpathyAccountChooserPriv));
147 empathy_account_chooser_init (EmpathyAccountChooser *chooser)
149 EmpathyAccountChooserPriv *priv = G_TYPE_INSTANCE_GET_PRIVATE (chooser,
150 EMPATHY_TYPE_ACCOUNT_CHOOSER, EmpathyAccountChooserPriv);
152 chooser->priv = priv;
153 priv->set_active_item = FALSE;
155 priv->filter_data = NULL;
157 priv->manager = empathy_account_manager_dup_singleton ();
159 g_signal_connect (priv->manager, "account-created",
160 G_CALLBACK (account_chooser_account_created_cb),
162 g_signal_connect (priv->manager, "account-deleted",
163 G_CALLBACK (account_chooser_account_deleted_cb),
165 g_signal_connect (priv->manager, "account-connection-changed",
166 G_CALLBACK (account_chooser_connection_changed_cb),
169 account_chooser_setup (EMPATHY_ACCOUNT_CHOOSER (chooser));
173 account_chooser_finalize (GObject *object)
175 EmpathyAccountChooserPriv *priv = GET_PRIV (object);
177 g_signal_handlers_disconnect_by_func (priv->manager,
178 account_chooser_connection_changed_cb,
180 g_signal_handlers_disconnect_by_func (priv->manager,
181 account_chooser_account_created_cb,
183 g_signal_handlers_disconnect_by_func (priv->manager,
184 account_chooser_account_deleted_cb,
186 g_object_unref (priv->manager);
188 G_OBJECT_CLASS (empathy_account_chooser_parent_class)->finalize (object);
192 account_chooser_get_property (GObject *object,
197 EmpathyAccountChooserPriv *priv;
199 priv = GET_PRIV (object);
202 case PROP_HAS_ALL_OPTION:
203 g_value_set_boolean (value, priv->has_all_option);
206 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
212 account_chooser_set_property (GObject *object,
217 EmpathyAccountChooserPriv *priv;
219 priv = GET_PRIV (object);
222 case PROP_HAS_ALL_OPTION:
223 empathy_account_chooser_set_has_all_option (EMPATHY_ACCOUNT_CHOOSER (object),
224 g_value_get_boolean (value));
227 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
233 * empathy_account_chooser_new:
235 * Creates a new #EmpathyAccountChooser.
237 * Return value: A new #EmpathyAccountChooser
240 empathy_account_chooser_new (void)
244 chooser = g_object_new (EMPATHY_TYPE_ACCOUNT_CHOOSER, NULL);
250 * empathy_account_chooser_dup_account:
251 * @chooser: an #EmpathyAccountChooser
253 * Returns the account which is currently selected in the chooser or %NULL
254 * if there is no account selected. The #EmpathyAccount returned should be
255 * unrefed with g_object_unref() when finished with.
257 * Return value: a new ref to the #EmpathyAccount currently selected, or %NULL.
260 empathy_account_chooser_dup_account (EmpathyAccountChooser *chooser)
262 EmpathyAccountChooserPriv *priv;
263 EmpathyAccount *account;
267 g_return_val_if_fail (EMPATHY_IS_ACCOUNT_CHOOSER (chooser), NULL);
269 priv = GET_PRIV (chooser);
271 model = gtk_combo_box_get_model (GTK_COMBO_BOX (chooser));
272 if (!gtk_combo_box_get_active_iter (GTK_COMBO_BOX (chooser), &iter)) {
276 gtk_tree_model_get (model, &iter, COL_ACCOUNT_POINTER, &account, -1);
282 * empathy_account_chooser_get_connection:
283 * @chooser: an #EmpathyAccountChooser
285 * Returns a borrowed reference to the #TpConnection associated with the
286 * account currently selected. The caller must reference the returned object with
287 * g_object_ref() if it will be kept
289 * Return value: a borrowed reference to the #TpConnection associated with the
290 * account curently selected.
293 empathy_account_chooser_get_connection (EmpathyAccountChooser *chooser)
295 EmpathyAccountChooserPriv *priv;
296 EmpathyAccount *account;
297 TpConnection *connection;
299 g_return_val_if_fail (EMPATHY_IS_ACCOUNT_CHOOSER (chooser), NULL);
301 priv = GET_PRIV (chooser);
303 account = empathy_account_chooser_dup_account (chooser);
304 connection = empathy_account_get_connection (account);
305 g_object_unref (account);
311 * empathy_account_chooser_set_account:
312 * @chooser: an #EmpathyAccountChooser
313 * @account: an #EmpathyAccount
315 * Sets the currently selected account to @account, if it exists in the list.
317 * Return value: whether the chooser was set to @account.
320 empathy_account_chooser_set_account (EmpathyAccountChooser *chooser,
321 EmpathyAccount *account)
323 GtkComboBox *combobox;
328 g_return_val_if_fail (EMPATHY_IS_ACCOUNT_CHOOSER (chooser), FALSE);
330 combobox = GTK_COMBO_BOX (chooser);
331 model = gtk_combo_box_get_model (combobox);
332 gtk_combo_box_get_active_iter (combobox, &iter);
334 data.chooser = chooser;
335 data.account = account;
337 gtk_tree_model_foreach (model,
338 (GtkTreeModelForeachFunc) account_chooser_set_account_foreach,
345 * empathy_account_chooser_get_has_all_option:
346 * @chooser: an #EmpathyAccountChooser
348 * Returns whether @chooser has the #EmpathyAccountChooser:has-all-option property
351 * Return value: whether @chooser has the #EmpathyAccountChooser:has-all-option property
355 empathy_account_chooser_get_has_all_option (EmpathyAccountChooser *chooser)
357 EmpathyAccountChooserPriv *priv;
359 g_return_val_if_fail (EMPATHY_IS_ACCOUNT_CHOOSER (chooser), FALSE);
361 priv = GET_PRIV (chooser);
363 return priv->has_all_option;
367 * empathy_account_chooser_set_has_all_option:
368 * @chooser: an #EmpathyAccountChooser
369 * @has_all_option: a new value for the #EmpathyAccountChooser:has-all-option property
371 * Sets the #EmpathyAccountChooser:has-all-option property.
374 empathy_account_chooser_set_has_all_option (EmpathyAccountChooser *chooser,
375 gboolean has_all_option)
377 EmpathyAccountChooserPriv *priv;
378 GtkComboBox *combobox;
383 g_return_if_fail (EMPATHY_IS_ACCOUNT_CHOOSER (chooser));
385 priv = GET_PRIV (chooser);
387 if (priv->has_all_option == has_all_option) {
391 combobox = GTK_COMBO_BOX (chooser);
392 model = gtk_combo_box_get_model (combobox);
393 store = GTK_LIST_STORE (model);
395 priv->has_all_option = has_all_option;
398 * The first 2 options are the ALL and separator
401 if (has_all_option) {
402 gtk_combo_box_set_row_separator_func (GTK_COMBO_BOX (chooser),
403 (GtkTreeViewRowSeparatorFunc)
404 account_chooser_separator_func,
408 gtk_list_store_prepend (store, &iter);
409 gtk_list_store_set (store, &iter,
410 COL_ACCOUNT_TEXT, NULL,
411 COL_ACCOUNT_ENABLED, TRUE,
412 COL_ACCOUNT_POINTER, NULL,
415 gtk_list_store_prepend (store, &iter);
416 gtk_list_store_set (store, &iter,
417 COL_ACCOUNT_TEXT, _("All"),
418 COL_ACCOUNT_ENABLED, TRUE,
419 COL_ACCOUNT_POINTER, NULL,
422 if (gtk_tree_model_get_iter_first (model, &iter)) {
423 if (gtk_list_store_remove (GTK_LIST_STORE (model), &iter)) {
424 gtk_list_store_remove (GTK_LIST_STORE (model), &iter);
428 gtk_combo_box_set_row_separator_func (GTK_COMBO_BOX (chooser),
429 (GtkTreeViewRowSeparatorFunc)
435 g_object_notify (G_OBJECT (chooser), "has-all-option");
439 account_chooser_setup (EmpathyAccountChooser *chooser)
441 EmpathyAccountChooserPriv *priv;
444 GtkCellRenderer *renderer;
445 GtkComboBox *combobox;
447 priv = GET_PRIV (chooser);
449 /* Set up combo box with new store */
450 combobox = GTK_COMBO_BOX (chooser);
452 gtk_cell_layout_clear (GTK_CELL_LAYOUT (combobox));
454 store = gtk_list_store_new (COL_ACCOUNT_COUNT,
455 G_TYPE_STRING, /* Image */
456 G_TYPE_STRING, /* Name */
457 G_TYPE_BOOLEAN, /* Enabled */
458 EMPATHY_TYPE_ACCOUNT);
460 gtk_combo_box_set_model (combobox, GTK_TREE_MODEL (store));
462 renderer = gtk_cell_renderer_pixbuf_new ();
463 gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (combobox), renderer, FALSE);
464 gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (combobox), renderer,
465 "icon-name", COL_ACCOUNT_IMAGE,
466 "sensitive", COL_ACCOUNT_ENABLED,
468 g_object_set (renderer, "stock-size", GTK_ICON_SIZE_BUTTON, NULL);
470 renderer = gtk_cell_renderer_text_new ();
471 gtk_cell_layout_pack_start (GTK_CELL_LAYOUT (combobox), renderer, TRUE);
472 gtk_cell_layout_set_attributes (GTK_CELL_LAYOUT (combobox), renderer,
473 "text", COL_ACCOUNT_TEXT,
474 "sensitive", COL_ACCOUNT_ENABLED,
477 /* Populate accounts */
478 accounts = empathy_account_manager_dup_accounts (priv->manager);
479 g_list_foreach (accounts,
480 (GFunc) account_chooser_account_add_foreach,
483 g_list_free (accounts);
484 g_object_unref (store);
488 account_chooser_account_created_cb (EmpathyAccountManager *manager,
489 EmpathyAccount *account,
490 EmpathyAccountChooser *chooser)
492 account_chooser_account_add_foreach (account, chooser);
496 account_chooser_account_add_foreach (EmpathyAccount *account,
497 EmpathyAccountChooser *chooser)
500 GtkComboBox *combobox;
504 combobox = GTK_COMBO_BOX (chooser);
505 store = GTK_LIST_STORE (gtk_combo_box_get_model (combobox));
507 position = gtk_tree_model_iter_n_children (GTK_TREE_MODEL (store), NULL);
508 gtk_list_store_insert_with_values (store, &iter, position,
509 COL_ACCOUNT_POINTER, account,
511 account_chooser_update_iter (chooser, &iter);
512 /* We got a reffed account and it was reffed by the liststore as well */
513 g_object_unref (account);
517 account_chooser_account_deleted_cb (EmpathyAccountManager *manager,
518 EmpathyAccount *account,
519 EmpathyAccountChooser *chooser)
521 account_chooser_account_remove_foreach (account, chooser);
525 EmpathyAccount *account;
531 account_chooser_find_account_foreach (GtkTreeModel *model,
536 FindAccountData *data = user_data;
537 EmpathyAccount *account;
539 gtk_tree_model_get (model, iter, COL_ACCOUNT_POINTER, &account, -1);
541 if (empathy_account_equal (account, data->account)) {
543 *(data->iter) = *iter;
544 g_object_unref (account);
549 g_object_unref (account);
555 account_chooser_find_account (EmpathyAccountChooser *chooser,
556 EmpathyAccount *account,
560 GtkComboBox *combobox;
561 FindAccountData data;
563 combobox = GTK_COMBO_BOX (chooser);
564 store = GTK_LIST_STORE (gtk_combo_box_get_model (combobox));
566 data.account = account;
568 gtk_tree_model_foreach (GTK_TREE_MODEL (store),
569 account_chooser_find_account_foreach,
576 account_chooser_account_remove_foreach (EmpathyAccount *account,
577 EmpathyAccountChooser *chooser)
580 GtkComboBox *combobox;
583 combobox = GTK_COMBO_BOX (chooser);
584 store = GTK_LIST_STORE (gtk_combo_box_get_model (combobox));
586 if (account_chooser_find_account (chooser, account, &iter)) {
587 gtk_list_store_remove (store, &iter);
592 account_chooser_update_iter (EmpathyAccountChooser *chooser,
595 EmpathyAccountChooserPriv *priv;
597 GtkComboBox *combobox;
598 EmpathyAccount *account;
599 const gchar *icon_name;
600 gboolean is_enabled = TRUE;
602 priv = GET_PRIV (chooser);
604 combobox = GTK_COMBO_BOX (chooser);
605 store = GTK_LIST_STORE (gtk_combo_box_get_model (combobox));
607 gtk_tree_model_get (GTK_TREE_MODEL (store), iter,
608 COL_ACCOUNT_POINTER, &account,
611 icon_name = empathy_account_get_icon_name (account);
613 is_enabled = priv->filter (account, priv->filter_data);
616 gtk_list_store_set (store, iter,
617 COL_ACCOUNT_IMAGE, icon_name,
618 COL_ACCOUNT_TEXT, empathy_account_get_display_name (account),
619 COL_ACCOUNT_ENABLED, is_enabled,
622 /* set first connected account as active account */
623 if (priv->set_active_item == FALSE && is_enabled) {
624 priv->set_active_item = TRUE;
625 gtk_combo_box_set_active_iter (combobox, iter);
628 g_object_unref (account);
632 account_chooser_connection_changed_cb (EmpathyAccountManager *manager,
633 EmpathyAccount *account,
634 TpConnectionStatusReason reason,
635 TpConnectionStatus new_status,
636 TpConnectionStatus old_status,
637 EmpathyAccountChooser *chooser)
641 if (account_chooser_find_account (chooser, account, &iter)) {
642 account_chooser_update_iter (chooser, &iter);
647 account_chooser_separator_func (GtkTreeModel *model,
649 EmpathyAccountChooser *chooser)
651 EmpathyAccountChooserPriv *priv;
653 gboolean is_separator;
655 priv = GET_PRIV (chooser);
657 if (!priv->has_all_option) {
661 gtk_tree_model_get (model, iter, COL_ACCOUNT_TEXT, &text, -1);
662 is_separator = text == NULL;
669 account_chooser_set_account_foreach (GtkTreeModel *model,
672 SetAccountData *data)
674 EmpathyAccount *account;
677 gtk_tree_model_get (model, iter, COL_ACCOUNT_POINTER, &account, -1);
679 /* Special case so we can make it possible to select the All option */
680 if ((data->account == NULL) != (account == NULL)) {
683 else if (data->account == account) {
686 equal = empathy_account_equal (data->account, account);
690 g_object_unref (account);
694 GtkComboBox *combobox;
696 combobox = GTK_COMBO_BOX (data->chooser);
697 gtk_combo_box_set_active_iter (combobox, iter);
706 account_chooser_filter_foreach (GtkTreeModel *model,
711 account_chooser_update_iter (chooser, iter);
716 * empathy_account_chooser_set_filter:
717 * @chooser: an #EmpathyAccountChooser
719 * @user_data: data to pass to @filter, or %NULL
721 * Sets a filter on the @chooser so only accounts that are %TRUE in the eyes
722 * of the filter are visible in the @chooser.
725 empathy_account_chooser_set_filter (EmpathyAccountChooser *chooser,
726 EmpathyAccountChooserFilterFunc filter,
729 EmpathyAccountChooserPriv *priv;
732 g_return_if_fail (EMPATHY_IS_ACCOUNT_CHOOSER (chooser));
734 priv = GET_PRIV (chooser);
736 priv->filter = filter;
737 priv->filter_data = user_data;
739 /* Refilter existing data */
740 priv->set_active_item = FALSE;
741 model = gtk_combo_box_get_model (GTK_COMBO_BOX (chooser));
742 gtk_tree_model_foreach (model, account_chooser_filter_foreach, chooser);
746 * EmpathyAccountChooserFilterFunc:
747 * @account: an #EmpathyAccount
748 * @user_data: user data, or %NULL
750 * A function which decides whether the account indicated by @account
753 * Return value: whether the account indicated by @account is visible.
757 * empathy_account_chooser_filter_is_connected:
758 * @account: an #EmpathyAccount
759 * @user_data: user data or %NULL
761 * A useful #EmpathyAccountChooserFilterFunc that one could pass into
762 * empathy_account_chooser_set_filter() and only show connected accounts.
764 * Return value: Whether @account is connected
767 empathy_account_chooser_filter_is_connected (EmpathyAccount *account,
770 TpConnectionStatus status;
772 g_object_get (account, "connection-status", &status, NULL);
774 return status == TP_CONNECTION_STATUS_CONNECTED;