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_class_init (PsppireDictViewClass *class);
35 static void psppire_dict_view_init (PsppireDictView *dict_view);
37 G_DEFINE_TYPE (PsppireDictView, psppire_dict_view, GTK_TYPE_TREE_VIEW)
40 psppire_dict_view_finalize (GObject *object)
42 PsppireDictView *dict_view = PSPPIRE_DICT_VIEW (object);
44 gtk_widget_destroy (dict_view->menu);
58 /* A GtkTreeModelFilterVisibleFunc to filter lines in the treeview */
60 filter_variables (GtkTreeModel *tmodel, GtkTreeIter *titer, gpointer data)
62 var_predicate_func *predicate = data;
64 GtkTreeModel *model = NULL;
70 get_base_model (tmodel, titer, &model, &iter);
72 dict = PSPPIRE_DICT (model);
73 path = gtk_tree_model_get_path (model, &iter);
74 idx = gtk_tree_path_get_indices (path);
75 var = psppire_dict_get_variable (dict, *idx);
77 gtk_tree_path_free (path);
79 return predicate (var);
83 unsorted (GtkTreeModel *model,
88 struct variable *var_a;
89 struct variable *var_b;
91 gtk_tree_model_get (model, a, DICT_TVM_COL_VAR, &var_a, -1);
92 gtk_tree_model_get (model, b, DICT_TVM_COL_VAR, &var_b, -1);
94 gint rval = compare_var_ptrs_by_dict_index (&var_a, &var_b, NULL);
103 sort_by_name (GtkTreeModel *model,
108 struct variable *var_a;
109 struct variable *var_b;
111 gtk_tree_model_get (model, a, DICT_TVM_COL_VAR, &var_a, -1);
112 gtk_tree_model_get (model, b, DICT_TVM_COL_VAR, &var_b, -1);
114 gint rval = g_strcmp0 (var_get_name (var_a), var_get_name (var_b));
124 sort_by_label (GtkTreeModel *model,
129 struct variable *var_a;
130 struct variable *var_b;
132 gtk_tree_model_get (model, a, DICT_TVM_COL_VAR, &var_a, -1);
133 gtk_tree_model_get (model, b, DICT_TVM_COL_VAR, &var_b, -1);
135 gint rval = g_strcmp0 (var_get_label (var_a), var_get_label (var_b));
145 default_sort (GtkTreeModel *model,
151 psppire_conf_get_enum (psppire_conf_new (), "VariableLists", "sort-order",
152 PSPP_TYPE_OPTIONS_VAR_ORDER, &what);
157 return unsorted (model, a, b, user_data);
159 case PSPP_OPTIONS_VAR_ORDER_NAME:
160 return sort_by_name (model, a, b, user_data);
162 case PSPP_OPTIONS_VAR_ORDER_LABEL:
163 return sort_by_label (model, a, b, user_data);
167 g_assert_not_reached ();
174 set_model (PsppireDictView *dict_view)
176 GtkTreeModel *model = NULL;
178 if (dict_view->dict == NULL)
181 dict_view->sorted_model = gtk_tree_model_sort_new_with_model (GTK_TREE_MODEL (dict_view->dict));
182 gtk_tree_sortable_set_default_sort_func (GTK_TREE_SORTABLE (dict_view->sorted_model), default_sort, dict_view, 0);
183 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (dict_view->sorted_model),
184 GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, GTK_SORT_ASCENDING);
186 if (dict_view->predicate)
188 model = gtk_tree_model_filter_new (dict_view->sorted_model, NULL);
190 gtk_tree_model_filter_set_visible_func (GTK_TREE_MODEL_FILTER (model),
192 dict_view->predicate,
197 model = dict_view->sorted_model;
198 g_object_ref (model);
201 gtk_tree_view_set_model (GTK_TREE_VIEW (dict_view), model);
202 g_object_unref (model);
206 psppire_dict_view_set_property (GObject *object,
211 PsppireDictView *dict_view = PSPPIRE_DICT_VIEW (object);
215 case PROP_DICTIONARY:
216 dict_view->dict = g_value_get_object (value);
219 dict_view->predicate = g_value_get_pointer (value);
221 case PROP_SELECTION_MODE:
223 GtkTreeSelection *selection =
224 gtk_tree_view_get_selection (GTK_TREE_VIEW (dict_view));
226 GtkSelectionMode mode = g_value_get_enum (value);
228 gtk_tree_selection_set_mode (selection, mode);
232 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
237 set_model (dict_view);
242 psppire_dict_view_get_property (GObject *object,
247 PsppireDictView *dict_view = PSPPIRE_DICT_VIEW (object);
251 case PROP_DICTIONARY:
252 g_value_set_object (value, dict_view->dict);
255 g_value_set_pointer (value, dict_view->predicate);
257 case PROP_SELECTION_MODE:
259 GtkTreeSelection *selection =
260 gtk_tree_view_get_selection (GTK_TREE_VIEW (dict_view));
262 g_value_set_enum (value, gtk_tree_selection_get_mode (selection));
266 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
274 psppire_dict_view_class_init (PsppireDictViewClass *class)
276 GObjectClass *object_class = G_OBJECT_CLASS (class);
278 object_class->finalize = psppire_dict_view_finalize;
280 GParamSpec *predicate_spec =
281 g_param_spec_pointer ("predicate",
283 "A predicate function",
284 G_PARAM_READABLE | G_PARAM_WRITABLE);
287 GParamSpec *selection_mode_spec =
288 g_param_spec_enum ("selection-mode",
290 "How many things can be selected",
291 GTK_TYPE_SELECTION_MODE,
292 GTK_SELECTION_MULTIPLE,
293 G_PARAM_CONSTRUCT | G_PARAM_READABLE | G_PARAM_WRITABLE);
295 object_class->set_property = psppire_dict_view_set_property;
296 object_class->get_property = psppire_dict_view_get_property;
298 g_object_class_override_property (object_class,
302 g_object_class_install_property (object_class,
306 g_object_class_install_property (object_class,
308 selection_mode_spec);
312 use_labels (PsppireDictView *dv)
314 gboolean disp_labels = TRUE;
316 if (gtk_check_menu_item_get_inconsistent (GTK_CHECK_MENU_ITEM
317 (dv->override_button)))
319 psppire_conf_get_boolean (psppire_conf_new (),
320 "VariableLists", "display-labels", &disp_labels);
324 disp_labels = gtk_check_menu_item_get_active (GTK_CHECK_MENU_ITEM
325 (dv->override_button));
331 /* A GtkTreeCellDataFunc which renders the name and/or label of the
334 var_description_cell_data_func (GtkTreeViewColumn *col,
335 GtkCellRenderer *cell,
336 GtkTreeModel *top_model,
337 GtkTreeIter *top_iter,
340 PsppireDictView *dv = PSPPIRE_DICT_VIEW (data);
341 struct variable *var;
345 get_base_model (top_model, top_iter, &model, &iter);
347 gtk_tree_model_get (model,
348 &iter, DICT_TVM_COL_VAR, &var, -1);
350 if (var_has_label (var) && use_labels (dv))
352 gchar *text = g_markup_printf_escaped (
353 "<span stretch=\"condensed\">%s</span>",
354 var_get_label (var));
356 g_object_set (cell, "markup", text, NULL);
361 g_object_set (cell, "text", var_get_name (var), NULL);
369 /* A GtkTreeCellDataFunc which sets the icon appropriate to the type
372 var_icon_cell_data_func (GtkTreeViewColumn *col,
373 GtkCellRenderer *cell,
378 struct variable *var;
380 gtk_tree_model_get (model, iter, DICT_TVM_COL_VAR, &var, -1);
383 "stock-size", GTK_ICON_SIZE_MENU,
384 "icon-name", get_var_measurement_stock_id (var_get_print_format (var)->type,
385 var_get_measure (var)),
392 get_var_measurement_stock_id (enum fmt_type type, enum measure measure)
394 switch (fmt_get_category (type))
399 case MEASURE_NOMINAL: return "measure-string-nominal";
400 case MEASURE_ORDINAL: return "measure-string-ordinal";
401 case MEASURE_SCALE: return "role-none";
402 case n_MEASURES: break;
410 case MEASURE_NOMINAL: return "measure-date-nominal";
411 case MEASURE_ORDINAL: return "measure-date-ordinal";
412 case MEASURE_SCALE: return "measure-date-scale";
413 case n_MEASURES: break;
420 case MEASURE_NOMINAL: return "measure-nominal";
421 case MEASURE_ORDINAL: return "measure-ordinal";
422 case MEASURE_SCALE: return "measure-scale";
423 case n_MEASURES: break;
428 g_return_val_if_reached ("");
433 /* Sets the tooltip to be the name of the variable under the cursor */
435 set_tooltip_for_variable (GtkTreeView *treeview,
438 gboolean keyboard_mode,
445 GtkTreeModel *tree_model;
446 struct variable *var = NULL;
449 gtk_tree_view_convert_widget_to_bin_window_coords (treeview,
452 if (!gtk_tree_view_get_path_at_pos (treeview, bx, by,
453 &path, NULL, NULL, NULL))
456 tree_model = gtk_tree_view_get_model (treeview);
458 gtk_tree_view_set_tooltip_row (treeview, tooltip, path);
460 ok = gtk_tree_model_get_iter (tree_model, &iter, path);
462 gtk_tree_path_free (path);
466 gtk_tree_model_get (tree_model, &iter, DICT_TVM_COL_VAR, &var, -1);
468 if (! var_has_label (var))
478 get_base_model (tree_model, NULL, &m, NULL);
480 if (use_labels (PSPPIRE_DICT_VIEW (treeview)))
481 tip = var_get_name (var);
483 tip = var_get_label (var);
485 gtk_tooltip_set_text (tooltip, tip);
493 show_menu (PsppireDictView *dv, GdkEvent *event, gpointer data)
495 if (((GdkEventButton *) event)->button != 3)
498 gtk_menu_popup_at_pointer (GTK_MENU (dv->menu), event);
504 toggle_label_preference (GtkCheckMenuItem *checkbox, gpointer data)
506 PsppireDictView *dv = PSPPIRE_DICT_VIEW (data);
508 gboolean global_setting = TRUE;
509 psppire_conf_get_boolean (psppire_conf_new (),
510 "VariableLists", "display-labels", &global_setting);
512 if (gtk_check_menu_item_get_inconsistent (checkbox))
513 gtk_check_menu_item_set_active (checkbox, !global_setting);
515 gtk_check_menu_item_set_inconsistent (checkbox, FALSE);
517 gtk_widget_queue_draw (GTK_WIDGET (dv));
522 set_sort_criteria (GtkCheckMenuItem *checkbox, PsppireDictView *dv, GtkTreeIterCompareFunc func)
524 if (!gtk_check_menu_item_get_active (checkbox))
526 gtk_widget_queue_draw (GTK_WIDGET (dv));
531 gtk_tree_sortable_set_default_sort_func (GTK_TREE_SORTABLE (dv->sorted_model), func, 0, 0);
534 gtk_widget_queue_draw (GTK_WIDGET (dv));
538 set_sort_criteria_default (GtkCheckMenuItem *checkbox, gpointer data)
540 PsppireDictView *dv = PSPPIRE_DICT_VIEW (data);
541 set_sort_criteria (checkbox, dv, default_sort);
546 set_sort_criteria_name (GtkCheckMenuItem *checkbox, gpointer data)
548 PsppireDictView *dv = PSPPIRE_DICT_VIEW (data);
549 set_sort_criteria (checkbox, dv, sort_by_name);
554 set_sort_criteria_label (GtkCheckMenuItem *checkbox, gpointer data)
556 PsppireDictView *dv = PSPPIRE_DICT_VIEW (data);
557 set_sort_criteria (checkbox, dv, sort_by_label);
562 set_sort_criteria_unsorted (GtkCheckMenuItem *checkbox, gpointer data)
564 PsppireDictView *dv = PSPPIRE_DICT_VIEW (data);
565 set_sort_criteria (checkbox, dv, unsorted);
571 psppire_dict_view_init (PsppireDictView *dict_view)
573 GtkTreeViewColumn *col = gtk_tree_view_column_new ();
575 GtkCellRenderer *renderer = gtk_cell_renderer_pixbuf_new ();
577 dict_view->prefer_labels_override = FALSE;
578 dict_view->sorted_model = NULL;
580 gtk_tree_view_column_set_title (col, _("Variable"));
582 gtk_tree_view_column_pack_start (col, renderer, FALSE);
584 gtk_tree_view_column_set_cell_data_func (col, renderer,
585 var_icon_cell_data_func,
588 renderer = gtk_cell_renderer_text_new ();
589 gtk_tree_view_column_pack_start (col, renderer, TRUE);
590 gtk_tree_view_column_set_cell_data_func (col, renderer,
591 var_description_cell_data_func,
594 g_object_set (renderer, "ellipsize-set", TRUE, NULL);
595 g_object_set (renderer, "ellipsize", PANGO_ELLIPSIZE_MIDDLE, NULL);
597 gtk_tree_view_column_set_sizing (col, GTK_TREE_VIEW_COLUMN_FIXED);
599 /* FIXME: make this a value in terms of character widths */
600 gtk_tree_view_column_set_min_width (col, 150);
602 gtk_tree_view_append_column (GTK_TREE_VIEW (dict_view), col);
604 g_object_set (dict_view,
606 "headers-visible", FALSE,
609 g_signal_connect (dict_view, "query-tooltip",
610 G_CALLBACK (set_tooltip_for_variable), NULL);
612 dict_view->menu = gtk_menu_new ();
615 GSList *group = NULL;
617 gtk_check_menu_item_new_with_label (_("Prefer variable labels"));
619 dict_view->override_button = item;
620 gtk_check_menu_item_set_inconsistent (GTK_CHECK_MENU_ITEM (item),
623 g_signal_connect (item, "toggled",
624 G_CALLBACK (toggle_label_preference), dict_view);
626 gtk_menu_shell_append (GTK_MENU_SHELL (dict_view->menu), item);
628 item = gtk_separator_menu_item_new ();
629 gtk_menu_shell_append (GTK_MENU_SHELL (dict_view->menu), item);
631 item = gtk_radio_menu_item_new_with_label (group, _("Default sort order"));
632 group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (item));
633 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (item), TRUE);
634 gtk_menu_shell_append (GTK_MENU_SHELL (dict_view->menu), item);
635 g_signal_connect (item, "toggled", G_CALLBACK (set_sort_criteria_default), dict_view);
637 item = gtk_radio_menu_item_new_with_label (group, _("Unsorted (dictionary order)"));
638 group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (item));
639 gtk_menu_shell_append (GTK_MENU_SHELL (dict_view->menu), item);
640 g_signal_connect (item, "toggled", G_CALLBACK (set_sort_criteria_unsorted), dict_view);
642 item = gtk_radio_menu_item_new_with_label (group, _("Sort by name"));
643 group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (item));
644 gtk_menu_shell_append (GTK_MENU_SHELL (dict_view->menu), item);
645 g_signal_connect (item, "toggled", G_CALLBACK (set_sort_criteria_name), dict_view);
647 item = gtk_radio_menu_item_new_with_label (group, _("Sort by label"));
648 group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (item));
649 gtk_menu_shell_append (GTK_MENU_SHELL (dict_view->menu), item);
650 g_signal_connect (item, "toggled", G_CALLBACK (set_sort_criteria_label), dict_view);
653 gtk_widget_show_all (dict_view->menu);
655 g_signal_connect (dict_view, "button-press-event",
656 G_CALLBACK (show_menu), NULL);
659 static struct variable *
660 psppire_dict_view_iter_to_var (PsppireDictView *dict_view,
661 GtkTreeIter *top_iter)
663 GtkTreeView *treeview = GTK_TREE_VIEW (dict_view);
664 GtkTreeModel *top_model = gtk_tree_view_get_model (treeview);
666 struct variable *var;
670 get_base_model (top_model, top_iter, &model, &iter);
672 g_assert (PSPPIRE_IS_DICT (model));
674 gtk_tree_model_get (model,
675 &iter, DICT_TVM_COL_VAR, &var, -1);
682 PsppireDictView *dict_view;
683 struct variable **vars;
688 get_vars_cb (GtkTreeModel *model, GtkTreePath *path, GtkTreeIter *iter,
691 struct get_vars_aux *aux = data;
692 struct variable *var = psppire_dict_view_iter_to_var (aux->dict_view, iter);
694 g_return_if_fail (var != NULL);
695 aux->vars[aux->idx++] = var;
699 psppire_dict_view_get_selected_variables (PsppireDictView *dict_view,
700 struct variable ***vars,
703 GtkTreeView *tree_view = GTK_TREE_VIEW (dict_view);
704 GtkTreeSelection *selection = gtk_tree_view_get_selection (tree_view);
705 gint n_vars = gtk_tree_selection_count_selected_rows (selection);
706 struct get_vars_aux aux;
708 *vars = g_malloc_n (n_vars, sizeof **vars);
710 aux.dict_view = dict_view;
713 gtk_tree_selection_selected_foreach (selection, get_vars_cb, &aux);
716 g_return_if_fail (aux.idx >= n_vars);
720 psppire_dict_view_get_selected_variable (PsppireDictView *dict_view)
722 GtkTreeView *tree_view = GTK_TREE_VIEW (dict_view);
723 GtkTreeSelection *selection = gtk_tree_view_get_selection (tree_view);
726 if (gtk_tree_selection_get_selected (selection, NULL, &iter))
727 return psppire_dict_view_iter_to_var (dict_view, &iter);