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