src/ui/gui/psppire-dictview.c

   1 /* PSPPIRE - a graphical user interface for PSPP.
   2    Copyright (C) 2009  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/gtktreeview.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   g_object_unref (dict_view->menu);
  72 }
  73
  74 /* Properties */
  75 enum
  76 {
  77   PROP_0,
  78   PROP_MODEL,
  79   PROP_DICTIONARY,
  80   PROP_PREDICATE,
  81   PROP_SELECTION_MODE
  82 };
  83
  84
  85 /* A GtkTreeModelFilterVisibleFunc to filter lines in the treeview */
  86 static gboolean
  87 filter_variables (GtkTreeModel *model, GtkTreeIter *iter, gpointer data)
  88 {
  89   var_predicate_func *predicate = data;
  90   struct variable *var;
  91   PsppireDict *dict = PSPPIRE_DICT (model);
  92
  93   GtkTreePath *path = gtk_tree_model_get_path (model, iter);
  94
  95   gint *idx = gtk_tree_path_get_indices (path);
  96
  97   var =  psppire_dict_get_variable (dict, *idx);
  98
  99   gtk_tree_path_free (path);
 100
 101   return predicate (var);
 102 }
 103
 104 static void
 105 set_model (PsppireDictView *dict_view)
 106 {
 107   GtkTreeModel *model ;
 108
 109   if ( dict_view->predicate )
 110     {
 111       model = gtk_tree_model_filter_new (GTK_TREE_MODEL (dict_view->dict),
 112                                          NULL);
 113
 114       gtk_tree_model_filter_set_visible_func (GTK_TREE_MODEL_FILTER (model),
 115                                               filter_variables,
 116                                               dict_view->predicate,
 117                                               NULL);
 118     }
 119   else
 120     {
 121       model = GTK_TREE_MODEL (dict_view->dict);
 122     }
 123
 124   gtk_tree_view_set_model (GTK_TREE_VIEW (dict_view), model);
 125 }
 126
 127 static void
 128 psppire_dict_view_set_property (GObject         *object,
 129                                guint            prop_id,
 130                                const GValue    *value,
 131                                GParamSpec      *pspec)
 132 {
 133   PsppireDictView *dict_view = PSPPIRE_DICT_VIEW (object);
 134
 135   switch (prop_id)
 136     {
 137     case PROP_DICTIONARY:
 138       dict_view->dict = g_value_get_object (value);
 139       break;
 140     case PROP_MODEL:
 141       g_critical ("Don't set the \"model\" property on %s. "
 142                   "Use the \"dictionary\" property instead.",
 143                   G_OBJECT_TYPE_NAME (dict_view));
 144       break;
 145     case PROP_PREDICATE:
 146       dict_view->predicate = g_value_get_pointer (value);
 147       break;
 148     case PROP_SELECTION_MODE:
 149       {
 150         GtkTreeSelection *selection =
 151           gtk_tree_view_get_selection (GTK_TREE_VIEW (dict_view));
 152
 153         GtkSelectionMode mode = g_value_get_enum (value);
 154
 155         gtk_tree_selection_set_mode (selection, mode);
 156       }
 157       break;
 158     default:
 159       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 160       break;
 161     };
 162
 163
 164   set_model (dict_view);
 165 }
 166
 167
 168 static void
 169 psppire_dict_view_get_property (GObject         *object,
 170                                guint            prop_id,
 171                                GValue          *value,
 172                                GParamSpec      *pspec)
 173 {
 174   PsppireDictView *dict_view = PSPPIRE_DICT_VIEW (object);
 175
 176   switch (prop_id)
 177     {
 178     case PROP_DICTIONARY:
 179       g_value_set_object (value, dict_view->dict);
 180       break;
 181     case PROP_PREDICATE:
 182       g_value_set_pointer (value, dict_view->predicate);
 183       break;
 184     case PROP_SELECTION_MODE:
 185       {
 186         GtkTreeSelection *selection =
 187           gtk_tree_view_get_selection (GTK_TREE_VIEW (dict_view));
 188
 189         g_value_set_enum (value, gtk_tree_selection_get_mode (selection));
 190       }
 191     default:
 192       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 193       break;
 194     };
 195 }
 196
 197
 198
 199 static void
 200 psppire_dict_view_class_init (PsppireDictViewClass *class)
 201 {
 202   GObjectClass *object_class = G_OBJECT_CLASS (class);
 203
 204   GParamSpec *dictionary_spec =
 205     g_param_spec_object ("dictionary",
 206                          "Dictionary",
 207                          _("The dictionary to be displayed by this widget"),
 208                          PSPPIRE_TYPE_DICT,
 209                          G_PARAM_READABLE | G_PARAM_WRITABLE);
 210
 211   GParamSpec *predicate_spec =
 212     g_param_spec_pointer ("predicate",
 213                           "Predicate",
 214                           _("A predicate function"),
 215                           G_PARAM_READABLE | G_PARAM_WRITABLE);
 216
 217
 218   GParamSpec *selection_mode_spec =
 219     g_param_spec_enum ("selection-mode",
 220                        "Selection Mode",
 221                        _("How many things can be selected"),
 222                        GTK_TYPE_SELECTION_MODE,
 223                        GTK_SELECTION_MULTIPLE,
 224                        G_PARAM_CONSTRUCT | G_PARAM_READABLE | G_PARAM_WRITABLE);
 225
 226
 227   GParamSpec *dummy_spec =
 228     g_param_spec_pointer ("model",
 229                           "Model",
 230                           "Don't set the property",
 231                           G_PARAM_WRITABLE);
 232
 233   object_class->set_property = psppire_dict_view_set_property;
 234   object_class->get_property = psppire_dict_view_get_property;
 235
 236   g_object_class_install_property (object_class,
 237                                    PROP_MODEL,
 238                                    dummy_spec);
 239
 240   g_object_class_install_property (object_class,
 241                                    PROP_DICTIONARY,
 242                                    dictionary_spec);
 243
 244   g_object_class_install_property (object_class,
 245                                    PROP_PREDICATE,
 246                                    predicate_spec);
 247
 248   g_object_class_install_property (object_class,
 249                                    PROP_SELECTION_MODE,
 250                                    selection_mode_spec);
 251 }
 252
 253
 254 static void
 255 psppire_dict_view_base_init (PsppireDictViewClass *class)
 256 {
 257   GObjectClass *object_class = G_OBJECT_CLASS (class);
 258
 259   object_class->finalize = psppire_dict_view_finalize;
 260 }
 261
 262
 263
 264 static void
 265 psppire_dict_view_base_finalize (PsppireDictViewClass *class,
 266                                  gpointer class_data)
 267 {
 268
 269 }
 270
 271
 272 static void
 273 dv_get_base_model (GtkTreeModel *top_model, GtkTreeIter *top_iter,
 274                 GtkTreeModel **model, GtkTreeIter *iter
 275                 )
 276 {
 277   *model = top_model;
 278
 279   if ( iter)
 280     *iter = *top_iter;
 281
 282   while ( ! PSPPIRE_IS_DICT (*model))
 283     {
 284       GtkTreeIter parent_iter;
 285       if (iter)
 286         parent_iter = *iter;
 287
 288       if ( GTK_IS_TREE_MODEL_FILTER (*model))
 289         {
 290           GtkTreeModelFilter *parent_model = GTK_TREE_MODEL_FILTER (*model);
 291
 292           *model = gtk_tree_model_filter_get_model (parent_model);
 293
 294           if (iter)
 295             gtk_tree_model_filter_convert_iter_to_child_iter (parent_model,
 296                                                               iter,
 297                                                               &parent_iter);
 298         }
 299       else if (GTK_IS_TREE_MODEL_SORT (*model))
 300         {
 301           GtkTreeModelSort *parent_model = GTK_TREE_MODEL_SORT (*model);
 302
 303           *model = gtk_tree_model_sort_get_model (parent_model);
 304
 305           if (iter)
 306             gtk_tree_model_sort_convert_iter_to_child_iter (parent_model,
 307                                                             iter,
 308                                                             &parent_iter);
 309         }
 310     }
 311 }
 312
 313
 314
 315 /* A GtkTreeCellDataFunc which renders the name and/or label of the
 316    variable */
 317 static void
 318 var_description_cell_data_func (GtkTreeViewColumn *col,
 319                                 GtkCellRenderer *cell,
 320                                 GtkTreeModel *top_model,
 321                                 GtkTreeIter *top_iter,
 322                                 gpointer data)
 323 {
 324   PsppireDictView *dv = PSPPIRE_DICT_VIEW (data);
 325   struct variable *var;
 326   GtkTreeIter iter;
 327   GtkTreeModel *model;
 328   PsppireDict *dict;
 329
 330   dv_get_base_model (top_model, top_iter, &model, &iter);
 331
 332   dict = PSPPIRE_DICT (model);
 333
 334   gtk_tree_model_get (model,
 335                       &iter, DICT_TVM_COL_VAR, &var, -1);
 336
 337   if ( var_has_label (var) && dv->prefer_labels)
 338     {
 339       gchar *text = g_strdup_printf (
 340                                      "<span stretch=\"condensed\">%s</span>",
 341                                      var_get_label (var));
 342
 343       char *utf8 = recode_string (UTF8, psppire_dict_encoding (dict),
 344                                   text, -1);
 345
 346       g_free (text);
 347       g_object_set (cell, "markup", utf8, NULL);
 348       g_free (utf8);
 349     }
 350   else
 351     {
 352       char *name = recode_string (UTF8, psppire_dict_encoding (dict),
 353                                   var_get_name (var), -1);
 354       g_object_set (cell, "text", name, NULL);
 355       g_free (name);
 356     }
 357 }
 358
 359
 360
 361 /* A GtkTreeCellDataFunc which sets the icon appropriate to the type
 362    of variable */
 363 static void
 364 var_icon_cell_data_func (GtkTreeViewColumn *col,
 365                        GtkCellRenderer *cell,
 366                        GtkTreeModel *model,
 367                        GtkTreeIter *iter,
 368                        gpointer data)
 369 {
 370   struct variable *var;
 371   gtk_tree_model_get (model, iter, DICT_TVM_COL_VAR, &var, -1);
 372
 373   if ( var_is_alpha (var))
 374     {
 375       g_object_set (cell, "stock-id", "var-string", NULL);
 376     }
 377   else
 378     {
 379       const struct fmt_spec *fs = var_get_write_format (var);
 380       int cat = fmt_get_category (fs->type);
 381       switch ( var_get_measure (var))
 382         {
 383         case MEASURE_NOMINAL:
 384           g_object_set (cell, "stock-id", "var-nominal", NULL);
 385           break;
 386         case MEASURE_ORDINAL:
 387           g_object_set (cell, "stock-id", "var-ordinal", NULL);
 388           break;
 389         case MEASURE_SCALE:
 390           if ( ( FMT_CAT_DATE | FMT_CAT_TIME ) & cat )
 391             g_object_set (cell, "stock-id", "var-date-scale", NULL);
 392           else
 393             g_object_set (cell, "stock-id", "var-scale", NULL);
 394           break;
 395         default:
 396           g_assert_not_reached ();
 397         };
 398     }
 399 }
 400
 401
 402 /* Sets the tooltip to be the name of the variable under the cursor */
 403 static gboolean
 404 set_tooltip_for_variable (GtkTreeView  *treeview,
 405                           gint        x,
 406                           gint        y,
 407                           gboolean    keyboard_mode,
 408                           GtkTooltip *tooltip,
 409                           gpointer    user_data)
 410 {
 411   gint bx, by;
 412   GtkTreeIter iter;
 413   GtkTreePath *path;
 414   GtkTreeModel *tree_model;
 415   struct variable *var = NULL;
 416   gboolean ok;
 417
 418   gtk_tree_view_convert_widget_to_bin_window_coords (treeview,
 419                                                      x, y, &bx, &by);
 420
 421   if (!gtk_tree_view_get_path_at_pos (treeview, bx, by,
 422                                       &path, NULL, NULL, NULL))
 423     return FALSE;
 424
 425   tree_model = gtk_tree_view_get_model (treeview);
 426
 427   gtk_tree_view_set_tooltip_row (treeview, tooltip, path);
 428
 429   ok = gtk_tree_model_get_iter (tree_model, &iter, path);
 430
 431   gtk_tree_path_free (path);
 432   if (!ok)
 433     return FALSE;
 434
 435
 436   gtk_tree_model_get (tree_model, &iter, DICT_TVM_COL_VAR,  &var, -1);
 437
 438   if ( ! var_has_label (var))
 439     return FALSE;
 440
 441   {
 442     gchar *tip ;
 443     GtkTreeModel *m;
 444     PsppireDict *dict;
 445
 446     dv_get_base_model (tree_model, NULL, &m, NULL);
 447     dict = PSPPIRE_DICT (m);
 448
 449     if ( PSPPIRE_DICT_VIEW (treeview)->prefer_labels )
 450       tip = recode_string (UTF8, psppire_dict_encoding (dict),
 451                            var_get_name (var), -1);
 452     else
 453       tip = recode_string (UTF8, psppire_dict_encoding (dict),
 454                            var_get_label (var), -1);
 455
 456     gtk_tooltip_set_text (tooltip, tip);
 457
 458     g_free (tip);
 459   }
 460
 461   return TRUE;
 462 }
 463
 464 static gboolean
 465 show_menu (PsppireDictView *dv, GdkEventButton *event, gpointer data)
 466 {
 467   if (event->button != 3)
 468     return FALSE;
 469
 470   gtk_menu_popup (GTK_MENU (dv->menu), NULL, NULL, NULL, NULL,
 471                   event->button, event->time);
 472
 473   return TRUE;
 474 }
 475
 476 static void
 477 toggle_label_preference (GtkCheckMenuItem *checkbox, gpointer data)
 478 {
 479   PsppireDictView *dv = PSPPIRE_DICT_VIEW (data);
 480
 481   dv->prefer_labels = gtk_check_menu_item_get_active (checkbox);
 482
 483   gtk_widget_queue_draw (GTK_WIDGET (dv));
 484 }
 485
 486
 487
 488 static void
 489 psppire_dict_view_init (PsppireDictView *dict_view)
 490 {
 491   GtkTreeViewColumn *col = gtk_tree_view_column_new ();
 492
 493   GtkCellRenderer *renderer = gtk_cell_renderer_pixbuf_new ();
 494
 495   dict_view->prefer_labels = TRUE;
 496
 497   psppire_conf_get_boolean (psppire_conf_new (),
 498                             G_OBJECT_TYPE_NAME (dict_view),
 499                             "prefer-labels",
 500                             &dict_view->prefer_labels);
 501
 502   gtk_tree_view_column_set_title (col, _("Variable"));
 503
 504   gtk_tree_view_column_pack_start (col, renderer, FALSE);
 505
 506   gtk_tree_view_column_set_cell_data_func (col, renderer,
 507                                            var_icon_cell_data_func,
 508                                            NULL, NULL);
 509
 510   renderer = gtk_cell_renderer_text_new ();
 511   gtk_tree_view_column_pack_start (col, renderer, TRUE);
 512   gtk_tree_view_column_set_cell_data_func (col, renderer,
 513                                            var_description_cell_data_func,
 514                                            dict_view, NULL);
 515
 516   g_object_set (renderer, "ellipsize-set", TRUE, NULL);
 517   g_object_set (renderer, "ellipsize", PANGO_ELLIPSIZE_MIDDLE, NULL);
 518
 519   gtk_tree_view_column_set_sizing (col, GTK_TREE_VIEW_COLUMN_FIXED);
 520
 521   /* FIXME: make this a value in terms of character widths */
 522   gtk_tree_view_column_set_min_width (col, 150);
 523
 524   gtk_tree_view_append_column (GTK_TREE_VIEW (dict_view), col);
 525
 526   g_object_set (dict_view,
 527                 "has-tooltip", TRUE,
 528                 "headers-visible", FALSE,
 529                 NULL);
 530
 531   g_signal_connect (dict_view, "query-tooltip",
 532                     G_CALLBACK (set_tooltip_for_variable), NULL);
 533
 534   dict_view->menu = gtk_menu_new ();
 535
 536
 537   {
 538     GtkWidget *checkbox =
 539       gtk_check_menu_item_new_with_label  (_("Prefer variable labels"));
 540
 541     gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (checkbox),
 542                                     dict_view->prefer_labels);
 543
 544     g_signal_connect (checkbox, "toggled",
 545                       G_CALLBACK (toggle_label_preference), dict_view);
 546
 547
 548     gtk_menu_shell_append (GTK_MENU_SHELL (dict_view->menu), checkbox);
 549
 550   }
 551
 552   gtk_widget_show_all (dict_view->menu);
 553
 554   g_signal_connect (dict_view, "button-press-event",
 555                     G_CALLBACK (show_menu), NULL);
 556 }
 557
 558
 559 GtkWidget*
 560 psppire_dict_view_new (void)
 561 {
 562   return GTK_WIDGET (g_object_new (psppire_dict_view_get_type (), NULL));
 563 }
 564
 565
 566
 567 struct variable *
 568 psppire_dict_view_get_selected_variable (PsppireDictView *treeview)
 569 {
 570   struct variable *var;
 571   GtkTreeModel *top_model;
 572   GtkTreeIter top_iter;
 573
 574   GtkTreeModel *model;
 575   GtkTreeIter iter;
 576
 577   GtkTreeSelection *selection =
 578     gtk_tree_view_get_selection (GTK_TREE_VIEW (treeview));
 579
 580   if (! gtk_tree_selection_get_selected (selection,
 581                                          &top_model, &top_iter))
 582     return NULL;
 583
 584   dv_get_base_model (top_model, &top_iter, &model, &iter);
 585
 586   g_assert (PSPPIRE_IS_DICT (model));
 587
 588   gtk_tree_model_get (model,
 589                       &iter, DICT_TVM_COL_VAR, &var, -1);
 590
 591   return var;
 592 }
 593
 594