2 PSPPIRE --- A Graphical User Interface for PSPP
3 Copyright (C) 2007 Free Software Foundation
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program 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
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
21 This module provides a widget, PsppireSelector derived from
24 It contains a GtkArrow, and is used for selecting objects from a
25 GtkTreeView and putting them into a destination widget (often
26 another GtkTreeView). Typically this is used in psppire for
27 selecting variables, thus:
30 +----------------------------------------------------------+
32 | Source Widget Dest Widget |
33 | +----------------+ +----------------+ |
34 | | Variable0 | | Variable2 | |
49 | +----------------+ +----------------+ |
51 +----------------------------------------------------------+
53 The Source Widget is always a GtkTreeView. The Dest Widget may be a
54 GtkTreeView or a GtkEntry (other destination widgets may be
55 supported in the future).
57 Widgets may be source to more than one PsppireSelector.
63 #include <gtk/gtksignal.h>
64 #include <gtk/gtkbutton.h>
65 #include <gtk/gtkentry.h>
67 #include "psppire-selector.h"
69 #include <gtk/gtktreeview.h>
70 #include <gtk/gtktreeselection.h>
71 #include <gtk/gtkwidget.h>
73 static void psppire_selector_base_finalize (PsppireSelectorClass *, gpointer);
74 static void psppire_selector_base_init (PsppireSelectorClass *class);
75 static void psppire_selector_class_init (PsppireSelectorClass *class);
76 static void psppire_selector_init (PsppireSelector *selector);
79 static void set_direction (PsppireSelector *, enum psppire_selector_dir);
82 enum {SELECTED, /* Emitted when an item is inserted into dest */
83 DE_SELECTED, /* Emitted when an item is removed from dest */
86 static guint signals [n_SIGNALS];
90 psppire_selector_get_type (void)
92 static GType psppire_selector_type = 0;
94 if (!psppire_selector_type)
96 static const GTypeInfo psppire_selector_info =
98 sizeof (PsppireSelectorClass),
99 (GBaseInitFunc) psppire_selector_base_init,
100 (GBaseFinalizeFunc) psppire_selector_base_finalize,
101 (GClassInitFunc)psppire_selector_class_init,
102 (GClassFinalizeFunc) NULL,
104 sizeof (PsppireSelector),
106 (GInstanceInitFunc) psppire_selector_init,
109 psppire_selector_type =
110 g_type_register_static (GTK_TYPE_BUTTON, "PsppireSelector",
111 &psppire_selector_info, 0);
114 return psppire_selector_type;
119 psppire_selector_finalize (GObject *object)
132 psppire_selector_set_property (GObject *object,
137 PsppireSelector *selector = PSPPIRE_SELECTOR (object);
141 case PROP_ORIENTATION:
142 selector->orientation = g_value_get_enum (value);
143 set_direction (selector, selector->direction);
146 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
153 psppire_selector_get_property (GObject *object,
158 PsppireSelector *selector = PSPPIRE_SELECTOR (object);
162 case PROP_ORIENTATION:
163 g_value_set_enum (value, selector->orientation);
166 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
174 psppire_selector_class_init (PsppireSelectorClass *class)
176 GObjectClass *object_class = G_OBJECT_CLASS (class);
177 GParamSpec *orientation_spec =
178 g_param_spec_enum ("orientation",
180 "Where the selector is relative to its subjects",
181 G_TYPE_PSPPIRE_SELECTOR_ORIENTATION,
182 PSPPIRE_SELECT_SOURCE_BEFORE_DEST /* default value */,
183 G_PARAM_CONSTRUCT_ONLY |G_PARAM_READWRITE);
186 object_class->set_property = psppire_selector_set_property;
187 object_class->get_property = psppire_selector_get_property;
189 g_object_class_install_property (object_class,
194 g_signal_new ("selected",
195 G_TYPE_FROM_CLASS (class),
199 g_cclosure_marshal_VOID__VOID,
203 signals [DE_SELECTED] =
204 g_signal_new ("de-selected",
205 G_TYPE_FROM_CLASS (class),
209 g_cclosure_marshal_VOID__VOID,
216 psppire_selector_base_init (PsppireSelectorClass *class)
218 GObjectClass *object_class = G_OBJECT_CLASS (class);
220 object_class->finalize = psppire_selector_finalize;
222 class->source_hash = g_hash_table_new (g_direct_hash, g_direct_equal);
228 psppire_selector_base_finalize(PsppireSelectorClass *class,
231 g_hash_table_destroy (class->source_hash);
236 psppire_selector_init (PsppireSelector *selector)
238 selector->arrow = gtk_arrow_new (GTK_ARROW_LEFT, GTK_SHADOW_NONE);
239 selector->filtered_source = NULL;
241 gtk_container_add (GTK_CONTAINER (selector), selector->arrow);
243 gtk_widget_show (selector->arrow);
245 selector->selecting = FALSE;
250 psppire_selector_new (void)
252 return GTK_WIDGET (g_object_new (psppire_selector_get_type (), NULL));
257 set_direction (PsppireSelector *selector, enum psppire_selector_dir d)
259 selector->direction = d;
261 /* FIXME: Need to reverse the arrow direction if an RTL locale is in
263 if ( d == PSPPIRE_SELECTOR_SOURCE_TO_DEST )
265 switch (selector->orientation)
267 case PSPPIRE_SELECT_SOURCE_BEFORE_DEST:
268 g_object_set (selector->arrow, "arrow-type", GTK_ARROW_RIGHT, NULL);
270 case PSPPIRE_SELECT_SOURCE_AFTER_DEST:
271 g_object_set (selector->arrow, "arrow-type", GTK_ARROW_LEFT, NULL);
273 case PSPPIRE_SELECT_SOURCE_ABOVE_DEST:
274 g_object_set (selector->arrow, "arrow-type", GTK_ARROW_DOWN, NULL);
276 case PSPPIRE_SELECT_SOURCE_BELOW_DEST:
277 g_object_set (selector->arrow, "arrow-type", GTK_ARROW_UP, NULL);
280 g_assert_not_reached ();
286 switch (selector->orientation)
288 case PSPPIRE_SELECT_SOURCE_BEFORE_DEST:
289 g_object_set (selector->arrow, "arrow-type", GTK_ARROW_LEFT, NULL);
291 case PSPPIRE_SELECT_SOURCE_AFTER_DEST:
292 g_object_set (selector->arrow, "arrow-type", GTK_ARROW_RIGHT, NULL);
294 case PSPPIRE_SELECT_SOURCE_ABOVE_DEST:
295 g_object_set (selector->arrow, "arrow-type", GTK_ARROW_UP, NULL);
297 case PSPPIRE_SELECT_SOURCE_BELOW_DEST:
298 g_object_set (selector->arrow, "arrow-type", GTK_ARROW_DOWN, NULL);
301 g_assert_not_reached ();
308 /* Callback for when the source selection changes */
310 on_source_select (GtkTreeSelection *treeselection, gpointer data)
312 PsppireSelector *selector = data;
314 set_direction (selector, PSPPIRE_SELECTOR_SOURCE_TO_DEST);
316 if ( GTK_IS_ENTRY (selector->dest) )
318 gtk_widget_set_sensitive (GTK_WIDGET (selector),
319 gtk_tree_selection_count_selected_rows
320 (treeselection) <= 1 );
324 /* Callback for when the destination treeview selection changes */
326 on_dest_treeview_select (GtkTreeSelection *treeselection, gpointer data)
328 PsppireSelector *selector = data;
330 set_direction (selector, PSPPIRE_SELECTOR_DEST_TO_SOURCE);
333 /* Callback for source deselection, when the dest is GtkEntry */
335 de_select_selection_entry (PsppireSelector *selector)
337 gtk_entry_set_text (GTK_ENTRY (selector->dest), "");
340 /* Callback for source deselection, when the dest is GtkTreeView */
342 de_select_selection_tree_view (PsppireSelector *selector)
346 GtkTreeSelection* selection =
347 gtk_tree_view_get_selection ( GTK_TREE_VIEW (selector->dest));
349 GtkTreeModel *model =
350 gtk_tree_view_get_model (GTK_TREE_VIEW (selector->dest));
352 GList *selected_rows =
353 gtk_tree_selection_get_selected_rows (selection, NULL);
355 g_return_if_fail (selector->select_items);
357 /* Convert paths to RowRefs */
358 for (item = g_list_first (selected_rows);
360 item = g_list_next (item))
362 GtkTreeRowReference* rowref;
363 GtkTreePath *path = item->data;
365 rowref = gtk_tree_row_reference_new (GTK_TREE_MODEL (model), path);
367 item->data = rowref ;
368 gtk_tree_path_free (path);
371 /* Remove each selected row from the dest widget */
372 for (item = g_list_first (selected_rows);
374 item = g_list_next (item))
377 GtkTreeRowReference *rr = item->data;
379 GtkTreePath *path = gtk_tree_row_reference_get_path (rr);
381 gtk_tree_model_get_iter (GTK_TREE_MODEL (model), &iter, path);
383 gtk_list_store_remove (GTK_LIST_STORE (model), &iter);
385 gtk_tree_path_free (path);
388 /* Delete list of RowRefs and its contents */
389 g_list_foreach (selected_rows, (GFunc) gtk_tree_row_reference_free, NULL);
390 g_list_free (selected_rows);
394 /* Removes something from the DEST widget */
396 de_select_selection (PsppireSelector *selector)
398 selector->selecting = TRUE;
400 if ( GTK_IS_TREE_VIEW (selector->dest ) )
401 de_select_selection_tree_view (selector);
403 else if ( GTK_IS_ENTRY (selector->dest))
404 de_select_selection_entry (selector);
407 g_assert_not_reached ();
409 selector->selecting = FALSE;
411 gtk_tree_model_filter_refilter (selector->filtered_source);
413 g_signal_emit (selector, signals [DE_SELECTED], 0);
417 /* Puts something into the DEST widget */
419 select_selection (PsppireSelector *selector)
422 GtkTreeSelection* selection =
423 gtk_tree_view_get_selection ( GTK_TREE_VIEW (selector->source));
425 GList *selected_rows =
426 gtk_tree_selection_get_selected_rows (selection, NULL);
428 GtkTreeModel *childmodel = gtk_tree_model_filter_get_model
429 (selector->filtered_source);
431 g_return_if_fail (selector->select_items);
433 selector->selecting = TRUE;
435 for (item = g_list_first (selected_rows);
437 item = g_list_next (item))
439 GtkTreeIter child_iter;
441 GtkTreePath *path = item->data;
443 gtk_tree_model_get_iter (GTK_TREE_MODEL (selector->filtered_source),
446 gtk_tree_model_filter_convert_iter_to_child_iter
447 (selector->filtered_source,
451 selector->select_items (child_iter,
456 g_list_foreach (selected_rows, (GFunc) gtk_tree_path_free, NULL);
457 g_list_free (selected_rows);
459 gtk_tree_model_filter_refilter (selector->filtered_source);
461 g_signal_emit (selector, signals [SELECTED], 0);
463 selector->selecting = FALSE;
466 /* Callback for when the source treeview is activated (double clicked) */
468 on_row_activate (GtkTreeView *tree_view,
470 GtkTreeViewColumn *column,
473 PsppireSelector *selector = data;
475 select_selection (selector);
478 /* Callback for when the selector button is clicked */
480 on_click (PsppireSelector *selector, gpointer data)
482 switch (selector->direction)
484 case PSPPIRE_SELECTOR_SOURCE_TO_DEST:
485 select_selection (selector);
487 case PSPPIRE_SELECTOR_DEST_TO_SOURCE:
488 de_select_selection (selector);
491 g_assert_not_reached ();
496 /* Default visibility filter for GtkTreeView DEST widget */
498 is_item_in_dest (GtkTreeModel *model, GtkTreeIter *iter,
499 PsppireSelector *selector)
501 GtkTreeModel *dest_model;
502 GtkTreeIter dest_iter;
503 GtkTreeIter source_iter;
506 GtkTreeModel *source_model;
508 if ( GTK_IS_TREE_MODEL_FILTER (model) )
510 source_model = gtk_tree_model_filter_get_model
511 (GTK_TREE_MODEL_FILTER (model));
513 gtk_tree_model_filter_convert_iter_to_child_iter
514 ( GTK_TREE_MODEL_FILTER (model), &source_iter, iter );
518 source_model = model;
522 dest_model = gtk_tree_view_get_model (GTK_TREE_VIEW (selector->dest));
524 path = gtk_tree_model_get_path (source_model, &source_iter);
526 index = *gtk_tree_path_get_indices (path);
528 gtk_tree_path_free (path);
530 if ( ! gtk_tree_model_get_iter_first (dest_model, &dest_iter) )
536 gtk_tree_model_get_value (dest_model, &dest_iter, 0, &value);
538 if ( g_value_get_int (&value) == index)
541 while (gtk_tree_model_iter_next (dest_model, &dest_iter));
546 /* Visibility function for items in the SOURCE widget.
547 Returns TRUE iff *all* the selectors for which SOURCE is associated
550 is_source_item_visible (GtkTreeModel *childmodel,
551 GtkTreeIter *iter, gpointer data)
553 PsppireSelector *selector = data;
554 PsppireSelectorClass *class = g_type_class_peek (PSPPIRE_SELECTOR_TYPE);
558 list = g_hash_table_lookup (class->source_hash, selector->source);
562 PsppireSelector *selector = list->data;
564 if ( selector->filter (childmodel, iter, selector))
574 /* set the source widget to SOURCE */
576 set_tree_view_source (PsppireSelector *selector,
579 GtkTreeSelection* selection ;
582 PsppireSelectorClass *class = g_type_class_peek (PSPPIRE_SELECTOR_TYPE);
584 if ( ! (list = g_hash_table_lookup (class->source_hash, source)))
586 selector->filtered_source =
587 GTK_TREE_MODEL_FILTER (gtk_tree_model_filter_new
588 (gtk_tree_view_get_model (source), NULL));
590 gtk_tree_view_set_model (source, NULL);
592 gtk_tree_view_set_model (source,
593 GTK_TREE_MODEL (selector->filtered_source));
595 list = g_list_append (list, selector);
596 g_hash_table_insert (class->source_hash, source, list);
599 gtk_tree_model_filter_set_visible_func (selector->filtered_source,
600 is_source_item_visible,
605 { /* Append this selector to the list and push the <source,list>
606 pair onto the hash table */
608 selector->filtered_source = GTK_TREE_MODEL_FILTER (
609 gtk_tree_view_get_model (source));
611 list = g_list_append (list, selector);
612 g_hash_table_replace (class->source_hash, source, list);
615 selection = gtk_tree_view_get_selection (source);
617 g_signal_connect (source, "row-activated", G_CALLBACK (on_row_activate),
620 g_signal_connect (selection, "changed", G_CALLBACK (on_source_select),
626 Callback for when the destination treeview's data changes
629 on_dest_data_change (GtkTreeModel *tree_model,
634 PsppireSelector *selector = user_data;
636 if ( selector->selecting) return;
638 gtk_tree_model_filter_refilter (selector->filtered_source);
643 on_dest_data_delete (GtkTreeModel *tree_model,
647 PsppireSelector *selector = user_data;
649 if ( selector->selecting ) return;
651 gtk_tree_model_filter_refilter (selector->filtered_source);
657 /* Set the destination widget to DEST */
659 set_tree_view_dest (PsppireSelector *selector,
662 GtkTreeSelection* selection = gtk_tree_view_get_selection (dest);
663 GtkTreeModel *model = gtk_tree_view_get_model (dest);
665 gtk_tree_selection_set_mode (selection, GTK_SELECTION_MULTIPLE);
667 g_signal_connect (selection, "changed", G_CALLBACK (on_dest_treeview_select),
670 g_signal_connect (model, "row-changed", G_CALLBACK (on_dest_data_change),
673 g_signal_connect (model, "row-deleted", G_CALLBACK (on_dest_data_delete),
678 /* Callback for when the DEST GtkEntry is activated (Enter is pressed) */
680 on_entry_activate (GtkEntry *w, gpointer data)
682 PsppireSelector * selector = data;
684 gtk_tree_model_filter_refilter (selector->filtered_source);
687 /* Callback for when the DEST GtkEntry is selected (clicked) */
689 on_entry_dest_select (GtkWidget *widget, GdkEventFocus *event, gpointer data)
691 PsppireSelector * selector = data;
693 set_direction (selector, PSPPIRE_SELECTOR_DEST_TO_SOURCE);
698 /* Set DEST to be the destination GtkEntry widget */
700 set_entry_dest (PsppireSelector *selector,
703 g_signal_connect (dest, "activate", G_CALLBACK (on_entry_activate),
706 g_signal_connect (dest, "focus-in-event", G_CALLBACK (on_entry_dest_select),
711 /* Set SOURCE and DEST for this selector, and
712 set SELECT_FUNC and FILTER_FUNC */
714 psppire_selector_set_subjects (PsppireSelector *selector,
717 SelectItemsFunc *select_func,
718 FilterItemsFunc *filter_func )
720 selector->filter = filter_func ;
722 selector->source = source;
723 selector->dest = dest;
725 if ( filter_func == NULL)
727 if (GTK_IS_TREE_VIEW (dest))
728 selector->filter = is_item_in_dest;
731 g_signal_connect (selector, "clicked", G_CALLBACK (on_click), NULL);
733 if ( GTK_IS_TREE_VIEW (source))
734 set_tree_view_source (selector, GTK_TREE_VIEW (source) );
736 g_error ("Unsupported source widget: %s", G_OBJECT_TYPE_NAME (source));
738 g_assert ( GTK_IS_TREE_MODEL_FILTER (selector->filtered_source));
740 if ( GTK_IS_TREE_VIEW (dest))
741 set_tree_view_dest (selector, GTK_TREE_VIEW (dest));
743 else if ( GTK_IS_ENTRY (dest))
744 set_entry_dest (selector, GTK_ENTRY (dest));
747 g_error ("Unsupported destination widget: %s", G_OBJECT_TYPE_NAME (dest));
749 selector->select_items = select_func;
755 psppire_selector_orientation_get_type (void)
757 static GType etype = 0;
759 static const GEnumValue values[] = {
760 { PSPPIRE_SELECT_SOURCE_BEFORE_DEST, "PSPPIRE_SELECT_SOURCE_BEFORE_DEST", "source before destination" },
761 { PSPPIRE_SELECT_SOURCE_AFTER_DEST, "PSPPIRE_SELECT_SOURCE_AFTER_DEST", "source after destination" },
762 { PSPPIRE_SELECT_SOURCE_ABOVE_DEST, "PSPPIRE_SELECT_SOURCE_ABOVE_DEST", "source above destination" },
763 { PSPPIRE_SELECT_SOURCE_BELOW_DEST, "PSPPIRE_SELECT_SOURCE_BELOW_DEST", "source below destination" },
766 etype = g_enum_register_static (g_intern_static_string ("PsppireSelectorOrientation"), values);