68d8270db805f83193637485b581b4bb3e7b0ee4
[pspp-builds.git] / src / ui / gui / psppire-selector.c
1 /*
2    PSPPIRE --- A Graphical User Interface for PSPP
3    Copyright (C) 2007  Free Software Foundation
4
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.
9
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.
14
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
18    02110-1301, USA. */
19
20 /*
21   This module provides a widget, PsppireSelector derived from
22   GtkButton.
23
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:
28
29
30   +----------------------------------------------------------+
31   |                                                          |
32   |     Source Widget                       Dest Widget      |
33   |   +----------------+                 +----------------+  |
34   |   | Variable0      |                 | Variable2      |  |
35   |   | Variable1      |                 |                |  |
36   |   | Variable3      |                 |                |  |
37   |   |                |    Selector     |                |  |
38   |   |                |                 |                |  |
39   |   |                |    +------+     |                |  |
40   |   |                |    | |\   |     |                |  |
41   |   |                |    | | \  |     |                |  |
42   |   |                |    | | /  |     |                |  |
43   |   |                |    | |/   |     |                |  |
44   |   |                |    +------+     |                |  |
45   |   |                |                 |                |  |
46   |   |                |                 |                |  |
47   |   |                |                 |                |  |
48   |   |                |                 |                |  |
49   |   +----------------+                 +----------------+  |
50   |                                                          |
51   +----------------------------------------------------------+
52
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).
56
57   Widgets may be source to more than one PsppireSelector.
58 */
59
60
61 #include <config.h>
62
63 #include <gtk/gtksignal.h>
64 #include <gtk/gtkbutton.h>
65 #include <gtk/gtkentry.h>
66
67 #include "psppire-selector.h"
68
69 #include <gtk/gtktreeview.h>
70 #include <gtk/gtktreeselection.h>
71 #include <gtk/gtkwidget.h>
72
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);
77
78
79 static void set_direction (PsppireSelector *, enum psppire_selector_dir);
80
81
82 enum  {SELECTED,    /* Emitted when an item is inserted into dest */
83        DE_SELECTED, /* Emitted when an item is removed from dest */
84        n_SIGNALS};
85
86 static guint signals [n_SIGNALS];
87
88
89 GType
90 psppire_selector_get_type (void)
91 {
92   static GType psppire_selector_type = 0;
93
94   if (!psppire_selector_type)
95     {
96       static const GTypeInfo psppire_selector_info =
97       {
98         sizeof (PsppireSelectorClass),
99         (GBaseInitFunc) psppire_selector_base_init,
100         (GBaseFinalizeFunc) psppire_selector_base_finalize,
101         (GClassInitFunc)psppire_selector_class_init,
102         (GClassFinalizeFunc) NULL,
103         NULL,
104         sizeof (PsppireSelector),
105         0,
106         (GInstanceInitFunc) psppire_selector_init,
107       };
108
109       psppire_selector_type =
110         g_type_register_static (GTK_TYPE_BUTTON, "PsppireSelector",
111                                 &psppire_selector_info, 0);
112     }
113
114   return psppire_selector_type;
115 }
116
117
118 static void
119 psppire_selector_finalize (GObject *object)
120 {
121 }
122
123 /* Properties */
124 enum
125 {
126   PROP_0,
127   PROP_ORIENTATION
128 };
129
130
131 static void
132 psppire_selector_set_property (GObject         *object,
133                                guint            prop_id,
134                                const GValue    *value,
135                                GParamSpec      *pspec)
136 {
137   PsppireSelector *selector = PSPPIRE_SELECTOR (object);
138
139   switch (prop_id)
140     {
141     case PROP_ORIENTATION:
142       selector->orientation = g_value_get_enum (value);
143       set_direction (selector, selector->direction);
144       break;
145     default:
146       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
147       break;
148     };
149 }
150
151
152 static void
153 psppire_selector_get_property (GObject         *object,
154                                guint            prop_id,
155                                GValue          *value,
156                                GParamSpec      *pspec)
157 {
158   PsppireSelector *selector = PSPPIRE_SELECTOR (object);
159
160   switch (prop_id)
161     {
162     case PROP_ORIENTATION:
163       g_value_set_enum (value, selector->orientation);
164       break;
165     default:
166       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
167       break;
168     };
169 }
170
171
172
173 static void
174 psppire_selector_class_init (PsppireSelectorClass *class)
175 {
176   GObjectClass *object_class = G_OBJECT_CLASS (class);
177   GParamSpec *orientation_spec =
178     g_param_spec_enum ("orientation",
179                        "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);
184
185
186   object_class->set_property = psppire_selector_set_property;
187   object_class->get_property = psppire_selector_get_property;
188
189   g_object_class_install_property (object_class,
190                                    PROP_ORIENTATION,
191                                    orientation_spec);
192
193   signals [SELECTED] =
194     g_signal_new ("selected",
195                   G_TYPE_FROM_CLASS (class),
196                   G_SIGNAL_RUN_FIRST,
197                   0,
198                   NULL, NULL,
199                   g_cclosure_marshal_VOID__VOID,
200                   G_TYPE_NONE,
201                   0);
202
203   signals [DE_SELECTED] =
204     g_signal_new ("de-selected",
205                   G_TYPE_FROM_CLASS (class),
206                   G_SIGNAL_RUN_FIRST,
207                   0,
208                   NULL, NULL,
209                   g_cclosure_marshal_VOID__VOID,
210                   G_TYPE_NONE,
211                   0);
212 }
213
214
215 static void
216 psppire_selector_base_init (PsppireSelectorClass *class)
217 {
218   GObjectClass *object_class = G_OBJECT_CLASS (class);
219
220   object_class->finalize = psppire_selector_finalize;
221
222   class->source_hash = g_hash_table_new (g_direct_hash, g_direct_equal);
223 }
224
225
226
227 static void
228 psppire_selector_base_finalize(PsppireSelectorClass *class,
229                                 gpointer class_data)
230 {
231   g_hash_table_destroy (class->source_hash);
232 }
233
234
235 static void
236 psppire_selector_init (PsppireSelector *selector)
237 {
238   selector->arrow = gtk_arrow_new (GTK_ARROW_LEFT, GTK_SHADOW_NONE);
239   selector->filtered_source = NULL;
240
241   gtk_container_add (GTK_CONTAINER (selector), selector->arrow);
242
243   gtk_widget_show (selector->arrow);
244
245   /* FIXME: This shouldn't be necessary, but Glade interfaces seem to
246      need it. */
247   gtk_widget_show (GTK_WIDGET (selector));
248 }
249
250
251 GtkWidget*
252 psppire_selector_new (void)
253 {
254   return GTK_WIDGET (g_object_new (psppire_selector_get_type (), NULL));
255 }
256
257
258 static void
259 set_direction (PsppireSelector *selector, enum psppire_selector_dir d)
260 {
261   selector->direction = d;
262
263   /* FIXME: Need to reverse the arrow direction if an RTL locale is in
264      effect */
265   if ( d == PSPPIRE_SELECTOR_SOURCE_TO_DEST )
266     {
267       switch (selector->orientation)
268         {
269         case   PSPPIRE_SELECT_SOURCE_BEFORE_DEST:
270           g_object_set (selector->arrow, "arrow-type", GTK_ARROW_RIGHT, NULL);
271           break;
272         case   PSPPIRE_SELECT_SOURCE_AFTER_DEST:
273           g_object_set (selector->arrow, "arrow-type", GTK_ARROW_LEFT, NULL);
274           break;
275         case   PSPPIRE_SELECT_SOURCE_ABOVE_DEST:
276           g_object_set (selector->arrow, "arrow-type", GTK_ARROW_DOWN, NULL);
277           break;
278         case   PSPPIRE_SELECT_SOURCE_BELOW_DEST:
279           g_object_set (selector->arrow, "arrow-type", GTK_ARROW_UP, NULL);
280           break;
281         default:
282           g_assert_not_reached ();
283           break;
284         };
285     }
286   else
287     {
288       switch (selector->orientation)
289         {
290         case   PSPPIRE_SELECT_SOURCE_BEFORE_DEST:
291           g_object_set (selector->arrow, "arrow-type", GTK_ARROW_LEFT, NULL);
292           break;
293         case   PSPPIRE_SELECT_SOURCE_AFTER_DEST:
294           g_object_set (selector->arrow, "arrow-type", GTK_ARROW_RIGHT, NULL);
295           break;
296         case   PSPPIRE_SELECT_SOURCE_ABOVE_DEST:
297           g_object_set (selector->arrow, "arrow-type", GTK_ARROW_UP, NULL);
298           break;
299         case   PSPPIRE_SELECT_SOURCE_BELOW_DEST:
300           g_object_set (selector->arrow, "arrow-type", GTK_ARROW_DOWN, NULL);
301           break;
302         default:
303           g_assert_not_reached ();
304           break;
305         };
306
307     }
308 }
309
310 /* Callback for when the source selection changes */
311 static void
312 on_source_select (GtkTreeSelection *treeselection, gpointer data)
313 {
314   PsppireSelector *selector = data;
315
316   set_direction (selector, PSPPIRE_SELECTOR_SOURCE_TO_DEST);
317
318   if ( GTK_IS_ENTRY (selector->dest) )
319     {
320       gtk_widget_set_sensitive (GTK_WIDGET (selector),
321                                 gtk_tree_selection_count_selected_rows
322                                 (treeselection) <= 1 );
323     }
324 }
325
326 /* Callback for when the destination treeview selection changes */
327 static void
328 on_dest_treeview_select (GtkTreeSelection *treeselection, gpointer data)
329 {
330   PsppireSelector *selector = data;
331
332   set_direction (selector, PSPPIRE_SELECTOR_DEST_TO_SOURCE);
333 }
334
335 /* Callback for source deselection, when the dest is GtkEntry */
336 static void
337 de_select_selection_entry (PsppireSelector *selector)
338 {
339   gtk_entry_set_text (GTK_ENTRY (selector->dest), "");
340 }
341
342 /* Callback for source deselection, when the dest is GtkTreeView */
343 static void
344 de_select_selection_tree_view (PsppireSelector *selector)
345 {
346   GList *item;
347
348   GtkTreeSelection* selection =
349     gtk_tree_view_get_selection ( GTK_TREE_VIEW (selector->dest));
350
351   GtkTreeModel *model =
352     gtk_tree_view_get_model (GTK_TREE_VIEW (selector->dest));
353
354   GList *selected_rows =
355     gtk_tree_selection_get_selected_rows (selection, NULL);
356
357   g_return_if_fail (selector->select_items);
358
359   /* Convert paths to RowRefs */
360   for (item = g_list_first (selected_rows);
361        item != NULL;
362        item = g_list_next (item))
363     {
364       GtkTreeRowReference* rowref;
365       GtkTreePath *path  = item->data;
366
367       rowref = gtk_tree_row_reference_new (GTK_TREE_MODEL (model), path);
368
369       item->data = rowref ;
370       gtk_tree_path_free (path);
371     }
372
373   /* Remove each selected row from the dest widget */
374   for (item = g_list_first (selected_rows);
375        item != NULL;
376        item = g_list_next (item))
377     {
378       GtkTreeIter iter;
379       GtkTreeRowReference *rr = item->data;
380
381       GtkTreePath *path = gtk_tree_row_reference_get_path (rr);
382
383       gtk_tree_model_get_iter (GTK_TREE_MODEL (model), &iter, path);
384
385       gtk_list_store_remove (GTK_LIST_STORE (model), &iter);
386
387       gtk_tree_path_free (path);
388     }
389
390   /* Delete list of RowRefs and its contents */
391   g_list_foreach (selected_rows, (GFunc) gtk_tree_row_reference_free, NULL);
392   g_list_free (selected_rows);
393 }
394
395
396 /* Removes something from the DEST widget */
397 static void
398 de_select_selection (PsppireSelector *selector)
399 {
400   if ( GTK_IS_TREE_VIEW (selector->dest ) )
401     de_select_selection_tree_view (selector);
402
403   else if ( GTK_IS_ENTRY (selector->dest))
404     de_select_selection_entry (selector);
405
406   else
407     g_assert_not_reached ();
408
409   gtk_tree_model_filter_refilter (selector->filtered_source);
410
411   g_signal_emit (selector, signals [DE_SELECTED], 0);
412 }
413
414
415 /* Puts something into the DEST widget */
416 static void
417 select_selection (PsppireSelector *selector)
418 {
419   GList *item ;
420   GtkTreeSelection* selection =
421     gtk_tree_view_get_selection ( GTK_TREE_VIEW (selector->source));
422
423   GList *selected_rows =
424     gtk_tree_selection_get_selected_rows (selection, NULL);
425
426   GtkTreeModel *childmodel  = gtk_tree_model_filter_get_model
427     (selector->filtered_source);
428
429   g_return_if_fail (selector->select_items);
430
431
432   for (item = g_list_first (selected_rows);
433        item != NULL;
434        item = g_list_next (item))
435     {
436       GtkTreeIter child_iter;
437       GtkTreeIter iter;
438       GtkTreePath *path  = item->data;
439
440       gtk_tree_model_get_iter (GTK_TREE_MODEL (selector->filtered_source),
441                                &iter, path);
442
443       gtk_tree_model_filter_convert_iter_to_child_iter
444         (selector->filtered_source,
445          &child_iter,
446          &iter);
447
448       selector->select_items (child_iter,
449                               selector->dest,
450                               childmodel);
451     }
452
453   g_list_foreach (selected_rows, (GFunc) gtk_tree_path_free, NULL);
454   g_list_free (selected_rows);
455
456   gtk_tree_model_filter_refilter (selector->filtered_source);
457
458   g_signal_emit (selector, signals [SELECTED], 0);
459 }
460
461 /* Callback fro then the source treeview is activated (double clicked) */
462 static void
463 on_row_activate (GtkTreeView       *tree_view,
464                  GtkTreePath       *path,
465                  GtkTreeViewColumn *column,
466                  gpointer           data)
467 {
468   PsppireSelector *selector  = data;
469
470   select_selection (selector);
471 }
472
473 /* Callback for when the selector button is clicked */
474 static void
475 on_click (PsppireSelector *selector, gpointer data)
476 {
477   switch (selector->direction)
478     {
479     case PSPPIRE_SELECTOR_SOURCE_TO_DEST:
480       select_selection (selector);
481       break;
482     case PSPPIRE_SELECTOR_DEST_TO_SOURCE:
483       de_select_selection (selector);
484       break;
485     default:
486       g_assert_not_reached ();
487       break;
488     }
489 }
490
491 /* Default visibility filter for GtkTreeView DEST widget */
492 static gboolean
493 is_item_in_dest (GtkTreeModel *model, GtkTreeIter *iter,
494                  PsppireSelector *selector)
495 {
496   GtkTreeModel *dest_model;
497   GtkTreeIter dest_iter;
498   GtkTreeIter source_iter;
499   gint index;
500   GtkTreePath *path ;
501   GtkTreeModel *source_model;
502
503   if ( GTK_IS_TREE_MODEL_FILTER (model) )
504     {
505       source_model = gtk_tree_model_filter_get_model
506         (GTK_TREE_MODEL_FILTER (model));
507
508       gtk_tree_model_filter_convert_iter_to_child_iter
509         ( GTK_TREE_MODEL_FILTER (model),  &source_iter,  iter  );
510     }
511   else
512     {
513       source_model = model;
514       source_iter = *iter;
515     }
516
517   dest_model = gtk_tree_view_get_model (GTK_TREE_VIEW (selector->dest));
518
519   path = gtk_tree_model_get_path (source_model, &source_iter);
520
521   index = *gtk_tree_path_get_indices (path);
522
523   gtk_tree_path_free (path);
524
525   if ( ! gtk_tree_model_get_iter_first (dest_model, &dest_iter) )
526     return FALSE;
527
528   do
529     {
530       GValue value = {0};
531       gtk_tree_model_get_value (dest_model, &dest_iter, 0, &value);
532
533       if ( g_value_get_int (&value) == index)
534         return TRUE;
535     }
536   while (gtk_tree_model_iter_next (dest_model, &dest_iter));
537
538   return FALSE;
539 }
540
541 /* Visibility function for items in the SOURCE widget.
542    Returns TRUE iff *all* the selectors for which SOURCE is associated
543    are visible */
544 static gboolean
545 is_source_item_visible (GtkTreeModel *childmodel,
546                         GtkTreeIter *iter, gpointer data)
547 {
548   PsppireSelector *selector = data;
549   PsppireSelectorClass *class = g_type_class_peek (PSPPIRE_SELECTOR_TYPE);
550
551   GList *list = NULL;
552
553   list = g_hash_table_lookup (class->source_hash, selector->source);
554
555   while (list)
556     {
557       PsppireSelector *selector = list->data;
558
559       if ( selector->filter (childmodel, iter, selector))
560           return FALSE;
561
562       list = list->next;
563     }
564
565
566   return TRUE;
567 }
568
569 /* set the source widget to SOURCE */
570 static void
571 set_tree_view_source (PsppireSelector *selector,
572                       GtkTreeView *source)
573 {
574   GtkTreeSelection* selection ;
575   GList *list = NULL;
576
577   PsppireSelectorClass *class = g_type_class_peek (PSPPIRE_SELECTOR_TYPE);
578
579   if ( ! (list = g_hash_table_lookup (class->source_hash, source)))
580     {
581       selector->filtered_source =
582         GTK_TREE_MODEL_FILTER (gtk_tree_model_filter_new
583                                (gtk_tree_view_get_model (source),  NULL));
584
585       gtk_tree_view_set_model (source, NULL);
586
587       gtk_tree_view_set_model (source,
588                                GTK_TREE_MODEL (selector->filtered_source));
589
590       list = g_list_append (list, selector);
591       g_hash_table_insert (class->source_hash, source, list);
592
593
594       gtk_tree_model_filter_set_visible_func (selector->filtered_source,
595                                               is_source_item_visible,
596                                               selector,
597                                               NULL);
598     }
599   else
600     {  /* Append this selector to the list and push the <source,list>
601           pair onto the hash table */
602
603       selector->filtered_source = GTK_TREE_MODEL_FILTER (
604         gtk_tree_view_get_model (source));
605
606       list = g_list_append (list, selector);
607       g_hash_table_replace (class->source_hash, source, list);
608     }
609
610   selection = gtk_tree_view_get_selection (source);
611
612   g_signal_connect (source, "row-activated", G_CALLBACK (on_row_activate),
613                     selector);
614
615   g_signal_connect (selection, "changed", G_CALLBACK (on_source_select),
616                     selector);
617 }
618
619
620 /* Set the destination widget to DEST */
621 static void
622 set_tree_view_dest (PsppireSelector *selector,
623                     GtkTreeView *dest)
624 {
625   GtkTreeSelection* selection = gtk_tree_view_get_selection (dest);
626
627   gtk_tree_selection_set_mode (selection, GTK_SELECTION_MULTIPLE);
628
629   g_signal_connect (selection, "changed", G_CALLBACK (on_dest_treeview_select),
630                     selector);
631 }
632
633 /* Callback for when the DEST GtkEntry is activated (Enter is pressed) */
634 static void
635 on_entry_activate (GtkEntry *w, gpointer data)
636 {
637   PsppireSelector * selector = data;
638
639   gtk_tree_model_filter_refilter (selector->filtered_source);
640 }
641
642 /* Callback for when the DEST GtkEntry is selected (clicked) */
643 static gboolean
644 on_entry_dest_select (GtkWidget *widget, GdkEventFocus *event, gpointer data)
645 {
646   PsppireSelector * selector = data;
647
648   set_direction (selector, PSPPIRE_SELECTOR_DEST_TO_SOURCE);
649
650   return FALSE;
651 }
652
653 /* Set DEST to be the destination GtkEntry widget */
654 static void
655 set_entry_dest (PsppireSelector *selector,
656                 GtkEntry *dest)
657 {
658   g_signal_connect (dest, "activate", G_CALLBACK (on_entry_activate),
659                     selector);
660
661   g_signal_connect (dest, "focus-in-event", G_CALLBACK (on_entry_dest_select),
662                     selector);
663 }
664
665
666 /* Set SOURCE and DEST for this selector, and
667    set SELECT_FUNC and FILTER_FUNC */
668 void
669 psppire_selector_set_subjects (PsppireSelector *selector,
670                                GtkWidget *source,
671                                GtkWidget *dest,
672                                SelectItemsFunc *select_func,
673                                FilterItemsFunc *filter_func )
674 {
675   selector->filter = filter_func ;
676
677   selector->source = source;
678   selector->dest = dest;
679
680   if ( filter_func == NULL)
681     {
682       if  (GTK_IS_TREE_VIEW (dest))
683         selector->filter = is_item_in_dest;
684     }
685
686   g_signal_connect (selector, "clicked", G_CALLBACK (on_click), NULL);
687
688   if ( GTK_IS_TREE_VIEW (source))
689     set_tree_view_source (selector, GTK_TREE_VIEW (source) );
690   else
691     g_error ("Unsupported source widget: %s", G_OBJECT_TYPE_NAME (source));
692
693   g_assert ( GTK_IS_TREE_MODEL_FILTER (selector->filtered_source));
694
695   if  ( GTK_IS_TREE_VIEW (dest))
696     set_tree_view_dest (selector, GTK_TREE_VIEW (dest));
697
698   else if ( GTK_IS_ENTRY (dest))
699     set_entry_dest (selector, GTK_ENTRY (dest));
700
701   else
702     g_error ("Unsupported destination widget: %s", G_OBJECT_TYPE_NAME (dest));
703
704   selector->select_items = select_func;
705 }
706
707
708
709 GType
710 psppire_selector_orientation_get_type (void)
711 {
712   static GType etype = 0;
713   if (etype == 0) {
714     static const GEnumValue values[] = {
715       { PSPPIRE_SELECT_SOURCE_BEFORE_DEST, "PSPPIRE_SELECT_SOURCE_BEFORE_DEST", "source before destination" },
716       { PSPPIRE_SELECT_SOURCE_AFTER_DEST, "PSPPIRE_SELECT_SOURCE_AFTER_DEST", "source after destination" },
717       { PSPPIRE_SELECT_SOURCE_ABOVE_DEST, "PSPPIRE_SELECT_SOURCE_ABOVE_DEST", "source above destination" },
718       { PSPPIRE_SELECT_SOURCE_BELOW_DEST, "PSPPIRE_SELECT_SOURCE_BELOW_DEST", "source below destination" },
719       { 0, NULL, NULL }
720     };
721     etype = g_enum_register_static (g_intern_static_string ("PsppireSelectorOrientation"), values);
722   }
723   return etype;
724 }