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