src/ui/gui/val-labs-dialog.c

   1 /* PSPPIRE - a graphical user interface for PSPP.
   2    Copyright (C) 2005, 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
  18 /*  This module describes the behaviour of the Value Labels dialog box,
  19     used for input of the value labels in the variable sheet */
  20
  21 #include <config.h>
  22
  23 #include <string.h>
  24
  25 #include "helper.h"
  26 #include "val-labs-dialog.h"
  27 #include <data/value-labels.h>
  28 #include <data/format.h>
  29 #include "psppire-var-sheet.h"
  30 #include "psppire-var-store.h"
  31 #include <libpspp/i18n.h>
  32
  33 #include <gettext.h>
  34 #define _(msgid) gettext (msgid)
  35 #define N_(msgid) msgid
  36
  37 struct val_labs_dialog
  38 {
  39   GtkWidget *window;
  40
  41   PsppireVarStore *var_store;
  42   PsppireDict *dict;
  43
  44   /* The variable to be updated */
  45   struct variable *pv;
  46
  47   /* Local copy of labels */
  48   struct val_labs *labs;
  49
  50   /* Actions */
  51   GtkWidget *add_button;
  52   GtkWidget *remove_button;
  53   GtkWidget *change_button;
  54
  55   /* Entry Boxes */
  56   GtkWidget *value_entry;
  57   GtkWidget *label_entry;
  58
  59   /* Signal handler ids */
  60   gint change_handler_id;
  61   gint value_handler_id;
  62
  63   GtkWidget *treeview;
  64 };
  65
  66
  67 /* This callback occurs when the text in the label entry box
  68    is changed */
  69 static void
  70 on_label_entry_change (GtkEntry *entry, gpointer data)
  71 {
  72   union value v;
  73   const gchar *text ;
  74   struct val_labs_dialog *dialog = data;
  75   g_assert (dialog->labs);
  76
  77   text = gtk_entry_get_text (GTK_ENTRY (dialog->value_entry));
  78
  79   text_to_value (text,
  80                  dialog->dict,
  81                  dialog->pv,
  82                  &v);
  83
  84   if (val_labs_find (dialog->labs, &v))
  85     {
  86       gtk_widget_set_sensitive (dialog->change_button, TRUE);
  87       gtk_widget_set_sensitive (dialog->add_button, FALSE);
  88     }
  89   else
  90     {
  91       gtk_widget_set_sensitive (dialog->change_button, FALSE);
  92       gtk_widget_set_sensitive (dialog->add_button, TRUE);
  93     }
  94
  95   value_destroy (&v, var_get_width (dialog->pv));
  96 }
  97
  98
  99 /* Set the TREEVIEW list cursor to the item which has the value VAL */
 100 static void
 101 select_treeview_from_value (GtkTreeView *treeview, union value *val)
 102 {
 103   GtkTreePath *path ;
 104
 105   /*
 106     We do this with a linear search through the model --- hardly
 107     efficient, but the list is short ... */
 108   GtkTreeIter iter;
 109
 110   GtkTreeModel * model  = gtk_tree_view_get_model (treeview);
 111
 112   gboolean success;
 113   for (success = gtk_tree_model_get_iter_first (model, &iter);
 114        success;
 115        success = gtk_tree_model_iter_next (model, &iter))
 116     {
 117       union value v;
 118       GValue gvalue = {0};
 119
 120       gtk_tree_model_get_value (model, &iter, 1, &gvalue);
 121
 122       v.f = g_value_get_double (&gvalue);
 123
 124       if ( 0 == memcmp (&v, val, sizeof (union value)))
 125         {
 126           break;
 127         }
 128     }
 129
 130   path = gtk_tree_model_get_path (model, &iter);
 131   if ( path )
 132     {
 133       gtk_tree_view_set_cursor (treeview, path, 0, 0);
 134       gtk_tree_path_free (path);
 135     }
 136
 137 }
 138
 139
 140 /* This callback occurs when the text in the value entry box is
 141    changed */
 142 static void
 143 on_value_entry_change (GtkEntry *entry, gpointer data)
 144 {
 145   const char *s;
 146
 147   struct val_labs_dialog *dialog = data;
 148
 149   const gchar *text = gtk_entry_get_text (GTK_ENTRY (dialog->value_entry));
 150
 151   union value v;
 152   text_to_value (text,
 153                  dialog->dict,
 154                  dialog->pv,
 155                  &v);
 156
 157
 158   g_signal_handler_block (GTK_ENTRY (dialog->label_entry),
 159                          dialog->change_handler_id);
 160
 161   gtk_entry_set_text (GTK_ENTRY (dialog->label_entry),"");
 162
 163
 164   if ( (s = val_labs_find (dialog->labs, &v)) )
 165     {
 166       gtk_entry_set_text (GTK_ENTRY (dialog->label_entry), s);
 167       gtk_widget_set_sensitive (dialog->add_button, FALSE);
 168       gtk_widget_set_sensitive (dialog->remove_button, TRUE);
 169       select_treeview_from_value (GTK_TREE_VIEW (dialog->treeview), &v);
 170     }
 171   else
 172     {
 173       gtk_widget_set_sensitive (dialog->remove_button, FALSE);
 174       gtk_widget_set_sensitive (dialog->add_button, TRUE);
 175     }
 176
 177   g_signal_handler_unblock (GTK_ENTRY (dialog->label_entry),
 178                          dialog->change_handler_id);
 179
 180   value_destroy (&v, var_get_width (dialog->pv));
 181 }
 182
 183
 184 /* Callback for when the Value Labels dialog is closed using
 185    the OK button.*/
 186 static gint
 187 val_labs_ok (GtkWidget *w, gpointer data)
 188 {
 189   struct val_labs_dialog *dialog = data;
 190
 191   var_set_value_labels (dialog->pv, dialog->labs);
 192
 193   val_labs_destroy (dialog->labs);
 194
 195   dialog->labs = NULL;
 196
 197   gtk_widget_hide (dialog->window);
 198
 199   return FALSE;
 200 }
 201
 202 /* Callback for when the Value Labels dialog is closed using
 203    the Cancel button.*/
 204 static void
 205 val_labs_cancel (struct val_labs_dialog *dialog)
 206 {
 207   val_labs_destroy (dialog->labs);
 208
 209   dialog->labs = NULL;
 210
 211   gtk_widget_hide (dialog->window);
 212 }
 213
 214
 215 /* Callback for when the Value Labels dialog is closed using
 216    the Cancel button.*/
 217 static void
 218 on_cancel (GtkWidget *w, gpointer data)
 219 {
 220   struct val_labs_dialog *dialog = data;
 221
 222   val_labs_cancel (dialog);
 223 }
 224
 225
 226 /* Callback for when the Value Labels dialog is closed using
 227    the window delete button.*/
 228 static gint
 229 on_delete (GtkWidget *w, GdkEvent *e, gpointer data)
 230 {
 231   struct val_labs_dialog *dialog = data;
 232
 233   val_labs_cancel (dialog);
 234
 235   return TRUE;
 236 }
 237
 238
 239 /* Return the value-label pair currently selected in the dialog box  */
 240 static void
 241 get_selected_tuple (struct val_labs_dialog *dialog,
 242                     union value *valuep, const char **label)
 243 {
 244   GtkTreeView *treeview = GTK_TREE_VIEW (dialog->treeview);
 245
 246   GtkTreeIter iter ;
 247   GValue the_value = {0};
 248   union value value;
 249
 250   GtkTreeSelection* sel =  gtk_tree_view_get_selection (treeview);
 251
 252   GtkTreeModel * model  = gtk_tree_view_get_model (treeview);
 253
 254   gtk_tree_selection_get_selected (sel, &model, &iter);
 255
 256   gtk_tree_model_get_value (model, &iter, 1, &the_value);
 257
 258   value.f = g_value_get_double (&the_value);
 259   g_value_unset (&the_value);
 260
 261   if (valuep != NULL)
 262     *valuep = value;
 263   if (label != NULL)
 264     {
 265       struct val_lab *vl = val_labs_lookup (dialog->labs, &value);
 266       if (vl != NULL)
 267         *label = val_lab_get_escaped_label (vl);
 268     }
 269 }
 270
 271
 272 static void repopulate_dialog (struct val_labs_dialog *dialog);
 273
 274 /* Callback which occurs when the "Change" button is clicked */
 275 static void
 276 on_change (GtkWidget *w, gpointer data)
 277 {
 278   struct val_labs_dialog *dialog = data;
 279
 280   const gchar *val_text = gtk_entry_get_text (GTK_ENTRY (dialog->value_entry));
 281
 282   union value v;
 283
 284   text_to_value (val_text,
 285                  dialog->dict,
 286                  dialog->pv,
 287                  &v);
 288
 289   val_labs_replace (dialog->labs, &v,
 290                     gtk_entry_get_text (GTK_ENTRY (dialog->label_entry)));
 291
 292   gtk_widget_set_sensitive (dialog->change_button, FALSE);
 293
 294   repopulate_dialog (dialog);
 295   gtk_widget_grab_focus (dialog->value_entry);
 296
 297   value_destroy (&v, var_get_width (dialog->pv));
 298 }
 299
 300 /* Callback which occurs when the "Add" button is clicked */
 301 static void
 302 on_add (GtkWidget *w, gpointer data)
 303 {
 304   struct val_labs_dialog *dialog = data;
 305
 306   union value v;
 307
 308   const gchar *text = gtk_entry_get_text (GTK_ENTRY (dialog->value_entry));
 309
 310   text_to_value (text,
 311                  dialog->dict,
 312                  dialog->pv,
 313                  &v);
 314
 315   if (val_labs_add (dialog->labs, &v,
 316                     gtk_entry_get_text
 317                     ( GTK_ENTRY (dialog->label_entry)) ) )
 318     {
 319       gtk_widget_set_sensitive (dialog->add_button, FALSE);
 320
 321       repopulate_dialog (dialog);
 322       gtk_widget_grab_focus (dialog->value_entry);
 323     }
 324
 325   value_destroy (&v, var_get_width (dialog->pv));
 326 }
 327
 328 /* Callback which occurs when the "Remove" button is clicked */
 329 static void
 330 on_remove (GtkWidget *w, gpointer data)
 331 {
 332   struct val_labs_dialog *dialog = data;
 333
 334   union value value;
 335   struct val_lab *vl;
 336
 337   get_selected_tuple (dialog, &value, NULL);
 338   vl = val_labs_lookup (dialog->labs, &value);
 339   if (vl != NULL)
 340     val_labs_remove (dialog->labs, vl);
 341
 342   repopulate_dialog (dialog);
 343   gtk_widget_grab_focus (dialog->value_entry);
 344
 345   gtk_widget_set_sensitive (dialog->remove_button, FALSE);
 346 }
 347
 348
 349
 350 /* Callback which occurs when a line item is selected in the list of
 351    value--label pairs.*/
 352 static void
 353 on_select_row (GtkTreeView *treeview, gpointer data)
 354 {
 355   struct val_labs_dialog *dialog = data;
 356
 357   union value value;
 358   const char *label = NULL;
 359
 360   gchar *text;
 361
 362   get_selected_tuple (dialog, &value, &label);
 363   text = value_to_text (value, dialog->dict, *var_get_write_format (dialog->pv));
 364
 365   g_signal_handler_block (GTK_ENTRY (dialog->value_entry),
 366                          dialog->value_handler_id);
 367
 368   gtk_entry_set_text (GTK_ENTRY (dialog->value_entry), text);
 369
 370   g_signal_handler_unblock (GTK_ENTRY (dialog->value_entry),
 371                          dialog->value_handler_id);
 372   g_free (text);
 373
 374   g_signal_handler_block (GTK_ENTRY (dialog->label_entry),
 375                          dialog->change_handler_id);
 376
 377
 378   gtk_entry_set_text (GTK_ENTRY (dialog->label_entry),
 379                       label);
 380
 381   g_signal_handler_unblock (GTK_ENTRY (dialog->label_entry),
 382                          dialog->change_handler_id);
 383
 384   gtk_widget_set_sensitive (dialog->remove_button, TRUE);
 385   gtk_widget_set_sensitive (dialog->change_button, FALSE);
 386 }
 387
 388
 389 /* Create a new dialog box
 390    (there should  normally be only one)*/
 391 struct val_labs_dialog *
 392 val_labs_dialog_create (GtkWindow *toplevel, PsppireVarStore *var_store)
 393 {
 394   GtkTreeViewColumn *column;
 395
 396   GtkCellRenderer *renderer ;
 397
 398   GtkBuilder *xml = builder_new ("var-sheet-dialogs.ui");
 399
 400   struct val_labs_dialog *dialog = g_malloc (sizeof (*dialog));
 401
 402   dialog->var_store = var_store;
 403   g_object_get (var_store, "dictionary", &dialog->dict, NULL);
 404   dialog->window = get_widget_assert (xml,"val_labs_dialog");
 405   dialog->value_entry = get_widget_assert (xml,"value_entry");
 406   dialog->label_entry = get_widget_assert (xml,"label_entry");
 407
 408   gtk_window_set_transient_for
 409     (GTK_WINDOW (dialog->window), toplevel);
 410
 411   dialog->add_button = get_widget_assert (xml, "val_labs_add");
 412   dialog->remove_button = get_widget_assert (xml, "val_labs_remove");
 413   dialog->change_button = get_widget_assert (xml, "val_labs_change");
 414
 415   dialog->treeview = get_widget_assert (xml,"treeview1");
 416
 417   gtk_tree_view_set_headers_visible (GTK_TREE_VIEW (dialog->treeview), FALSE);
 418
 419   renderer = gtk_cell_renderer_text_new ();
 420
 421   column = gtk_tree_view_column_new_with_attributes ("Title",
 422                                                      renderer,
 423                                                      "text",
 424                                                      0,
 425                                                      NULL);
 426
 427   gtk_tree_view_append_column (GTK_TREE_VIEW (dialog->treeview), column);
 428
 429   g_signal_connect (get_widget_assert (xml, "val_labs_cancel"),
 430                    "clicked",
 431                    G_CALLBACK (on_cancel), dialog);
 432
 433   g_signal_connect (dialog->window, "delete-event",
 434                     G_CALLBACK (on_delete), dialog);
 435
 436   g_signal_connect (get_widget_assert (xml, "val_labs_ok"),
 437                    "clicked",
 438                    G_CALLBACK (val_labs_ok), dialog);
 439
 440   dialog->change_handler_id =
 441     g_signal_connect (dialog->label_entry,
 442                      "changed",
 443                      G_CALLBACK (on_label_entry_change), dialog);
 444
 445   dialog->value_handler_id  =
 446     g_signal_connect (dialog->value_entry,
 447                      "changed",
 448                      G_CALLBACK (on_value_entry_change), dialog);
 449
 450   g_signal_connect (dialog->change_button,
 451                    "clicked",
 452                    G_CALLBACK (on_change), dialog);
 453
 454
 455   g_signal_connect (dialog->treeview, "cursor-changed",
 456                    G_CALLBACK (on_select_row), dialog);
 457
 458   g_signal_connect (dialog->remove_button, "clicked",
 459                    G_CALLBACK (on_remove), dialog);
 460
 461   g_signal_connect (dialog->add_button, "clicked",
 462                    G_CALLBACK (on_add), dialog);
 463
 464   dialog->labs = NULL;
 465
 466   g_object_unref (xml);
 467
 468   return dialog;
 469 }
 470
 471
 472 void
 473 val_labs_dialog_set_target_variable (struct val_labs_dialog *dialog,
 474                                      struct variable *var)
 475 {
 476   dialog->pv = var;
 477 }
 478
 479
 480
 481 /* Populate the components of the dialog box, from the 'labs' member
 482    variable */
 483 static void
 484 repopulate_dialog (struct val_labs_dialog *dialog)
 485 {
 486   const struct val_lab **labels;
 487   size_t n_labels;
 488   size_t i;
 489
 490   GtkTreeIter iter;
 491
 492   GtkListStore *list_store = gtk_list_store_new (2,
 493                                                  G_TYPE_STRING,
 494                                                  G_TYPE_DOUBLE);
 495
 496   g_signal_handler_block (GTK_ENTRY (dialog->label_entry),
 497                          dialog->change_handler_id);
 498   g_signal_handler_block (GTK_ENTRY (dialog->value_entry),
 499                          dialog->value_handler_id);
 500
 501   gtk_entry_set_text (GTK_ENTRY (dialog->value_entry), "");
 502   gtk_entry_set_text (GTK_ENTRY (dialog->label_entry), "");
 503
 504   g_signal_handler_unblock (GTK_ENTRY (dialog->value_entry),
 505                          dialog->value_handler_id);
 506   g_signal_handler_unblock (GTK_ENTRY (dialog->label_entry),
 507                            dialog->change_handler_id);
 508
 509   labels = val_labs_sorted (dialog->labs);
 510   n_labels = val_labs_count (dialog->labs);
 511   for (i = 0; i < n_labels; i++)
 512     {
 513       const struct val_lab *vl = labels[i];
 514
 515       gchar *const vstr  =
 516         value_to_text (vl->value, dialog->dict,
 517                       *var_get_write_format (dialog->pv));
 518
 519       gchar *const text = g_strdup_printf (_("%s = `%s'"), vstr,
 520                                            val_lab_get_escaped_label (vl));
 521
 522       gtk_list_store_append (list_store, &iter);
 523       gtk_list_store_set (list_store, &iter,
 524                           0, text,
 525                           1, vl->value.f,
 526                           -1);
 527
 528       g_free (text);
 529       g_free (vstr);
 530     }
 531   free (labels);
 532
 533   gtk_tree_view_set_model (GTK_TREE_VIEW (dialog->treeview),
 534                           GTK_TREE_MODEL (list_store));
 535
 536   g_object_unref (list_store);
 537
 538 }
 539
 540 /* Initialise and display the dialog box */
 541 void
 542 val_labs_dialog_show (struct val_labs_dialog *dialog)
 543 {
 544   const struct val_labs *value_labels;
 545
 546   g_assert (!dialog->labs);
 547
 548   value_labels = var_get_value_labels (dialog->pv);
 549
 550   if (value_labels)
 551     dialog->labs = val_labs_clone ( value_labels );
 552   else
 553     dialog->labs = val_labs_create ( var_get_width (dialog->pv));
 554
 555   gtk_widget_set_sensitive (dialog->remove_button, FALSE);
 556   gtk_widget_set_sensitive (dialog->change_button, FALSE);
 557   gtk_widget_set_sensitive (dialog->add_button, FALSE);
 558
 559   gtk_widget_grab_focus (dialog->value_entry);
 560
 561   repopulate_dialog (dialog);
 562   gtk_widget_show (dialog->window);
 563 }
 564