2 * Copyright (C) 2007-2010 Collabora Ltd.
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18 * Authors: Xavier Claessens <xclaesse@gmail.com>
19 * Philip Withnall <philip.withnall@collabora.co.uk>
28 #include <glib/gi18n-lib.h>
30 #include <telepathy-glib/util.h>
32 #include <folks/folks.h>
34 #include <libempathy/empathy-utils.h>
35 #include <libempathy/empathy-contact-manager.h>
37 #include "empathy-groups-widget.h"
38 #include "empathy-ui-utils.h"
41 * SECTION:empathy-groups-widget
42 * @title:EmpathyGroupsWidget
43 * @short_description: A widget used to edit the groups of a #FolksGroupDetails
44 * @include: libempathy-gtk/empathy-groups-widget.h
46 * #EmpathyGroupsWidget is a widget which lists the groups of a
47 * #FolksGroupDetails (i.e. a #FolksPersona or a #FolksIndividual) and allows
48 * them to be added and removed.
52 * EmpathyGroupsWidget:
53 * @parent: parent object
55 * Widget which displays and allows editing of the groups of a
56 * #FolksGroupDetails (i.e. a #FolksPersona or #FolksIndividual).
59 /* Delay before updating the widget when the id entry changed (seconds) */
60 #define ID_CHANGED_TIMEOUT 1
62 #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyGroupsWidget)
66 /* The object we're actually changing the groups of */
67 FolksGroupDetails *group_details; /* owned */
68 GtkListStore *group_store; /* owned */
70 GtkWidget *add_group_entry; /* child widget */
71 GtkWidget *add_group_button; /* child widget */
72 } EmpathyGroupsWidgetPriv;
75 PROP_GROUP_DETAILS = 1,
83 #define NUM_COLUMNS COL_EDITABLE + 1
85 G_DEFINE_TYPE (EmpathyGroupsWidget, empathy_groups_widget, GTK_TYPE_BOX);
89 EmpathyGroupsWidget *widget;
92 GtkTreeIter found_iter;
96 model_find_name_foreach (GtkTreeModel *model,
103 gtk_tree_model_get (model, iter,
107 if (name != NULL && strcmp (data->name, name) == 0)
110 data->found_iter = *iter;
123 model_find_name (EmpathyGroupsWidget *self,
127 EmpathyGroupsWidgetPriv *priv = GET_PRIV (self);
130 if (EMP_STR_EMPTY (name))
137 gtk_tree_model_foreach (GTK_TREE_MODEL (priv->group_store),
138 (GtkTreeModelForeachFunc) model_find_name_foreach, &data);
140 if (data.found == TRUE)
142 *iter = data.found_iter;
150 populate_data (EmpathyGroupsWidget *self)
152 EmpathyGroupsWidgetPriv *priv = GET_PRIV (self);
153 EmpathyContactManager *manager;
155 GHashTable *my_groups;
156 GList *all_groups, *l;
158 /* Remove the old groups */
159 gtk_list_store_clear (priv->group_store);
161 /* FIXME: We have to get the whole group list from EmpathyContactManager, as
162 * libfolks hasn't grown API to get the whole group list yet. (bgo#627398) */
163 manager = empathy_contact_manager_dup_singleton ();
164 all_groups = empathy_contact_list_get_all_groups (
165 EMPATHY_CONTACT_LIST (manager));
166 g_object_unref (manager);
168 /* Get the list of groups that this #FolksGroupDetails is currently in */
169 my_groups = folks_group_details_get_groups (priv->group_details);
171 for (l = all_groups; l != NULL; l = l->next)
173 const gchar *group_str = l->data;
176 enabled = GPOINTER_TO_UINT (g_hash_table_lookup (my_groups, group_str));
178 gtk_list_store_append (priv->group_store, &iter);
179 gtk_list_store_set (priv->group_store, &iter,
182 COL_ENABLED, enabled,
188 g_list_free (all_groups);
192 add_group_entry_changed_cb (GtkEditable *editable,
193 EmpathyGroupsWidget *self)
195 EmpathyGroupsWidgetPriv *priv = GET_PRIV (self);
199 group = gtk_entry_get_text (GTK_ENTRY (priv->add_group_entry));
201 if (model_find_name (self, group, &iter))
203 gtk_widget_set_sensitive (GTK_WIDGET (priv->add_group_button), FALSE);
207 gtk_widget_set_sensitive (GTK_WIDGET (priv->add_group_button),
208 !EMP_STR_EMPTY (group));
213 add_group_entry_activate_cb (GtkEntry *entry,
214 EmpathyGroupsWidget *self)
216 gtk_widget_activate (GTK_WIDGET (GET_PRIV (self)->add_group_button));
220 change_group_cb (FolksGroupDetails *group_details,
221 GAsyncResult *async_result,
222 EmpathyGroupsWidget *self)
224 GError *error = NULL;
226 folks_group_details_change_group_finish (group_details, async_result, &error);
230 g_warning ("Failed to change group: %s", error->message);
231 g_clear_error (&error);
236 add_group_button_clicked_cb (GtkButton *button,
237 EmpathyGroupsWidget *self)
239 EmpathyGroupsWidgetPriv *priv = GET_PRIV (self);
243 group = gtk_entry_get_text (GTK_ENTRY (priv->add_group_entry));
245 gtk_list_store_append (priv->group_store, &iter);
246 gtk_list_store_set (priv->group_store, &iter,
251 folks_group_details_change_group (priv->group_details, group, TRUE,
252 (GAsyncReadyCallback) change_group_cb, self);
256 cell_toggled_cb (GtkCellRendererToggle *cell,
257 const gchar *path_string,
258 EmpathyGroupsWidget *self)
260 EmpathyGroupsWidgetPriv *priv = GET_PRIV (self);
263 gboolean was_enabled;
266 path = gtk_tree_path_new_from_string (path_string);
268 gtk_tree_model_get_iter (GTK_TREE_MODEL (priv->group_store), &iter,
270 gtk_tree_model_get (GTK_TREE_MODEL (priv->group_store), &iter,
271 COL_ENABLED, &was_enabled,
275 gtk_list_store_set (priv->group_store, &iter,
276 COL_ENABLED, !was_enabled,
279 gtk_tree_path_free (path);
283 folks_group_details_change_group (priv->group_details, group,
284 !was_enabled, (GAsyncReadyCallback) change_group_cb, self);
291 group_details_group_changed_cb (FolksGroupDetails *groups,
294 EmpathyGroupsWidget *self)
296 EmpathyGroupsWidgetPriv *priv = GET_PRIV (self);
299 if (model_find_name (self, group, &iter) == TRUE)
301 gtk_list_store_set (priv->group_store, &iter,
302 COL_ENABLED, is_member,
308 set_up (EmpathyGroupsWidget *self)
310 EmpathyGroupsWidgetPriv *priv;
311 GtkWidget *label, *alignment;
313 GtkTreeView *tree_view;
314 GtkTreeSelection *selection;
315 GtkTreeViewColumn *column;
316 GtkCellRenderer *renderer;
318 GtkScrolledWindow *scrolled_window;
321 priv = GET_PRIV (self);
324 gtk_orientable_set_orientation (GTK_ORIENTABLE (self),
325 GTK_ORIENTATION_VERTICAL);
326 gtk_box_set_spacing (GTK_BOX (self), 6);
328 /* Create our child widgets */
329 label = gtk_label_new (NULL);
330 gtk_misc_set_alignment (GTK_MISC (label), 0.0, 0.5);
332 markup = g_strdup_printf ("<b>%s</b>", _("Groups"));
333 gtk_label_set_markup (GTK_LABEL (label), markup);
336 gtk_box_pack_start (GTK_BOX (self), label, FALSE, FALSE, 0);
337 gtk_widget_show (label);
339 alignment = gtk_alignment_new (0.5, 0.5, 1.0, 1.0);
340 gtk_alignment_set_padding (GTK_ALIGNMENT (alignment), 0, 0, 12, 0);
342 vbox = GTK_BOX (gtk_vbox_new (FALSE, 6));
344 label = gtk_label_new (_("Select the groups you want this contact to appear "
345 "in. Note that you can select more than one group or no groups."));
346 gtk_misc_set_alignment (GTK_MISC (label), 0.0, 0.5);
347 gtk_label_set_line_wrap (GTK_LABEL (label), TRUE);
349 gtk_box_pack_start (vbox, label, FALSE, FALSE, 0);
350 gtk_widget_show (label);
352 hbox = GTK_BOX (gtk_hbox_new (FALSE, 12));
354 priv->add_group_entry = gtk_entry_new ();
355 g_signal_connect (priv->add_group_entry, "changed",
356 (GCallback) add_group_entry_changed_cb, self);
357 g_signal_connect (priv->add_group_entry, "activate",
358 (GCallback) add_group_entry_activate_cb, self);
360 gtk_box_pack_start (hbox, priv->add_group_entry, TRUE, TRUE, 0);
361 gtk_widget_show (priv->add_group_entry);
363 priv->add_group_button = gtk_button_new_with_mnemonic (_("_Add Group"));
364 gtk_widget_set_sensitive (priv->add_group_button, FALSE);
365 gtk_widget_set_receives_default (priv->add_group_button, TRUE);
366 g_signal_connect (priv->add_group_button, "clicked",
367 (GCallback) add_group_button_clicked_cb, self);
369 gtk_box_pack_start (hbox, priv->add_group_button, FALSE, FALSE, 0);
370 gtk_widget_show (priv->add_group_button);
372 gtk_box_pack_start (vbox, GTK_WIDGET (hbox), FALSE, FALSE, 0);
373 gtk_widget_show (GTK_WIDGET (hbox));
375 scrolled_window = GTK_SCROLLED_WINDOW (gtk_scrolled_window_new (NULL, NULL));
376 gtk_scrolled_window_set_policy (scrolled_window, GTK_POLICY_NEVER,
377 GTK_POLICY_AUTOMATIC);
378 gtk_scrolled_window_set_shadow_type (scrolled_window, GTK_SHADOW_IN);
379 gtk_widget_set_size_request (GTK_WIDGET (scrolled_window), -1, 100);
381 priv->group_store = gtk_list_store_new (NUM_COLUMNS,
382 G_TYPE_STRING, /* name */
383 G_TYPE_BOOLEAN, /* enabled */
384 G_TYPE_BOOLEAN); /* editable */
386 tree_view = GTK_TREE_VIEW (gtk_tree_view_new_with_model (
387 GTK_TREE_MODEL (priv->group_store)));
388 gtk_tree_view_set_headers_visible (tree_view, FALSE);
389 gtk_tree_view_set_enable_search (tree_view, FALSE);
391 selection = gtk_tree_view_get_selection (tree_view);
392 gtk_tree_selection_set_mode (selection, GTK_SELECTION_SINGLE);
394 renderer = gtk_cell_renderer_toggle_new ();
395 g_signal_connect (renderer, "toggled", (GCallback) cell_toggled_cb, self);
397 column = gtk_tree_view_column_new_with_attributes (
398 C_("verb in a column header displaying group names", "Select"), renderer,
399 "active", COL_ENABLED,
402 gtk_tree_view_column_set_sizing (column, GTK_TREE_VIEW_COLUMN_FIXED);
403 gtk_tree_view_column_set_fixed_width (column, 50);
404 gtk_tree_view_append_column (tree_view, column);
406 renderer = gtk_cell_renderer_text_new ();
407 col_offset = gtk_tree_view_insert_column_with_attributes (tree_view,
411 /* "editable", COL_EDITABLE, */
414 column = gtk_tree_view_get_column (tree_view, col_offset - 1);
415 gtk_tree_view_column_set_sort_column_id (column, COL_NAME);
416 gtk_tree_view_column_set_resizable (column, FALSE);
417 gtk_tree_view_column_set_clickable (GTK_TREE_VIEW_COLUMN (column), TRUE);
419 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (priv->group_store),
420 COL_NAME, GTK_SORT_ASCENDING);
422 gtk_container_add (GTK_CONTAINER (scrolled_window), GTK_WIDGET (tree_view));
423 gtk_widget_show (GTK_WIDGET (tree_view));
425 gtk_box_pack_start (vbox, GTK_WIDGET (scrolled_window), TRUE, TRUE, 0);
426 gtk_widget_show (GTK_WIDGET (scrolled_window));
428 gtk_container_add (GTK_CONTAINER (alignment), GTK_WIDGET (vbox));
429 gtk_widget_show (GTK_WIDGET (vbox));
431 gtk_box_pack_start (GTK_BOX (self), alignment, TRUE, TRUE, 0);
432 gtk_widget_show (alignment);
436 empathy_groups_widget_init (EmpathyGroupsWidget *self)
438 self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self,
439 EMPATHY_TYPE_GROUPS_WIDGET, EmpathyGroupsWidgetPriv);
445 get_property (GObject *object,
450 EmpathyGroupsWidgetPriv *priv;
452 priv = GET_PRIV (object);
456 case PROP_GROUP_DETAILS:
457 g_value_set_object (value, priv->group_details);
460 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
466 set_property (GObject *object,
473 case PROP_GROUP_DETAILS:
474 empathy_groups_widget_set_group_details (EMPATHY_GROUPS_WIDGET (object),
475 g_value_get_object (value));
478 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
484 dispose (GObject *object)
486 EmpathyGroupsWidgetPriv *priv = GET_PRIV (object);
488 empathy_groups_widget_set_group_details (EMPATHY_GROUPS_WIDGET (object),
490 tp_clear_object (&priv->group_store);
492 G_OBJECT_CLASS (empathy_groups_widget_parent_class)->dispose (object);
496 empathy_groups_widget_class_init (EmpathyGroupsWidgetClass *klass)
498 GObjectClass *object_class = G_OBJECT_CLASS (klass);
500 object_class->get_property = get_property;
501 object_class->set_property = set_property;
502 object_class->dispose = dispose;
505 * EmpathyGroupsWidget:group_details:
507 * The #FolksGroupDetails whose group membership is to be edited by the
508 * #EmpathyGroupsWidget.
510 g_object_class_install_property (object_class, PROP_GROUP_DETAILS,
511 g_param_spec_object ("group-details",
513 "The #FolksGroupDetails whose groups are being edited.",
514 FOLKS_TYPE_GROUP_DETAILS,
515 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
517 g_type_class_add_private (object_class, sizeof (EmpathyGroupsWidgetPriv));
521 * empathy_groups_widget_new:
522 * @group_details: a #FolksGroupDetails, or %NULL
524 * Creates a new #EmpathyGroupsWidget to edit the groups of the given
527 * Return value: a new #EmpathyGroupsWidget
530 empathy_groups_widget_new (FolksGroupDetails *group_details)
532 g_return_val_if_fail (
533 group_details == NULL || FOLKS_IS_GROUP_DETAILS (group_details),
536 return GTK_WIDGET (g_object_new (EMPATHY_TYPE_GROUPS_WIDGET,
537 "group-details", group_details,
542 * empathy_groups_widget_get_group_details:
543 * @self: an #EmpathyGroupsWidget
545 * Get the #FolksGroupDetails whose group membership is being edited by the
546 * #EmpathyGroupsWidget.
548 * Returns: the #FolksGroupDetails associated with @widget, or %NULL
551 empathy_groups_widget_get_group_details (EmpathyGroupsWidget *self)
553 g_return_val_if_fail (EMPATHY_IS_GROUPS_WIDGET (self), NULL);
555 return GET_PRIV (self)->group_details;
559 * empathy_groups_widget_set_group_details:
560 * @self: an #EmpathyGroupsWidget
561 * @group_details: the #FolksGroupDetails whose membership is to be edited, or
564 * Change the #FolksGroupDetails whose group membership is to be edited by the
565 * #EmpathyGroupsWidget.
568 empathy_groups_widget_set_group_details (EmpathyGroupsWidget *self,
569 FolksGroupDetails *group_details)
571 EmpathyGroupsWidgetPriv *priv;
573 g_return_if_fail (EMPATHY_IS_GROUPS_WIDGET (self));
575 group_details == NULL || FOLKS_IS_GROUP_DETAILS (group_details));
577 priv = GET_PRIV (self);
579 if (group_details == priv->group_details)
582 if (priv->group_details != NULL)
584 g_signal_handlers_disconnect_by_func (priv->group_details,
585 group_details_group_changed_cb, self);
588 tp_clear_object (&priv->group_details);
590 if (group_details != NULL)
592 priv->group_details = g_object_ref (group_details);
594 g_signal_connect (priv->group_details, "group-changed",
595 (GCallback) group_details_group_changed_cb, self);
597 populate_data (self);
600 g_object_notify (G_OBJECT (self), "group-details");