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>
23 #include "empathy-groups-widget.h"
25 #include <glib/gi18n-lib.h>
27 #include "empathy-utils.h"
28 #include "empathy-connection-aggregator.h"
31 * SECTION:empathy-groups-widget
32 * @title:EmpathyGroupsWidget
33 * @short_description: A widget used to edit the groups of a #FolksGroupDetails
34 * @include: libempathy-gtk/empathy-groups-widget.h
36 * #EmpathyGroupsWidget is a widget which lists the groups of a
37 * #FolksGroupDetails (i.e. a #FolksPersona or a #FolksIndividual) and allows
38 * them to be added and removed.
42 * EmpathyGroupsWidget:
43 * @parent: parent object
45 * Widget which displays and allows editing of the groups of a
46 * #FolksGroupDetails (i.e. a #FolksPersona or #FolksIndividual).
49 /* Delay before updating the widget when the id entry changed (seconds) */
50 #define ID_CHANGED_TIMEOUT 1
52 #define GET_PRIV(obj) EMPATHY_GET_PRIV (obj, EmpathyGroupsWidget)
56 /* The object we're actually changing the groups of */
57 FolksGroupDetails *group_details; /* owned */
58 GtkListStore *group_store; /* owned */
60 GtkWidget *add_group_entry; /* child widget */
61 GtkWidget *add_group_button; /* child widget */
62 } EmpathyGroupsWidgetPriv;
65 PROP_GROUP_DETAILS = 1,
73 #define NUM_COLUMNS COL_EDITABLE + 1
75 G_DEFINE_TYPE (EmpathyGroupsWidget, empathy_groups_widget, GTK_TYPE_BOX);
79 EmpathyGroupsWidget *widget;
82 GtkTreeIter found_iter;
86 model_find_name_foreach (GtkTreeModel *model,
93 gtk_tree_model_get (model, iter,
97 if (name != NULL && strcmp (data->name, name) == 0)
100 data->found_iter = *iter;
113 model_find_name (EmpathyGroupsWidget *self,
117 EmpathyGroupsWidgetPriv *priv = GET_PRIV (self);
120 if (EMP_STR_EMPTY (name))
127 gtk_tree_model_foreach (GTK_TREE_MODEL (priv->group_store),
128 (GtkTreeModelForeachFunc) model_find_name_foreach, &data);
130 if (data.found == TRUE)
132 *iter = data.found_iter;
140 populate_data (EmpathyGroupsWidget *self)
142 EmpathyGroupsWidgetPriv *priv = GET_PRIV (self);
143 EmpathyConnectionAggregator *aggregator;
144 GeeSet *member_groups;
145 GList *all_groups, *l;
147 /* Remove the old groups */
148 gtk_list_store_clear (priv->group_store);
150 /* FIXME: We have to get the whole group list from
151 * EmpathyConnectionAggregator, as libfolks hasn't grown API to get the whole
152 * group list yet. (bgo#627398) */
153 aggregator = empathy_connection_aggregator_dup_singleton ();
154 all_groups = empathy_connection_aggregator_get_all_groups (aggregator);
155 g_object_unref (aggregator);
157 /* Get the list of groups that this #FolksGroupDetails is currently in */
158 member_groups = folks_group_details_get_groups (priv->group_details);
160 for (l = all_groups; l != NULL; l = l->next)
162 const gchar *group_str = l->data;
165 enabled = gee_collection_contains (GEE_COLLECTION (member_groups),
168 gtk_list_store_insert_with_values (priv->group_store, NULL, -1,
171 COL_ENABLED, enabled,
175 g_list_free (all_groups);
179 add_group_entry_changed_cb (GtkEditable *editable,
180 EmpathyGroupsWidget *self)
182 EmpathyGroupsWidgetPriv *priv = GET_PRIV (self);
186 group = gtk_entry_get_text (GTK_ENTRY (priv->add_group_entry));
188 if (model_find_name (self, group, &iter))
190 gtk_widget_set_sensitive (GTK_WIDGET (priv->add_group_button), FALSE);
194 gtk_widget_set_sensitive (GTK_WIDGET (priv->add_group_button),
195 !EMP_STR_EMPTY (group));
200 add_group_entry_activate_cb (GtkEntry *entry,
201 EmpathyGroupsWidget *self)
203 gtk_widget_activate (GTK_WIDGET (GET_PRIV (self)->add_group_button));
207 change_group_cb (FolksGroupDetails *group_details,
208 GAsyncResult *async_result,
209 EmpathyGroupsWidget *self)
211 GError *error = NULL;
213 folks_group_details_change_group_finish (group_details, async_result, &error);
217 g_warning ("Failed to change group: %s", error->message);
218 g_clear_error (&error);
223 add_group_button_clicked_cb (GtkButton *button,
224 EmpathyGroupsWidget *self)
226 EmpathyGroupsWidgetPriv *priv = GET_PRIV (self);
229 group = gtk_entry_get_text (GTK_ENTRY (priv->add_group_entry));
231 gtk_list_store_insert_with_values (priv->group_store, NULL, -1,
236 folks_group_details_change_group (priv->group_details, group, TRUE,
237 (GAsyncReadyCallback) change_group_cb, self);
241 cell_toggled_cb (GtkCellRendererToggle *cell,
242 const gchar *path_string,
243 EmpathyGroupsWidget *self)
245 EmpathyGroupsWidgetPriv *priv = GET_PRIV (self);
248 gboolean was_enabled;
251 path = gtk_tree_path_new_from_string (path_string);
253 gtk_tree_model_get_iter (GTK_TREE_MODEL (priv->group_store), &iter,
255 gtk_tree_model_get (GTK_TREE_MODEL (priv->group_store), &iter,
256 COL_ENABLED, &was_enabled,
260 gtk_list_store_set (priv->group_store, &iter,
261 COL_ENABLED, !was_enabled,
264 gtk_tree_path_free (path);
268 folks_group_details_change_group (priv->group_details, group,
269 !was_enabled, (GAsyncReadyCallback) change_group_cb, self);
276 group_details_group_changed_cb (FolksGroupDetails *groups,
279 EmpathyGroupsWidget *self)
281 EmpathyGroupsWidgetPriv *priv = GET_PRIV (self);
284 if (model_find_name (self, group, &iter) == TRUE)
286 gtk_list_store_set (priv->group_store, &iter,
287 COL_ENABLED, is_member,
293 set_up (EmpathyGroupsWidget *self)
295 EmpathyGroupsWidgetPriv *priv;
296 GtkWidget *label, *alignment;
298 GtkTreeView *tree_view;
299 GtkTreeSelection *selection;
300 GtkTreeViewColumn *column;
301 GtkCellRenderer *renderer;
303 GtkScrolledWindow *scrolled_window;
306 priv = GET_PRIV (self);
309 gtk_orientable_set_orientation (GTK_ORIENTABLE (self),
310 GTK_ORIENTATION_VERTICAL);
311 gtk_box_set_spacing (GTK_BOX (self), 6);
313 /* Create our child widgets */
314 label = gtk_label_new (NULL);
315 gtk_misc_set_alignment (GTK_MISC (label), 0.0, 0.5);
317 markup = g_strdup_printf ("<b>%s</b>", _("Groups"));
318 gtk_label_set_markup (GTK_LABEL (label), markup);
321 gtk_box_pack_start (GTK_BOX (self), label, FALSE, FALSE, 0);
322 gtk_widget_show (label);
324 alignment = gtk_alignment_new (0.5, 0.5, 1.0, 1.0);
325 gtk_alignment_set_padding (GTK_ALIGNMENT (alignment), 0, 0, 12, 0);
327 vbox = GTK_BOX (gtk_box_new (GTK_ORIENTATION_VERTICAL, 6));
329 label = gtk_label_new (_("Select the groups you want this contact to appear "
330 "in. Note that you can select more than one group or no groups."));
331 gtk_misc_set_alignment (GTK_MISC (label), 0.0, 0.5);
332 gtk_label_set_line_wrap (GTK_LABEL (label), TRUE);
334 gtk_box_pack_start (vbox, label, FALSE, FALSE, 0);
335 gtk_widget_show (label);
337 hbox = GTK_BOX (gtk_box_new (GTK_ORIENTATION_HORIZONTAL, 12));
339 priv->add_group_entry = gtk_entry_new ();
340 g_signal_connect (priv->add_group_entry, "changed",
341 (GCallback) add_group_entry_changed_cb, self);
342 g_signal_connect (priv->add_group_entry, "activate",
343 (GCallback) add_group_entry_activate_cb, self);
345 gtk_box_pack_start (hbox, priv->add_group_entry, TRUE, TRUE, 0);
346 gtk_widget_show (priv->add_group_entry);
348 priv->add_group_button = gtk_button_new_with_mnemonic (_("_Add Group"));
349 gtk_widget_set_sensitive (priv->add_group_button, FALSE);
350 gtk_widget_set_receives_default (priv->add_group_button, TRUE);
351 g_signal_connect (priv->add_group_button, "clicked",
352 (GCallback) add_group_button_clicked_cb, self);
354 gtk_box_pack_start (hbox, priv->add_group_button, FALSE, FALSE, 0);
355 gtk_widget_show (priv->add_group_button);
357 gtk_box_pack_start (vbox, GTK_WIDGET (hbox), FALSE, FALSE, 0);
358 gtk_widget_show (GTK_WIDGET (hbox));
360 scrolled_window = GTK_SCROLLED_WINDOW (gtk_scrolled_window_new (NULL, NULL));
361 gtk_scrolled_window_set_policy (scrolled_window, GTK_POLICY_NEVER,
362 GTK_POLICY_AUTOMATIC);
363 gtk_scrolled_window_set_shadow_type (scrolled_window, GTK_SHADOW_IN);
364 gtk_widget_set_size_request (GTK_WIDGET (scrolled_window), -1, 100);
366 priv->group_store = gtk_list_store_new (NUM_COLUMNS,
367 G_TYPE_STRING, /* name */
368 G_TYPE_BOOLEAN, /* enabled */
369 G_TYPE_BOOLEAN); /* editable */
371 tree_view = GTK_TREE_VIEW (gtk_tree_view_new_with_model (
372 GTK_TREE_MODEL (priv->group_store)));
373 gtk_tree_view_set_headers_visible (tree_view, FALSE);
374 gtk_tree_view_set_enable_search (tree_view, FALSE);
376 selection = gtk_tree_view_get_selection (tree_view);
377 gtk_tree_selection_set_mode (selection, GTK_SELECTION_SINGLE);
379 renderer = gtk_cell_renderer_toggle_new ();
380 g_signal_connect (renderer, "toggled", (GCallback) cell_toggled_cb, self);
382 column = gtk_tree_view_column_new_with_attributes (
383 C_("verb in a column header displaying group names", "Select"), renderer,
384 "active", COL_ENABLED,
387 gtk_tree_view_column_set_sizing (column, GTK_TREE_VIEW_COLUMN_FIXED);
388 gtk_tree_view_column_set_fixed_width (column, 50);
389 gtk_tree_view_append_column (tree_view, column);
391 renderer = gtk_cell_renderer_text_new ();
392 col_offset = gtk_tree_view_insert_column_with_attributes (tree_view,
396 /* "editable", COL_EDITABLE, */
399 column = gtk_tree_view_get_column (tree_view, col_offset - 1);
400 gtk_tree_view_column_set_sort_column_id (column, COL_NAME);
401 gtk_tree_view_column_set_resizable (column, FALSE);
402 gtk_tree_view_column_set_clickable (GTK_TREE_VIEW_COLUMN (column), TRUE);
404 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (priv->group_store),
405 COL_NAME, GTK_SORT_ASCENDING);
407 gtk_container_add (GTK_CONTAINER (scrolled_window), GTK_WIDGET (tree_view));
408 gtk_widget_show (GTK_WIDGET (tree_view));
410 gtk_box_pack_start (vbox, GTK_WIDGET (scrolled_window), TRUE, TRUE, 0);
411 gtk_widget_show (GTK_WIDGET (scrolled_window));
413 gtk_container_add (GTK_CONTAINER (alignment), GTK_WIDGET (vbox));
414 gtk_widget_show (GTK_WIDGET (vbox));
416 gtk_box_pack_start (GTK_BOX (self), alignment, TRUE, TRUE, 0);
417 gtk_widget_show (alignment);
421 empathy_groups_widget_init (EmpathyGroupsWidget *self)
423 self->priv = G_TYPE_INSTANCE_GET_PRIVATE (self,
424 EMPATHY_TYPE_GROUPS_WIDGET, EmpathyGroupsWidgetPriv);
430 get_property (GObject *object,
435 EmpathyGroupsWidgetPriv *priv;
437 priv = GET_PRIV (object);
441 case PROP_GROUP_DETAILS:
442 g_value_set_object (value, priv->group_details);
445 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
451 set_property (GObject *object,
458 case PROP_GROUP_DETAILS:
459 empathy_groups_widget_set_group_details (EMPATHY_GROUPS_WIDGET (object),
460 g_value_get_object (value));
463 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
469 dispose (GObject *object)
471 EmpathyGroupsWidgetPriv *priv = GET_PRIV (object);
473 empathy_groups_widget_set_group_details (EMPATHY_GROUPS_WIDGET (object),
475 tp_clear_object (&priv->group_store);
477 G_OBJECT_CLASS (empathy_groups_widget_parent_class)->dispose (object);
481 empathy_groups_widget_class_init (EmpathyGroupsWidgetClass *klass)
483 GObjectClass *object_class = G_OBJECT_CLASS (klass);
485 object_class->get_property = get_property;
486 object_class->set_property = set_property;
487 object_class->dispose = dispose;
490 * EmpathyGroupsWidget:group_details:
492 * The #FolksGroupDetails whose group membership is to be edited by the
493 * #EmpathyGroupsWidget.
495 g_object_class_install_property (object_class, PROP_GROUP_DETAILS,
496 g_param_spec_object ("group-details",
498 "The #FolksGroupDetails whose groups are being edited.",
499 FOLKS_TYPE_GROUP_DETAILS,
500 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
502 g_type_class_add_private (object_class, sizeof (EmpathyGroupsWidgetPriv));
506 * empathy_groups_widget_new:
507 * @group_details: a #FolksGroupDetails, or %NULL
509 * Creates a new #EmpathyGroupsWidget to edit the groups of the given
512 * Return value: a new #EmpathyGroupsWidget
515 empathy_groups_widget_new (FolksGroupDetails *group_details)
517 g_return_val_if_fail (
518 group_details == NULL || FOLKS_IS_GROUP_DETAILS (group_details),
521 return GTK_WIDGET (g_object_new (EMPATHY_TYPE_GROUPS_WIDGET,
522 "group-details", group_details,
527 * empathy_groups_widget_get_group_details:
528 * @self: an #EmpathyGroupsWidget
530 * Get the #FolksGroupDetails whose group membership is being edited by the
531 * #EmpathyGroupsWidget.
533 * Returns: the #FolksGroupDetails associated with @widget, or %NULL
536 empathy_groups_widget_get_group_details (EmpathyGroupsWidget *self)
538 g_return_val_if_fail (EMPATHY_IS_GROUPS_WIDGET (self), NULL);
540 return GET_PRIV (self)->group_details;
544 * empathy_groups_widget_set_group_details:
545 * @self: an #EmpathyGroupsWidget
546 * @group_details: the #FolksGroupDetails whose membership is to be edited, or
549 * Change the #FolksGroupDetails whose group membership is to be edited by the
550 * #EmpathyGroupsWidget.
553 empathy_groups_widget_set_group_details (EmpathyGroupsWidget *self,
554 FolksGroupDetails *group_details)
556 EmpathyGroupsWidgetPriv *priv;
558 g_return_if_fail (EMPATHY_IS_GROUPS_WIDGET (self));
560 group_details == NULL || FOLKS_IS_GROUP_DETAILS (group_details));
562 priv = GET_PRIV (self);
564 if (group_details == priv->group_details)
567 if (priv->group_details != NULL)
569 g_signal_handlers_disconnect_by_func (priv->group_details,
570 group_details_group_changed_cb, self);
573 tp_clear_object (&priv->group_details);
575 if (group_details != NULL)
577 priv->group_details = g_object_ref (group_details);
579 g_signal_connect (priv->group_details, "group-changed",
580 (GCallback) group_details_group_changed_cb, self);
582 populate_data (self);
585 g_object_notify (G_OBJECT (self), "group-details");