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 GeeSet
*member_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 member_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
= gee_collection_contains (GEE_COLLECTION (member_groups
),
179 gtk_list_store_append (priv
->group_store
, &iter
);
180 gtk_list_store_set (priv
->group_store
, &iter
,
183 COL_ENABLED
, enabled
,
189 g_list_free (all_groups
);
193 add_group_entry_changed_cb (GtkEditable
*editable
,
194 EmpathyGroupsWidget
*self
)
196 EmpathyGroupsWidgetPriv
*priv
= GET_PRIV (self
);
200 group
= gtk_entry_get_text (GTK_ENTRY (priv
->add_group_entry
));
202 if (model_find_name (self
, group
, &iter
))
204 gtk_widget_set_sensitive (GTK_WIDGET (priv
->add_group_button
), FALSE
);
208 gtk_widget_set_sensitive (GTK_WIDGET (priv
->add_group_button
),
209 !EMP_STR_EMPTY (group
));
214 add_group_entry_activate_cb (GtkEntry
*entry
,
215 EmpathyGroupsWidget
*self
)
217 gtk_widget_activate (GTK_WIDGET (GET_PRIV (self
)->add_group_button
));
221 change_group_cb (FolksGroupDetails
*group_details
,
222 GAsyncResult
*async_result
,
223 EmpathyGroupsWidget
*self
)
225 GError
*error
= NULL
;
227 folks_group_details_change_group_finish (group_details
, async_result
, &error
);
231 g_warning ("Failed to change group: %s", error
->message
);
232 g_clear_error (&error
);
237 add_group_button_clicked_cb (GtkButton
*button
,
238 EmpathyGroupsWidget
*self
)
240 EmpathyGroupsWidgetPriv
*priv
= GET_PRIV (self
);
244 group
= gtk_entry_get_text (GTK_ENTRY (priv
->add_group_entry
));
246 gtk_list_store_append (priv
->group_store
, &iter
);
247 gtk_list_store_set (priv
->group_store
, &iter
,
252 folks_group_details_change_group (priv
->group_details
, group
, TRUE
,
253 (GAsyncReadyCallback
) change_group_cb
, self
);
257 cell_toggled_cb (GtkCellRendererToggle
*cell
,
258 const gchar
*path_string
,
259 EmpathyGroupsWidget
*self
)
261 EmpathyGroupsWidgetPriv
*priv
= GET_PRIV (self
);
264 gboolean was_enabled
;
267 path
= gtk_tree_path_new_from_string (path_string
);
269 gtk_tree_model_get_iter (GTK_TREE_MODEL (priv
->group_store
), &iter
,
271 gtk_tree_model_get (GTK_TREE_MODEL (priv
->group_store
), &iter
,
272 COL_ENABLED
, &was_enabled
,
276 gtk_list_store_set (priv
->group_store
, &iter
,
277 COL_ENABLED
, !was_enabled
,
280 gtk_tree_path_free (path
);
284 folks_group_details_change_group (priv
->group_details
, group
,
285 !was_enabled
, (GAsyncReadyCallback
) change_group_cb
, self
);
292 group_details_group_changed_cb (FolksGroupDetails
*groups
,
295 EmpathyGroupsWidget
*self
)
297 EmpathyGroupsWidgetPriv
*priv
= GET_PRIV (self
);
300 if (model_find_name (self
, group
, &iter
) == TRUE
)
302 gtk_list_store_set (priv
->group_store
, &iter
,
303 COL_ENABLED
, is_member
,
309 set_up (EmpathyGroupsWidget
*self
)
311 EmpathyGroupsWidgetPriv
*priv
;
312 GtkWidget
*label
, *alignment
;
314 GtkTreeView
*tree_view
;
315 GtkTreeSelection
*selection
;
316 GtkTreeViewColumn
*column
;
317 GtkCellRenderer
*renderer
;
319 GtkScrolledWindow
*scrolled_window
;
322 priv
= GET_PRIV (self
);
325 gtk_orientable_set_orientation (GTK_ORIENTABLE (self
),
326 GTK_ORIENTATION_VERTICAL
);
327 gtk_box_set_spacing (GTK_BOX (self
), 6);
329 /* Create our child widgets */
330 label
= gtk_label_new (NULL
);
331 gtk_misc_set_alignment (GTK_MISC (label
), 0.0, 0.5);
333 markup
= g_strdup_printf ("<b>%s</b>", _("Groups"));
334 gtk_label_set_markup (GTK_LABEL (label
), markup
);
337 gtk_box_pack_start (GTK_BOX (self
), label
, FALSE
, FALSE
, 0);
338 gtk_widget_show (label
);
340 alignment
= gtk_alignment_new (0.5, 0.5, 1.0, 1.0);
341 gtk_alignment_set_padding (GTK_ALIGNMENT (alignment
), 0, 0, 12, 0);
343 vbox
= GTK_BOX (gtk_vbox_new (FALSE
, 6));
345 label
= gtk_label_new (_("Select the groups you want this contact to appear "
346 "in. Note that you can select more than one group or no groups."));
347 gtk_misc_set_alignment (GTK_MISC (label
), 0.0, 0.5);
348 gtk_label_set_line_wrap (GTK_LABEL (label
), TRUE
);
350 gtk_box_pack_start (vbox
, label
, FALSE
, FALSE
, 0);
351 gtk_widget_show (label
);
353 hbox
= GTK_BOX (gtk_hbox_new (FALSE
, 12));
355 priv
->add_group_entry
= gtk_entry_new ();
356 g_signal_connect (priv
->add_group_entry
, "changed",
357 (GCallback
) add_group_entry_changed_cb
, self
);
358 g_signal_connect (priv
->add_group_entry
, "activate",
359 (GCallback
) add_group_entry_activate_cb
, self
);
361 gtk_box_pack_start (hbox
, priv
->add_group_entry
, TRUE
, TRUE
, 0);
362 gtk_widget_show (priv
->add_group_entry
);
364 priv
->add_group_button
= gtk_button_new_with_mnemonic (_("_Add Group"));
365 gtk_widget_set_sensitive (priv
->add_group_button
, FALSE
);
366 gtk_widget_set_receives_default (priv
->add_group_button
, TRUE
);
367 g_signal_connect (priv
->add_group_button
, "clicked",
368 (GCallback
) add_group_button_clicked_cb
, self
);
370 gtk_box_pack_start (hbox
, priv
->add_group_button
, FALSE
, FALSE
, 0);
371 gtk_widget_show (priv
->add_group_button
);
373 gtk_box_pack_start (vbox
, GTK_WIDGET (hbox
), FALSE
, FALSE
, 0);
374 gtk_widget_show (GTK_WIDGET (hbox
));
376 scrolled_window
= GTK_SCROLLED_WINDOW (gtk_scrolled_window_new (NULL
, NULL
));
377 gtk_scrolled_window_set_policy (scrolled_window
, GTK_POLICY_NEVER
,
378 GTK_POLICY_AUTOMATIC
);
379 gtk_scrolled_window_set_shadow_type (scrolled_window
, GTK_SHADOW_IN
);
380 gtk_widget_set_size_request (GTK_WIDGET (scrolled_window
), -1, 100);
382 priv
->group_store
= gtk_list_store_new (NUM_COLUMNS
,
383 G_TYPE_STRING
, /* name */
384 G_TYPE_BOOLEAN
, /* enabled */
385 G_TYPE_BOOLEAN
); /* editable */
387 tree_view
= GTK_TREE_VIEW (gtk_tree_view_new_with_model (
388 GTK_TREE_MODEL (priv
->group_store
)));
389 gtk_tree_view_set_headers_visible (tree_view
, FALSE
);
390 gtk_tree_view_set_enable_search (tree_view
, FALSE
);
392 selection
= gtk_tree_view_get_selection (tree_view
);
393 gtk_tree_selection_set_mode (selection
, GTK_SELECTION_SINGLE
);
395 renderer
= gtk_cell_renderer_toggle_new ();
396 g_signal_connect (renderer
, "toggled", (GCallback
) cell_toggled_cb
, self
);
398 column
= gtk_tree_view_column_new_with_attributes (
399 C_("verb in a column header displaying group names", "Select"), renderer
,
400 "active", COL_ENABLED
,
403 gtk_tree_view_column_set_sizing (column
, GTK_TREE_VIEW_COLUMN_FIXED
);
404 gtk_tree_view_column_set_fixed_width (column
, 50);
405 gtk_tree_view_append_column (tree_view
, column
);
407 renderer
= gtk_cell_renderer_text_new ();
408 col_offset
= gtk_tree_view_insert_column_with_attributes (tree_view
,
412 /* "editable", COL_EDITABLE, */
415 column
= gtk_tree_view_get_column (tree_view
, col_offset
- 1);
416 gtk_tree_view_column_set_sort_column_id (column
, COL_NAME
);
417 gtk_tree_view_column_set_resizable (column
, FALSE
);
418 gtk_tree_view_column_set_clickable (GTK_TREE_VIEW_COLUMN (column
), TRUE
);
420 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (priv
->group_store
),
421 COL_NAME
, GTK_SORT_ASCENDING
);
423 gtk_container_add (GTK_CONTAINER (scrolled_window
), GTK_WIDGET (tree_view
));
424 gtk_widget_show (GTK_WIDGET (tree_view
));
426 gtk_box_pack_start (vbox
, GTK_WIDGET (scrolled_window
), TRUE
, TRUE
, 0);
427 gtk_widget_show (GTK_WIDGET (scrolled_window
));
429 gtk_container_add (GTK_CONTAINER (alignment
), GTK_WIDGET (vbox
));
430 gtk_widget_show (GTK_WIDGET (vbox
));
432 gtk_box_pack_start (GTK_BOX (self
), alignment
, TRUE
, TRUE
, 0);
433 gtk_widget_show (alignment
);
437 empathy_groups_widget_init (EmpathyGroupsWidget
*self
)
439 self
->priv
= G_TYPE_INSTANCE_GET_PRIVATE (self
,
440 EMPATHY_TYPE_GROUPS_WIDGET
, EmpathyGroupsWidgetPriv
);
446 get_property (GObject
*object
,
451 EmpathyGroupsWidgetPriv
*priv
;
453 priv
= GET_PRIV (object
);
457 case PROP_GROUP_DETAILS
:
458 g_value_set_object (value
, priv
->group_details
);
461 G_OBJECT_WARN_INVALID_PROPERTY_ID (object
, param_id
, pspec
);
467 set_property (GObject
*object
,
474 case PROP_GROUP_DETAILS
:
475 empathy_groups_widget_set_group_details (EMPATHY_GROUPS_WIDGET (object
),
476 g_value_get_object (value
));
479 G_OBJECT_WARN_INVALID_PROPERTY_ID (object
, param_id
, pspec
);
485 dispose (GObject
*object
)
487 EmpathyGroupsWidgetPriv
*priv
= GET_PRIV (object
);
489 empathy_groups_widget_set_group_details (EMPATHY_GROUPS_WIDGET (object
),
491 tp_clear_object (&priv
->group_store
);
493 G_OBJECT_CLASS (empathy_groups_widget_parent_class
)->dispose (object
);
497 empathy_groups_widget_class_init (EmpathyGroupsWidgetClass
*klass
)
499 GObjectClass
*object_class
= G_OBJECT_CLASS (klass
);
501 object_class
->get_property
= get_property
;
502 object_class
->set_property
= set_property
;
503 object_class
->dispose
= dispose
;
506 * EmpathyGroupsWidget:group_details:
508 * The #FolksGroupDetails whose group membership is to be edited by the
509 * #EmpathyGroupsWidget.
511 g_object_class_install_property (object_class
, PROP_GROUP_DETAILS
,
512 g_param_spec_object ("group-details",
514 "The #FolksGroupDetails whose groups are being edited.",
515 FOLKS_TYPE_GROUP_DETAILS
,
516 G_PARAM_READWRITE
| G_PARAM_STATIC_STRINGS
));
518 g_type_class_add_private (object_class
, sizeof (EmpathyGroupsWidgetPriv
));
522 * empathy_groups_widget_new:
523 * @group_details: a #FolksGroupDetails, or %NULL
525 * Creates a new #EmpathyGroupsWidget to edit the groups of the given
528 * Return value: a new #EmpathyGroupsWidget
531 empathy_groups_widget_new (FolksGroupDetails
*group_details
)
533 g_return_val_if_fail (
534 group_details
== NULL
|| FOLKS_IS_GROUP_DETAILS (group_details
),
537 return GTK_WIDGET (g_object_new (EMPATHY_TYPE_GROUPS_WIDGET
,
538 "group-details", group_details
,
543 * empathy_groups_widget_get_group_details:
544 * @self: an #EmpathyGroupsWidget
546 * Get the #FolksGroupDetails whose group membership is being edited by the
547 * #EmpathyGroupsWidget.
549 * Returns: the #FolksGroupDetails associated with @widget, or %NULL
552 empathy_groups_widget_get_group_details (EmpathyGroupsWidget
*self
)
554 g_return_val_if_fail (EMPATHY_IS_GROUPS_WIDGET (self
), NULL
);
556 return GET_PRIV (self
)->group_details
;
560 * empathy_groups_widget_set_group_details:
561 * @self: an #EmpathyGroupsWidget
562 * @group_details: the #FolksGroupDetails whose membership is to be edited, or
565 * Change the #FolksGroupDetails whose group membership is to be edited by the
566 * #EmpathyGroupsWidget.
569 empathy_groups_widget_set_group_details (EmpathyGroupsWidget
*self
,
570 FolksGroupDetails
*group_details
)
572 EmpathyGroupsWidgetPriv
*priv
;
574 g_return_if_fail (EMPATHY_IS_GROUPS_WIDGET (self
));
576 group_details
== NULL
|| FOLKS_IS_GROUP_DETAILS (group_details
));
578 priv
= GET_PRIV (self
);
580 if (group_details
== priv
->group_details
)
583 if (priv
->group_details
!= NULL
)
585 g_signal_handlers_disconnect_by_func (priv
->group_details
,
586 group_details_group_changed_cb
, self
);
589 tp_clear_object (&priv
->group_details
);
591 if (group_details
!= NULL
)
593 priv
->group_details
= g_object_ref (group_details
);
595 g_signal_connect (priv
->group_details
, "group-changed",
596 (GCallback
) group_details_group_changed_cb
, self
);
598 populate_data (self
);
601 g_object_notify (G_OBJECT (self
), "group-details");