pintos-os.org Git - pspp/blob - src/ui/gui/psppire-value-entry.c

   1 /* PSPPIRE - a graphical user interface for PSPP.
   2    Copyright (C) 2012 Free Software Foundation, Inc.
   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 #include "psppire-value-entry.h"
  19 #include "data/data-in.h"
  20 #include "data/value-labels.h"
  21 #include "data/variable.h"
  22 #include "libpspp/cast.h"
  23 #include "libpspp/i18n.h"
  24 #include "ui/gui/helper.h"
  25 #include "ui/gui/psppire-format.h"
  26
  27 static void psppire_value_entry_finalize (GObject *);
  28
  29 G_DEFINE_TYPE (PsppireValueEntry,
  30                psppire_value_entry,
  31                GTK_TYPE_COMBO_BOX_ENTRY);
  32
  33 enum
  34   {
  35     COL_LABEL,                  /* Value label string. */
  36     COL_VALUE,                  /* union value *. */
  37     N_COLUMNS
  38   };
  39
  40 enum
  41   {
  42     PROP_0,
  43     PROP_SHOW_VALUE_LABEL,
  44     PROP_VARIABLE,
  45     PROP_VALUE_LABELS,
  46     PROP_FORMAT,
  47     PROP_ENCODING,
  48     PROP_WIDTH
  49   };
  50
  51 static void
  52 psppire_value_entry_set_property (GObject      *object,
  53                                   guint         prop_id,
  54                                   const GValue *value,
  55                                   GParamSpec   *pspec)
  56 {
  57   PsppireValueEntry *obj = PSPPIRE_VALUE_ENTRY (object);
  58
  59   switch (prop_id)
  60     {
  61     case PROP_SHOW_VALUE_LABEL:
  62       psppire_value_entry_set_show_value_label (obj,
  63                                                 g_value_get_boolean (value));
  64       break;
  65
  66     case PROP_VARIABLE:
  67       psppire_value_entry_set_variable (obj, g_value_get_pointer (value));
  68       break;
  69
  70     case PROP_VALUE_LABELS:
  71       psppire_value_entry_set_value_labels (obj, g_value_get_pointer (value));
  72       break;
  73
  74     case PROP_FORMAT:
  75       psppire_value_entry_set_format (obj, g_value_get_boxed (value));
  76       break;
  77
  78     case PROP_ENCODING:
  79       psppire_value_entry_set_encoding (obj, g_value_get_string (value));
  80       break;
  81
  82     case PROP_WIDTH:
  83       psppire_value_entry_set_width (obj, g_value_get_int (value));
  84       break;
  85
  86     default:
  87       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
  88       break;
  89     }
  90 }
  91
  92 static void
  93 psppire_value_entry_get_property (GObject      *object,
  94                                   guint         prop_id,
  95                                   GValue       *value,
  96                                   GParamSpec   *pspec)
  97 {
  98   PsppireValueEntry *obj = PSPPIRE_VALUE_ENTRY (object);
  99
 100   switch (prop_id)
 101     {
 102     case PROP_SHOW_VALUE_LABEL:
 103       g_value_set_boolean (value,
 104                            psppire_value_entry_get_show_value_label (obj));
 105       break;
 106
 107     case PROP_VARIABLE:
 108       g_return_if_reached ();
 109
 110     case PROP_VALUE_LABELS:
 111       g_value_set_pointer (value, obj->val_labs);
 112       break;
 113
 114     case PROP_FORMAT:
 115       g_value_set_boxed (value, &obj->format);
 116       break;
 117
 118     case PROP_ENCODING:
 119       g_value_set_string (value, psppire_value_entry_get_encoding (obj));
 120       break;
 121
 122     case PROP_WIDTH:
 123       g_value_set_int (value, psppire_value_entry_get_width (obj));
 124       break;
 125
 126     default:
 127       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 128       break;
 129     }
 130 }
 131
 132 static void
 133 psppire_value_entry_class_init (PsppireValueEntryClass *class)
 134 {
 135   GObjectClass *gobject_class;
 136   gobject_class = G_OBJECT_CLASS (class);
 137
 138   gobject_class->finalize = psppire_value_entry_finalize;
 139   gobject_class->set_property = psppire_value_entry_set_property;
 140   gobject_class->get_property = psppire_value_entry_get_property;
 141
 142   g_object_class_install_property (
 143     gobject_class, PROP_SHOW_VALUE_LABEL,
 144     g_param_spec_boolean ("show-value-label",
 145                           "Show Value Label",
 146                           "If true, a value that has a value label is shown "
 147                           "as the label.  If false, all values are shown "
 148                           "literally.",
 149                           TRUE,
 150                           G_PARAM_WRITABLE | G_PARAM_READABLE));
 151
 152   g_object_class_install_property (
 153     gobject_class, PROP_VARIABLE,
 154     g_param_spec_pointer ("variable",
 155                           "Variable",
 156                           "Set to configure the PsppireValueEntry according "
 157                           "to the specified variable's value labels, format, "
 158                           "width, and encoding.",
 159                           G_PARAM_WRITABLE));
 160
 161   g_object_class_install_property (
 162     gobject_class, PROP_VALUE_LABELS,
 163     g_param_spec_pointer ("value-labels",
 164                           "Value Labels",
 165                           "The set of value labels from which the user may "
 166                           "choose and which is used to display the value (if "
 167                           "value labels are to be displayed)",
 168                           G_PARAM_READABLE | G_PARAM_WRITABLE));
 169
 170   g_object_class_install_property (
 171     gobject_class, PROP_FORMAT,
 172     g_param_spec_boxed ("format",
 173                         "Format",
 174                         "The format used to display values (that are not "
 175                         "displayed as value labels) and to interpret values "
 176                         "entered.",
 177                         PSPPIRE_TYPE_FORMAT,
 178                         G_PARAM_READABLE | G_PARAM_WRITABLE));
 179
 180   g_object_class_install_property (
 181     gobject_class, PROP_ENCODING,
 182     g_param_spec_string ("encoding",
 183                          "Encoding",
 184                          "The encoding (e.g. \"UTF-8\") for string values.  "
 185                          "For numeric values this setting has no effect.",
 186                          "UTF-8",
 187                          G_PARAM_READABLE | G_PARAM_WRITABLE));
 188
 189   g_object_class_install_property (
 190     gobject_class, PROP_WIDTH,
 191     g_param_spec_int ("width",
 192                       "Width",
 193                       "Width of the value, either 0 for a numeric value or "
 194                       "a positive integer count of bytes for string values.",
 195                       0, MAX_STRING,
 196                       0,
 197                       G_PARAM_READABLE | G_PARAM_WRITABLE));
 198 }
 199
 200 static void
 201 psppire_value_entry_text_changed (GtkEntryBuffer *buffer,
 202                                   GParamSpec *pspec,
 203                                   PsppireValueEntry *obj)
 204 {
 205   obj->cur_value = NULL;
 206 }
 207
 208 static void
 209 psppire_value_entry_init (PsppireValueEntry *obj)
 210 {
 211   GtkEntry *entry = GTK_ENTRY (gtk_bin_get_child (GTK_BIN (obj)));
 212   GtkEntryBuffer *buffer = gtk_entry_get_buffer (entry);
 213
 214   obj->show_value_label = true;
 215   obj->val_labs = NULL;
 216   obj->format = F_8_0;
 217   obj->encoding = NULL;
 218   obj->cur_value = NULL;
 219
 220   g_signal_connect (buffer, "notify::text",
 221                     G_CALLBACK (psppire_value_entry_text_changed), obj);
 222 }
 223
 224 static void
 225 psppire_value_entry_finalize (GObject *gobject)
 226 {
 227   PsppireValueEntry *obj = PSPPIRE_VALUE_ENTRY (gobject);
 228
 229   val_labs_destroy (obj->val_labs);
 230   g_free (obj->encoding);
 231
 232   G_OBJECT_CLASS (psppire_value_entry_parent_class)->finalize (gobject);
 233 }
 234
 235 GtkWidget *
 236 psppire_value_entry_new (void)
 237 {
 238   return GTK_WIDGET (g_object_new (PSPPIRE_TYPE_VALUE_ENTRY, NULL));
 239 }
 240
 241 static void
 242 psppire_value_entry_refresh_model (PsppireValueEntry *obj)
 243 {
 244   GtkWidget *entry = gtk_bin_get_child (GTK_BIN (obj));
 245   GtkTreeModel *model;
 246
 247   if (val_labs_count (obj->val_labs) > 0)
 248     {
 249       const struct val_lab **vls = val_labs_sorted (obj->val_labs);
 250       size_t n_vls = val_labs_count (obj->val_labs);
 251
 252       GtkListStore *list_store;
 253       size_t i;
 254
 255       list_store = gtk_list_store_new (2, G_TYPE_STRING, G_TYPE_POINTER);
 256       model = GTK_TREE_MODEL (list_store);
 257       for (i = 0; i < n_vls; i++)
 258         {
 259           const struct val_lab *vl = vls[i];
 260           GtkTreeIter iter;
 261
 262           gtk_list_store_append (list_store, &iter);
 263           gtk_list_store_set (list_store, &iter,
 264                               COL_LABEL, val_lab_get_label (vl),
 265                               COL_VALUE, val_lab_get_value (vl),
 266                               -1);
 267         }
 268       free (vls);
 269     }
 270   else
 271     model = NULL;
 272
 273   gtk_combo_box_set_model (GTK_COMBO_BOX (obj), model);
 274   gtk_combo_box_entry_set_text_column (GTK_COMBO_BOX_ENTRY (obj), COL_LABEL);
 275   gtk_widget_set_sensitive (entry, model != NULL);
 276 }
 277
 278 void
 279 psppire_value_entry_set_show_value_label (PsppireValueEntry *obj,
 280                                           gboolean show_value_label)
 281 {
 282   if (obj->show_value_label != show_value_label)
 283     {
 284       obj->show_value_label = show_value_label;
 285       g_object_notify (G_OBJECT (obj), "show-value-label");
 286     }
 287 }
 288
 289 gboolean
 290 psppire_value_entry_get_show_value_label (const PsppireValueEntry *obj)
 291 {
 292   return obj->show_value_label;
 293 }
 294
 295 void
 296 psppire_value_entry_set_variable (PsppireValueEntry *obj,
 297                                   const struct variable *var)
 298 {
 299   if (var != NULL)
 300     {
 301       psppire_value_entry_set_value_labels (obj, var_get_value_labels (var));
 302       obj->format = *var_get_print_format (var);
 303       psppire_value_entry_set_encoding (obj, var_get_encoding (var));
 304     }
 305   else
 306     psppire_value_entry_set_value_labels (obj, NULL);
 307 }
 308
 309 void
 310 psppire_value_entry_set_value_labels (PsppireValueEntry *obj,
 311                                       const struct val_labs *val_labs)
 312 {
 313   if (val_labs != NULL
 314       ? obj->val_labs == NULL || !val_labs_equal (obj->val_labs, val_labs)
 315       : obj->val_labs != NULL)
 316     {
 317       obj->cur_value = NULL;
 318
 319       val_labs_destroy (obj->val_labs);
 320       obj->val_labs = val_labs_clone (val_labs);
 321
 322       if (val_labs != NULL)
 323         {
 324           int width = val_labs_get_width (val_labs);
 325           if (width != fmt_var_width (&obj->format))
 326             obj->format = fmt_default_for_width (width);
 327         }
 328
 329       psppire_value_entry_refresh_model (obj);
 330
 331       g_object_notify (G_OBJECT (obj), "value-labels");
 332     }
 333 }
 334
 335 const struct val_labs *
 336 psppire_value_entry_get_value_labels (const PsppireValueEntry *obj)
 337 {
 338   return obj->val_labs;
 339 }
 340
 341 void
 342 psppire_value_entry_set_format (PsppireValueEntry *obj,
 343                                 const struct fmt_spec *format)
 344 {
 345   if (!fmt_equal (format, &obj->format))
 346     {
 347       obj->cur_value = NULL;
 348       obj->format = *format;
 349
 350       if (obj->val_labs
 351           && val_labs_get_width (obj->val_labs) != fmt_var_width (format))
 352         psppire_value_entry_set_value_labels (obj, NULL);
 353
 354       g_object_notify (G_OBJECT (obj), "format");
 355     }
 356 }
 357
 358 const struct fmt_spec *
 359 psppire_value_entry_get_format (const PsppireValueEntry *obj)
 360 {
 361   return &obj->format;
 362 }
 363
 364 void
 365 psppire_value_entry_set_encoding (PsppireValueEntry *obj,
 366                                   const gchar *encoding)
 367 {
 368   g_free (obj->encoding);
 369   obj->encoding = encoding != NULL ? g_strdup (encoding) : NULL;
 370
 371   g_object_notify (G_OBJECT (obj), "encoding");
 372 }
 373
 374 const gchar *
 375 psppire_value_entry_get_encoding (const PsppireValueEntry *obj)
 376 {
 377   return obj->encoding ? obj->encoding : UTF8;
 378 }
 379
 380 void
 381 psppire_value_entry_set_width (PsppireValueEntry *obj, int width)
 382 {
 383   if (width != fmt_var_width (&obj->format))
 384     {
 385       struct fmt_spec format = fmt_default_for_width (width);
 386       psppire_value_entry_set_format (obj, &format);
 387     }
 388 }
 389
 390 int
 391 psppire_value_entry_get_width (const PsppireValueEntry *obj)
 392 {
 393   return fmt_var_width (&obj->format);
 394 }
 395
 396 void
 397 psppire_value_entry_set_value (PsppireValueEntry *obj,
 398                                const union value *value,
 399                                int width)
 400 {
 401   GtkEntry *entry = GTK_ENTRY (gtk_bin_get_child (GTK_BIN (obj)));
 402   gchar *string;
 403
 404   obj->cur_value = NULL;
 405   if (obj->show_value_label)
 406     {
 407       struct val_lab *vl = val_labs_lookup (obj->val_labs, value);
 408       if (vl != NULL)
 409         {
 410           gtk_entry_set_text (entry, val_lab_get_label (vl));
 411           obj->cur_value = val_lab_get_value (vl);
 412           return;
 413         }
 414     }
 415
 416   string = value_to_text__ (*value, &obj->format, obj->encoding);
 417   gtk_entry_set_text (entry, string);
 418   g_free (string);
 419 }
 420
 421 gboolean
 422 psppire_value_entry_get_value (PsppireValueEntry *obj,
 423                                union value *value,
 424                                int width)
 425 {
 426   GtkEntry *entry = GTK_ENTRY (gtk_bin_get_child (GTK_BIN (obj)));
 427   GtkTreeIter iter;
 428
 429   g_return_val_if_fail (fmt_var_width (&obj->format) == width, FALSE);
 430
 431   if (obj->cur_value)
 432     {
 433       value_copy (value, obj->cur_value, width);
 434       return TRUE;
 435     }
 436   else if (gtk_combo_box_get_active_iter (GTK_COMBO_BOX (obj), &iter))
 437     {
 438       union value *v;
 439
 440       gtk_tree_model_get (gtk_combo_box_get_model (GTK_COMBO_BOX (obj)), &iter,
 441                           COL_VALUE, &v,
 442                           -1);
 443       value_copy (value, v, width);
 444       return TRUE;
 445     }
 446   else
 447     {
 448       const gchar *new_text;
 449
 450       new_text = gtk_entry_get_text (entry);
 451       return data_in_msg (ss_cstr (new_text), UTF8,
 452                           obj->format.type,
 453                           value, width, obj->encoding);
 454     }
 455 }