1 /* PSPPIRE - a graphical user interface for PSPP.
2 Copyright (C) 2009, 2010, 2011, 2012, 2013, 2017,
3 2020 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 3 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, see <http://www.gnu.org/licenses/>. */
21 #include "psppire-dictview.h"
22 #include "psppire-dict.h"
23 #include "dict-display.h"
24 #include "psppire-conf.h"
25 #include "options-dialog.h"
26 #include <data/format.h>
27 #include <libpspp/i18n.h>
31 #define _(msgid) gettext (msgid)
32 #define N_(msgid) msgid
34 static void psppire_dict_view_base_finalize (PsppireDictViewClass *, gpointer);
35 static void psppire_dict_view_base_init (PsppireDictViewClass *class);
36 static void psppire_dict_view_class_init (PsppireDictViewClass *class);
37 static void psppire_dict_view_init (PsppireDictView *dict_view);
40 psppire_dict_view_get_type (void)
42 static GType psppire_dict_view_type = 0;
44 if (!psppire_dict_view_type)
46 static const GTypeInfo psppire_dict_view_info =
48 sizeof (PsppireDictViewClass),
49 (GBaseInitFunc) (void (*)(void)) psppire_dict_view_base_init,
50 (GBaseFinalizeFunc) (void (*)(void)) psppire_dict_view_base_finalize,
51 (GClassInitFunc) (void (*)(void)) psppire_dict_view_class_init,
52 (GClassFinalizeFunc) NULL,
54 sizeof (PsppireDictView),
56 (GInstanceInitFunc) (void (*)(void)) psppire_dict_view_init,
57 NULL /* value_table */
60 psppire_dict_view_type =
61 g_type_register_static (GTK_TYPE_TREE_VIEW, "PsppireDictView",
62 &psppire_dict_view_info, 0);
65 return psppire_dict_view_type;
70 psppire_dict_view_finalize (GObject *object)
72 PsppireDictView *dict_view = PSPPIRE_DICT_VIEW (object);
74 gtk_widget_destroy (dict_view->menu);
88 /* A GtkTreeModelFilterVisibleFunc to filter lines in the treeview */
90 filter_variables (GtkTreeModel *tmodel, GtkTreeIter *titer, gpointer data)
92 var_predicate_func *predicate = data;
94 GtkTreeModel *model = NULL;
100 get_base_model (tmodel, titer, &model, &iter);
102 dict = PSPPIRE_DICT (model);
103 path = gtk_tree_model_get_path (model, &iter);
104 idx = gtk_tree_path_get_indices (path);
105 var = psppire_dict_get_variable (dict, *idx);
107 gtk_tree_path_free (path);
109 return predicate (var);
113 unsorted (GtkTreeModel *model,
118 struct variable *var_a;
119 struct variable *var_b;
121 gtk_tree_model_get (model, a, DICT_TVM_COL_VAR, &var_a, -1);
122 gtk_tree_model_get (model, b, DICT_TVM_COL_VAR, &var_b, -1);
124 gint rval = compare_var_ptrs_by_dict_index (&var_a, &var_b, NULL);
133 sort_by_name (GtkTreeModel *model,
138 struct variable *var_a;
139 struct variable *var_b;
141 gtk_tree_model_get (model, a, DICT_TVM_COL_VAR, &var_a, -1);
142 gtk_tree_model_get (model, b, DICT_TVM_COL_VAR, &var_b, -1);
144 gint rval = g_strcmp0 (var_get_name (var_a), var_get_name (var_b));
154 sort_by_label (GtkTreeModel *model,
159 struct variable *var_a;
160 struct variable *var_b;
162 gtk_tree_model_get (model, a, DICT_TVM_COL_VAR, &var_a, -1);
163 gtk_tree_model_get (model, b, DICT_TVM_COL_VAR, &var_b, -1);
165 gint rval = g_strcmp0 (var_get_label (var_a), var_get_label (var_b));
175 default_sort (GtkTreeModel *model,
181 psppire_conf_get_enum (psppire_conf_new (), "VariableLists", "sort-order",
182 PSPP_TYPE_OPTIONS_VAR_ORDER, &what);
187 return unsorted (model, a, b, user_data);
189 case PSPP_OPTIONS_VAR_ORDER_NAME:
190 return sort_by_name (model, a, b, user_data);
192 case PSPP_OPTIONS_VAR_ORDER_LABEL:
193 return sort_by_label (model, a, b, user_data);
197 g_assert_not_reached ();
204 set_model (PsppireDictView *dict_view)
206 GtkTreeModel *model = NULL;
208 if (dict_view->dict == NULL)
211 dict_view->sorted_model = gtk_tree_model_sort_new_with_model (GTK_TREE_MODEL (dict_view->dict));
212 gtk_tree_sortable_set_default_sort_func (GTK_TREE_SORTABLE (dict_view->sorted_model), default_sort, dict_view, 0);
213 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (dict_view->sorted_model),
214 GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, GTK_SORT_ASCENDING);
216 if (dict_view->predicate)
218 model = gtk_tree_model_filter_new (dict_view->sorted_model, NULL);
220 gtk_tree_model_filter_set_visible_func (GTK_TREE_MODEL_FILTER (model),
222 dict_view->predicate,
227 model = dict_view->sorted_model;
228 g_object_ref (model);
231 gtk_tree_view_set_model (GTK_TREE_VIEW (dict_view), model);
232 g_object_unref (model);
236 psppire_dict_view_set_property (GObject *object,
241 PsppireDictView *dict_view = PSPPIRE_DICT_VIEW (object);
245 case PROP_DICTIONARY:
246 dict_view->dict = g_value_get_object (value);
249 dict_view->predicate = g_value_get_pointer (value);
251 case PROP_SELECTION_MODE:
253 GtkTreeSelection *selection =
254 gtk_tree_view_get_selection (GTK_TREE_VIEW (dict_view));
256 GtkSelectionMode mode = g_value_get_enum (value);
258 gtk_tree_selection_set_mode (selection, mode);
262 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
267 set_model (dict_view);
272 psppire_dict_view_get_property (GObject *object,
277 PsppireDictView *dict_view = PSPPIRE_DICT_VIEW (object);
281 case PROP_DICTIONARY:
282 g_value_set_object (value, dict_view->dict);
285 g_value_set_pointer (value, dict_view->predicate);
287 case PROP_SELECTION_MODE:
289 GtkTreeSelection *selection =
290 gtk_tree_view_get_selection (GTK_TREE_VIEW (dict_view));
292 g_value_set_enum (value, gtk_tree_selection_get_mode (selection));
295 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
303 psppire_dict_view_class_init (PsppireDictViewClass *class)
305 GObjectClass *object_class = G_OBJECT_CLASS (class);
307 GParamSpec *predicate_spec =
308 g_param_spec_pointer ("predicate",
310 "A predicate function",
311 G_PARAM_READABLE | G_PARAM_WRITABLE);
314 GParamSpec *selection_mode_spec =
315 g_param_spec_enum ("selection-mode",
317 "How many things can be selected",
318 GTK_TYPE_SELECTION_MODE,
319 GTK_SELECTION_MULTIPLE,
320 G_PARAM_CONSTRUCT | G_PARAM_READABLE | G_PARAM_WRITABLE);
322 object_class->set_property = psppire_dict_view_set_property;
323 object_class->get_property = psppire_dict_view_get_property;
325 g_object_class_override_property (object_class,
329 g_object_class_install_property (object_class,
333 g_object_class_install_property (object_class,
335 selection_mode_spec);
340 psppire_dict_view_base_init (PsppireDictViewClass *class)
342 GObjectClass *object_class = G_OBJECT_CLASS (class);
344 object_class->finalize = psppire_dict_view_finalize;
350 psppire_dict_view_base_finalize (PsppireDictViewClass *class,
357 use_labels (PsppireDictView *dv)
359 gboolean disp_labels = TRUE;
361 if (gtk_check_menu_item_get_inconsistent (GTK_CHECK_MENU_ITEM
362 (dv->override_button)))
364 psppire_conf_get_boolean (psppire_conf_new (),
365 "VariableLists", "display-labels", &disp_labels);
369 disp_labels = gtk_check_menu_item_get_active (GTK_CHECK_MENU_ITEM
370 (dv->override_button));
376 /* A GtkTreeCellDataFunc which renders the name and/or label of the
379 var_description_cell_data_func (GtkTreeViewColumn *col,
380 GtkCellRenderer *cell,
381 GtkTreeModel *top_model,
382 GtkTreeIter *top_iter,
385 PsppireDictView *dv = PSPPIRE_DICT_VIEW (data);
386 struct variable *var;
390 get_base_model (top_model, top_iter, &model, &iter);
392 gtk_tree_model_get (model,
393 &iter, DICT_TVM_COL_VAR, &var, -1);
395 if (var_has_label (var) && use_labels (dv))
397 gchar *text = g_markup_printf_escaped (
398 "<span stretch=\"condensed\">%s</span>",
399 var_get_label (var));
401 g_object_set (cell, "markup", text, NULL);
406 g_object_set (cell, "text", var_get_name (var), NULL);
414 /* A GtkTreeCellDataFunc which sets the icon appropriate to the type
417 var_icon_cell_data_func (GtkTreeViewColumn *col,
418 GtkCellRenderer *cell,
423 struct variable *var;
425 gtk_tree_model_get (model, iter, DICT_TVM_COL_VAR, &var, -1);
428 "stock-size", GTK_ICON_SIZE_MENU,
429 "icon-name", get_var_measurement_stock_id (var_get_print_format (var)->type,
430 var_get_measure (var)),
437 get_var_measurement_stock_id (enum fmt_type type, enum measure measure)
439 switch (fmt_get_category (type))
444 case MEASURE_NOMINAL: return "measure-string-nominal";
445 case MEASURE_ORDINAL: return "measure-string-ordinal";
446 case MEASURE_SCALE: return "role-none";
447 case n_MEASURES: break;
455 case MEASURE_NOMINAL: return "measure-date-nominal";
456 case MEASURE_ORDINAL: return "measure-date-ordinal";
457 case MEASURE_SCALE: return "measure-date-scale";
458 case n_MEASURES: break;
465 case MEASURE_NOMINAL: return "measure-nominal";
466 case MEASURE_ORDINAL: return "measure-ordinal";
467 case MEASURE_SCALE: return "measure-scale";
468 case n_MEASURES: break;
473 g_return_val_if_reached ("");
478 /* Sets the tooltip to be the name of the variable under the cursor */
480 set_tooltip_for_variable (GtkTreeView *treeview,
483 gboolean keyboard_mode,
490 GtkTreeModel *tree_model;
491 struct variable *var = NULL;
494 gtk_tree_view_convert_widget_to_bin_window_coords (treeview,
497 if (!gtk_tree_view_get_path_at_pos (treeview, bx, by,
498 &path, NULL, NULL, NULL))
501 tree_model = gtk_tree_view_get_model (treeview);
503 gtk_tree_view_set_tooltip_row (treeview, tooltip, path);
505 ok = gtk_tree_model_get_iter (tree_model, &iter, path);
507 gtk_tree_path_free (path);
511 gtk_tree_model_get (tree_model, &iter, DICT_TVM_COL_VAR, &var, -1);
513 if (! var_has_label (var))
523 get_base_model (tree_model, NULL, &m, NULL);
525 if (use_labels (PSPPIRE_DICT_VIEW (treeview)))
526 tip = var_get_name (var);
528 tip = var_get_label (var);
530 gtk_tooltip_set_text (tooltip, tip);
538 show_menu (PsppireDictView *dv, GdkEvent *event, gpointer data)
540 if (((GdkEventButton *) event)->button != 3)
543 gtk_menu_popup_at_pointer (GTK_MENU (dv->menu), event);
549 toggle_label_preference (GtkCheckMenuItem *checkbox, gpointer data)
551 PsppireDictView *dv = PSPPIRE_DICT_VIEW (data);
553 gboolean global_setting = TRUE;
554 psppire_conf_get_boolean (psppire_conf_new (),
555 "VariableLists", "display-labels", &global_setting);
557 if (gtk_check_menu_item_get_inconsistent (checkbox))
558 gtk_check_menu_item_set_active (checkbox, !global_setting);
560 gtk_check_menu_item_set_inconsistent (checkbox, FALSE);
562 gtk_widget_queue_draw (GTK_WIDGET (dv));
567 set_sort_criteria (GtkCheckMenuItem *checkbox, PsppireDictView *dv, GtkTreeIterCompareFunc func)
569 if (!gtk_check_menu_item_get_active (checkbox))
571 gtk_widget_queue_draw (GTK_WIDGET (dv));
576 gtk_tree_sortable_set_default_sort_func (GTK_TREE_SORTABLE (dv->sorted_model), func, 0, 0);
579 gtk_widget_queue_draw (GTK_WIDGET (dv));
583 set_sort_criteria_default (GtkCheckMenuItem *checkbox, gpointer data)
585 PsppireDictView *dv = PSPPIRE_DICT_VIEW (data);
586 set_sort_criteria (checkbox, dv, default_sort);
591 set_sort_criteria_name (GtkCheckMenuItem *checkbox, gpointer data)
593 PsppireDictView *dv = PSPPIRE_DICT_VIEW (data);
594 set_sort_criteria (checkbox, dv, sort_by_name);
599 set_sort_criteria_label (GtkCheckMenuItem *checkbox, gpointer data)
601 PsppireDictView *dv = PSPPIRE_DICT_VIEW (data);
602 set_sort_criteria (checkbox, dv, sort_by_label);
607 set_sort_criteria_unsorted (GtkCheckMenuItem *checkbox, gpointer data)
609 PsppireDictView *dv = PSPPIRE_DICT_VIEW (data);
610 set_sort_criteria (checkbox, dv, unsorted);
616 psppire_dict_view_init (PsppireDictView *dict_view)
618 GtkTreeViewColumn *col = gtk_tree_view_column_new ();
620 GtkCellRenderer *renderer = gtk_cell_renderer_pixbuf_new ();
622 dict_view->prefer_labels_override = FALSE;
623 dict_view->sorted_model = NULL;
625 gtk_tree_view_column_set_title (col, _("Variable"));
627 gtk_tree_view_column_pack_start (col, renderer, FALSE);
629 gtk_tree_view_column_set_cell_data_func (col, renderer,
630 var_icon_cell_data_func,
633 renderer = gtk_cell_renderer_text_new ();
634 gtk_tree_view_column_pack_start (col, renderer, TRUE);
635 gtk_tree_view_column_set_cell_data_func (col, renderer,
636 var_description_cell_data_func,
639 g_object_set (renderer, "ellipsize-set", TRUE, NULL);
640 g_object_set (renderer, "ellipsize", PANGO_ELLIPSIZE_MIDDLE, NULL);
642 gtk_tree_view_column_set_sizing (col, GTK_TREE_VIEW_COLUMN_FIXED);
644 /* FIXME: make this a value in terms of character widths */
645 gtk_tree_view_column_set_min_width (col, 150);
647 gtk_tree_view_append_column (GTK_TREE_VIEW (dict_view), col);
649 g_object_set (dict_view,
651 "headers-visible", FALSE,
654 g_signal_connect (dict_view, "query-tooltip",
655 G_CALLBACK (set_tooltip_for_variable), NULL);
657 dict_view->menu = gtk_menu_new ();
660 GSList *group = NULL;
662 gtk_check_menu_item_new_with_label (_("Prefer variable labels"));
664 dict_view->override_button = item;
665 gtk_check_menu_item_set_inconsistent (GTK_CHECK_MENU_ITEM (item),
668 g_signal_connect (item, "toggled",
669 G_CALLBACK (toggle_label_preference), dict_view);
671 gtk_menu_shell_append (GTK_MENU_SHELL (dict_view->menu), item);
673 item = gtk_separator_menu_item_new ();
674 gtk_menu_shell_append (GTK_MENU_SHELL (dict_view->menu), item);
676 item = gtk_radio_menu_item_new_with_label (group, _("Default sort order"));
677 group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (item));
678 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (item), TRUE);
679 gtk_menu_shell_append (GTK_MENU_SHELL (dict_view->menu), item);
680 g_signal_connect (item, "toggled", G_CALLBACK (set_sort_criteria_default), dict_view);
682 item = gtk_radio_menu_item_new_with_label (group, _("Unsorted (dictionary order)"));
683 group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (item));
684 gtk_menu_shell_append (GTK_MENU_SHELL (dict_view->menu), item);
685 g_signal_connect (item, "toggled", G_CALLBACK (set_sort_criteria_unsorted), dict_view);
687 item = gtk_radio_menu_item_new_with_label (group, _("Sort by name"));
688 group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (item));
689 gtk_menu_shell_append (GTK_MENU_SHELL (dict_view->menu), item);
690 g_signal_connect (item, "toggled", G_CALLBACK (set_sort_criteria_name), dict_view);
692 item = gtk_radio_menu_item_new_with_label (group, _("Sort by label"));
693 group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (item));
694 gtk_menu_shell_append (GTK_MENU_SHELL (dict_view->menu), item);
695 g_signal_connect (item, "toggled", G_CALLBACK (set_sort_criteria_label), dict_view);
698 gtk_widget_show_all (dict_view->menu);
700 g_signal_connect (dict_view, "button-press-event",
701 G_CALLBACK (show_menu), NULL);
706 psppire_dict_view_new (void)
708 return GTK_WIDGET (g_object_new (psppire_dict_view_get_type (), NULL));
711 static struct variable *
712 psppire_dict_view_iter_to_var (PsppireDictView *dict_view,
713 GtkTreeIter *top_iter)
715 GtkTreeView *treeview = GTK_TREE_VIEW (dict_view);
716 GtkTreeModel *top_model = gtk_tree_view_get_model (treeview);
718 struct variable *var;
722 get_base_model (top_model, top_iter, &model, &iter);
724 g_assert (PSPPIRE_IS_DICT (model));
726 gtk_tree_model_get (model,
727 &iter, DICT_TVM_COL_VAR, &var, -1);
734 PsppireDictView *dict_view;
735 struct variable **vars;
740 get_vars_cb (GtkTreeModel *model, GtkTreePath *path, GtkTreeIter *iter,
743 struct get_vars_aux *aux = data;
744 struct variable *var = psppire_dict_view_iter_to_var (aux->dict_view, iter);
746 g_return_if_fail (var != NULL);
747 aux->vars[aux->idx++] = var;
751 psppire_dict_view_get_selected_variables (PsppireDictView *dict_view,
752 struct variable ***vars,
755 GtkTreeView *tree_view = GTK_TREE_VIEW (dict_view);
756 GtkTreeSelection *selection = gtk_tree_view_get_selection (tree_view);
757 gint n_vars = gtk_tree_selection_count_selected_rows (selection);
758 struct get_vars_aux aux;
760 *vars = g_malloc_n (n_vars, sizeof **vars);
762 aux.dict_view = dict_view;
765 gtk_tree_selection_selected_foreach (selection, get_vars_cb, &aux);
768 g_return_if_fail (aux.idx >= n_vars);
772 psppire_dict_view_get_selected_variable (PsppireDictView *dict_view)
774 GtkTreeView *tree_view = GTK_TREE_VIEW (dict_view);
775 GtkTreeSelection *selection = gtk_tree_view_get_selection (tree_view);
778 if (gtk_tree_selection_get_selected (selection, NULL, &iter))
779 return psppire_dict_view_iter_to_var (dict_view, &iter);