pintos-os.org Git - pspp/blob - src/ui/gui/psppire-dictview.c

   1 /* PSPPIRE - a graphical user interface for PSPP.
   2    Copyright (C) 2009, 2010, 2011  Free Software Foundation
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation, either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program 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
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
  16
  17 #include <config.h>
  18
  19 #include <gtk/gtk.h>
  20 #include "psppire-dictview.h"
  21 #include "psppire-dict.h"
  22 #include "psppire-conf.h"
  23 #include <data/format.h>
  24 #include <libpspp/i18n.h>
  25 #include "helper.h"
  26
  27 #include <gettext.h>
  28 #define _(msgid) gettext (msgid)
  29 #define N_(msgid) msgid
  30
  31 static void psppire_dict_view_base_finalize (PsppireDictViewClass *, gpointer);
  32 static void psppire_dict_view_base_init     (PsppireDictViewClass *class);
  33 static void psppire_dict_view_class_init    (PsppireDictViewClass *class);
  34 static void psppire_dict_view_init          (PsppireDictView      *dict_view);
  35
  36
  37 GType
  38 psppire_dict_view_get_type (void)
  39 {
  40   static GType psppire_dict_view_type = 0;
  41
  42   if (!psppire_dict_view_type)
  43     {
  44       static const GTypeInfo psppire_dict_view_info =
  45       {
  46         sizeof (PsppireDictViewClass),
  47         (GBaseInitFunc) psppire_dict_view_base_init,
  48         (GBaseFinalizeFunc) psppire_dict_view_base_finalize,
  49         (GClassInitFunc)psppire_dict_view_class_init,
  50         (GClassFinalizeFunc) NULL,
  51         NULL,
  52         sizeof (PsppireDictView),
  53         0,
  54         (GInstanceInitFunc) psppire_dict_view_init,
  55       };
  56
  57       psppire_dict_view_type =
  58         g_type_register_static (GTK_TYPE_TREE_VIEW, "PsppireDictView",
  59                                 &psppire_dict_view_info, 0);
  60     }
  61
  62   return psppire_dict_view_type;
  63 }
  64
  65
  66 static void
  67 psppire_dict_view_finalize (GObject *object)
  68 {
  69   PsppireDictView *dict_view = PSPPIRE_DICT_VIEW (object);
  70
  71   gtk_widget_destroy (dict_view->menu);
  72 }
  73
  74 /* Properties */
  75 enum
  76 {
  77   PROP_0,
  78   PROP_DICTIONARY,
  79   PROP_PREDICATE,
  80   PROP_SELECTION_MODE
  81 };
  82
  83
  84 /* A GtkTreeModelFilterVisibleFunc to filter lines in the treeview */
  85 static gboolean
  86 filter_variables (GtkTreeModel *model, GtkTreeIter *iter, gpointer data)
  87 {
  88   var_predicate_func *predicate = data;
  89   struct variable *var;
  90   PsppireDict *dict = PSPPIRE_DICT (model);
  91
  92   GtkTreePath *path = gtk_tree_model_get_path (model, iter);
  93
  94   gint *idx = gtk_tree_path_get_indices (path);
  95
  96   var =  psppire_dict_get_variable (dict, *idx);
  97
  98   gtk_tree_path_free (path);
  99
 100   return predicate (var);
 101 }
 102
 103 static void
 104 set_model (PsppireDictView *dict_view)
 105 {
 106   GtkTreeModel *model ;
 107
 108   if ( dict_view->dict == NULL)
 109     return;
 110
 111    if ( dict_view->predicate )
 112     {
 113       model = gtk_tree_model_filter_new (GTK_TREE_MODEL (dict_view->dict),
 114                                          NULL);
 115
 116       gtk_tree_model_filter_set_visible_func (GTK_TREE_MODEL_FILTER (model),
 117                                               filter_variables,
 118                                               dict_view->predicate,
 119                                               NULL);
 120     }
 121   else
 122     {
 123       model = GTK_TREE_MODEL (dict_view->dict);
 124     }
 125
 126   gtk_tree_view_set_model (GTK_TREE_VIEW (dict_view), model);
 127 }
 128
 129 static void
 130 psppire_dict_view_set_property (GObject         *object,
 131                                guint            prop_id,
 132                                const GValue    *value,
 133                                GParamSpec      *pspec)
 134 {
 135   PsppireDictView *dict_view = PSPPIRE_DICT_VIEW (object);
 136
 137   switch (prop_id)
 138     {
 139     case PROP_DICTIONARY:
 140       dict_view->dict = g_value_get_object (value);
 141       break;
 142     case PROP_PREDICATE:
 143       dict_view->predicate = g_value_get_pointer (value);
 144       break;
 145     case PROP_SELECTION_MODE:
 146       {
 147         GtkTreeSelection *selection =
 148           gtk_tree_view_get_selection (GTK_TREE_VIEW (dict_view));
 149
 150         GtkSelectionMode mode = g_value_get_enum (value);
 151
 152         gtk_tree_selection_set_mode (selection, mode);
 153       }
 154       break;
 155     default:
 156       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 157       break;
 158     };
 159
 160
 161   set_model (dict_view);
 162 }
 163
 164
 165 static void
 166 psppire_dict_view_get_property (GObject         *object,
 167                                guint            prop_id,
 168                                GValue          *value,
 169                                GParamSpec      *pspec)
 170 {
 171   PsppireDictView *dict_view = PSPPIRE_DICT_VIEW (object);
 172
 173   switch (prop_id)
 174     {
 175     case PROP_DICTIONARY:
 176       g_value_set_object (value, dict_view->dict);
 177       break;
 178     case PROP_PREDICATE:
 179       g_value_set_pointer (value, dict_view->predicate);
 180       break;
 181     case PROP_SELECTION_MODE:
 182       {
 183         GtkTreeSelection *selection =
 184           gtk_tree_view_get_selection (GTK_TREE_VIEW (dict_view));
 185
 186         g_value_set_enum (value, gtk_tree_selection_get_mode (selection));
 187       }
 188     default:
 189       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 190       break;
 191     };
 192 }
 193
 194
 195
 196 static void
 197 psppire_dict_view_class_init (PsppireDictViewClass *class)
 198 {
 199   GObjectClass *object_class = G_OBJECT_CLASS (class);
 200
 201   GParamSpec *predicate_spec =
 202     g_param_spec_pointer ("predicate",
 203                           "Predicate",
 204                           "A predicate function",
 205                           G_PARAM_READABLE | G_PARAM_WRITABLE);
 206
 207
 208   GParamSpec *selection_mode_spec =
 209     g_param_spec_enum ("selection-mode",
 210                        "Selection Mode",
 211                        "How many things can be selected",
 212                        GTK_TYPE_SELECTION_MODE,
 213                        GTK_SELECTION_MULTIPLE,
 214                        G_PARAM_CONSTRUCT | G_PARAM_READABLE | G_PARAM_WRITABLE);
 215
 216   object_class->set_property = psppire_dict_view_set_property;
 217   object_class->get_property = psppire_dict_view_get_property;
 218
 219   g_object_class_override_property (object_class,
 220                                     PROP_DICTIONARY,
 221                                     "model");
 222
 223   g_object_class_install_property (object_class,
 224                                    PROP_PREDICATE,
 225                                    predicate_spec);
 226
 227   g_object_class_install_property (object_class,
 228                                    PROP_SELECTION_MODE,
 229                                    selection_mode_spec);
 230 }
 231
 232
 233 static void
 234 psppire_dict_view_base_init (PsppireDictViewClass *class)
 235 {
 236   GObjectClass *object_class = G_OBJECT_CLASS (class);
 237
 238   object_class->finalize = psppire_dict_view_finalize;
 239 }
 240
 241
 242
 243 static void
 244 psppire_dict_view_base_finalize (PsppireDictViewClass *class,
 245                                  gpointer class_data)
 246 {
 247
 248 }
 249
 250
 251 static void
 252 dv_get_base_model (GtkTreeModel *top_model, GtkTreeIter *top_iter,
 253                 GtkTreeModel **model, GtkTreeIter *iter)
 254 {
 255   *model = top_model;
 256
 257   if ( iter)
 258     *iter = *top_iter;
 259
 260   while ( ! PSPPIRE_IS_DICT (*model))
 261     {
 262       GtkTreeIter parent_iter;
 263       if (iter)
 264         parent_iter = *iter;
 265
 266       if ( GTK_IS_TREE_MODEL_FILTER (*model))
 267         {
 268           GtkTreeModelFilter *parent_model = GTK_TREE_MODEL_FILTER (*model);
 269
 270           *model = gtk_tree_model_filter_get_model (parent_model);
 271
 272           if (iter)
 273             gtk_tree_model_filter_convert_iter_to_child_iter (parent_model,
 274                                                               iter,
 275                                                               &parent_iter);
 276         }
 277       else if (GTK_IS_TREE_MODEL_SORT (*model))
 278         {
 279           GtkTreeModelSort *parent_model = GTK_TREE_MODEL_SORT (*model);
 280
 281           *model = gtk_tree_model_sort_get_model (parent_model);
 282
 283           if (iter)
 284             gtk_tree_model_sort_convert_iter_to_child_iter (parent_model,
 285                                                             iter,
 286                                                             &parent_iter);
 287         }
 288     }
 289 }
 290
 291
 292
 293 /* A GtkTreeCellDataFunc which renders the name and/or label of the
 294    variable */
 295 static void
 296 var_description_cell_data_func (GtkTreeViewColumn *col,
 297                                 GtkCellRenderer *cell,
 298                                 GtkTreeModel *top_model,
 299                                 GtkTreeIter *top_iter,
 300                                 gpointer data)
 301 {
 302   PsppireDictView *dv = PSPPIRE_DICT_VIEW (data);
 303   struct variable *var;
 304   GtkTreeIter iter;
 305   GtkTreeModel *model;
 306   PsppireDict *dict;
 307
 308   dv_get_base_model (top_model, top_iter, &model, &iter);
 309
 310   dict = PSPPIRE_DICT (model);
 311
 312   gtk_tree_model_get (model,
 313                       &iter, DICT_TVM_COL_VAR, &var, -1);
 314
 315   if ( var_has_label (var) && dv->prefer_labels)
 316     {
 317       gchar *text = g_markup_printf_escaped (
 318                                      "<span stretch=\"condensed\">%s</span>",
 319                                      var_get_label (var));
 320
 321       g_object_set (cell, "markup", text, NULL);
 322       g_free (text);
 323     }
 324   else
 325     {
 326       g_object_set (cell, "text", var_get_name (var), NULL);
 327     }
 328 }
 329
 330
 331
 332 /* A GtkTreeCellDataFunc which sets the icon appropriate to the type
 333    of variable */
 334 static void
 335 var_icon_cell_data_func (GtkTreeViewColumn *col,
 336                        GtkCellRenderer *cell,
 337                        GtkTreeModel *model,
 338                        GtkTreeIter *iter,
 339                        gpointer data)
 340 {
 341   struct variable *var;
 342   gtk_tree_model_get (model, iter, DICT_TVM_COL_VAR, &var, -1);
 343
 344   if ( var_is_alpha (var))
 345     {
 346       g_object_set (cell, "stock-id", "var-string", NULL);
 347     }
 348   else
 349     {
 350       const struct fmt_spec *fs = var_get_print_format (var);
 351       int cat = fmt_get_category (fs->type);
 352       switch ( var_get_measure (var))
 353         {
 354         case MEASURE_NOMINAL:
 355           g_object_set (cell, "stock-id", "var-nominal", NULL);
 356           break;
 357         case MEASURE_ORDINAL:
 358           g_object_set (cell, "stock-id", "var-ordinal", NULL);
 359           break;
 360         case MEASURE_SCALE:
 361           if ( ( FMT_CAT_DATE | FMT_CAT_TIME ) & cat )
 362             g_object_set (cell, "stock-id", "var-date-scale", NULL);
 363           else
 364             g_object_set (cell, "stock-id", "var-scale", NULL);
 365           break;
 366         default:
 367           g_assert_not_reached ();
 368         };
 369     }
 370 }
 371
 372
 373 /* Sets the tooltip to be the name of the variable under the cursor */
 374 static gboolean
 375 set_tooltip_for_variable (GtkTreeView  *treeview,
 376                           gint        x,
 377                           gint        y,
 378                           gboolean    keyboard_mode,
 379                           GtkTooltip *tooltip,
 380                           gpointer    user_data)
 381 {
 382   gint bx, by;
 383   GtkTreeIter iter;
 384   GtkTreePath *path;
 385   GtkTreeModel *tree_model;
 386   struct variable *var = NULL;
 387   gboolean ok;
 388
 389   gtk_tree_view_convert_widget_to_bin_window_coords (treeview,
 390                                                      x, y, &bx, &by);
 391
 392   if (!gtk_tree_view_get_path_at_pos (treeview, bx, by,
 393                                       &path, NULL, NULL, NULL))
 394     return FALSE;
 395
 396   tree_model = gtk_tree_view_get_model (treeview);
 397
 398   gtk_tree_view_set_tooltip_row (treeview, tooltip, path);
 399
 400   ok = gtk_tree_model_get_iter (tree_model, &iter, path);
 401
 402   gtk_tree_path_free (path);
 403   if (!ok)
 404     return FALSE;
 405
 406
 407   gtk_tree_model_get (tree_model, &iter, DICT_TVM_COL_VAR,  &var, -1);
 408
 409   if ( ! var_has_label (var))
 410     return FALSE;
 411
 412   {
 413     const gchar *tip ;
 414     GtkTreeModel *m;
 415     PsppireDict *dict;
 416
 417     dv_get_base_model (tree_model, NULL, &m, NULL);
 418     dict = PSPPIRE_DICT (m);
 419
 420     if ( PSPPIRE_DICT_VIEW (treeview)->prefer_labels )
 421       tip = var_get_name (var);
 422     else
 423       tip = var_get_label (var);
 424
 425     gtk_tooltip_set_text (tooltip, tip);
 426   }
 427
 428   return TRUE;
 429 }
 430
 431 static gboolean
 432 show_menu (PsppireDictView *dv, GdkEventButton *event, gpointer data)
 433 {
 434   if (event->button != 3)
 435     return FALSE;
 436
 437   gtk_menu_popup (GTK_MENU (dv->menu), NULL, NULL, NULL, NULL,
 438                   event->button, event->time);
 439
 440   return TRUE;
 441 }
 442
 443 static void
 444 toggle_label_preference (GtkCheckMenuItem *checkbox, gpointer data)
 445 {
 446   PsppireDictView *dv = PSPPIRE_DICT_VIEW (data);
 447
 448   dv->prefer_labels = gtk_check_menu_item_get_active (checkbox);
 449
 450   gtk_widget_queue_draw (GTK_WIDGET (dv));
 451 }
 452
 453
 454
 455 static void
 456 psppire_dict_view_init (PsppireDictView *dict_view)
 457 {
 458   GtkTreeViewColumn *col = gtk_tree_view_column_new ();
 459
 460   GtkCellRenderer *renderer = gtk_cell_renderer_pixbuf_new ();
 461
 462   dict_view->prefer_labels = TRUE;
 463
 464   psppire_conf_get_boolean (psppire_conf_new (),
 465                             G_OBJECT_TYPE_NAME (dict_view),
 466                             "prefer-labels",
 467                             &dict_view->prefer_labels);
 468
 469   gtk_tree_view_column_set_title (col, _("Variable"));
 470
 471   gtk_tree_view_column_pack_start (col, renderer, FALSE);
 472
 473   gtk_tree_view_column_set_cell_data_func (col, renderer,
 474                                            var_icon_cell_data_func,
 475                                            NULL, NULL);
 476
 477   renderer = gtk_cell_renderer_text_new ();
 478   gtk_tree_view_column_pack_start (col, renderer, TRUE);
 479   gtk_tree_view_column_set_cell_data_func (col, renderer,
 480                                            var_description_cell_data_func,
 481                                            dict_view, NULL);
 482
 483   g_object_set (renderer, "ellipsize-set", TRUE, NULL);
 484   g_object_set (renderer, "ellipsize", PANGO_ELLIPSIZE_MIDDLE, NULL);
 485
 486   gtk_tree_view_column_set_sizing (col, GTK_TREE_VIEW_COLUMN_FIXED);
 487
 488   /* FIXME: make this a value in terms of character widths */
 489   gtk_tree_view_column_set_min_width (col, 150);
 490
 491   gtk_tree_view_append_column (GTK_TREE_VIEW (dict_view), col);
 492
 493   g_object_set (dict_view,
 494                 "has-tooltip", TRUE,
 495                 "headers-visible", FALSE,
 496                 NULL);
 497
 498   g_signal_connect (dict_view, "query-tooltip",
 499                     G_CALLBACK (set_tooltip_for_variable), NULL);
 500
 501   dict_view->menu = gtk_menu_new ();
 502
 503
 504   {
 505     GtkWidget *checkbox =
 506       gtk_check_menu_item_new_with_label  (_("Prefer variable labels"));
 507
 508     gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (checkbox),
 509                                     dict_view->prefer_labels);
 510
 511     g_signal_connect (checkbox, "toggled",
 512                       G_CALLBACK (toggle_label_preference), dict_view);
 513
 514
 515     gtk_menu_shell_append (GTK_MENU_SHELL (dict_view->menu), checkbox);
 516
 517   }
 518
 519   gtk_widget_show_all (dict_view->menu);
 520
 521   g_signal_connect (dict_view, "button-press-event",
 522                     G_CALLBACK (show_menu), NULL);
 523 }
 524
 525
 526 GtkWidget*
 527 psppire_dict_view_new (void)
 528 {
 529   return GTK_WIDGET (g_object_new (psppire_dict_view_get_type (), NULL));
 530 }
 531
 532
 533
 534 struct variable *
 535 psppire_dict_view_get_selected_variable (PsppireDictView *treeview)
 536 {
 537   struct variable *var;
 538   GtkTreeModel *top_model;
 539   GtkTreeIter top_iter;
 540
 541   GtkTreeModel *model;
 542   GtkTreeIter iter;
 543
 544   GtkTreeSelection *selection =
 545     gtk_tree_view_get_selection (GTK_TREE_VIEW (treeview));
 546
 547   if (! gtk_tree_selection_get_selected (selection,
 548                                          &top_model, &top_iter))
 549     return NULL;
 550
 551   dv_get_base_model (top_model, &top_iter, &model, &iter);
 552
 553   g_assert (PSPPIRE_IS_DICT (model));
 554
 555   gtk_tree_model_get (model,
 556                       &iter, DICT_TVM_COL_VAR, &var, -1);
 557
 558   return var;
 559 }
 560
 561