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