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