src/uibuilder.c

   1 /*
   2  * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
   3  *
   4  * Copyright (C) 2003-2007, Evan Battaglia <gtoevan@gmx.net>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  */
  21 #ifdef HAVE_CONFIG_H
  22 #include "config.h"
  23 #endif
  24
  25 #include <gtk/gtk.h>
  26 #include <glib/gi18n.h>
  27 #include "uibuilder.h"
  28 #include "vikradiogroup.h"
  29 #include "vikfileentry.h"
  30 #include "vikfilelist.h"
  31
  32 VikLayerParamData vik_lpd_true_default ( void ) { return VIK_LPD_BOOLEAN ( TRUE ); }
  33 VikLayerParamData vik_lpd_false_default ( void ) { return VIK_LPD_BOOLEAN ( FALSE ); }
  34
  35 GtkWidget *a_uibuilder_new_widget ( VikLayerParam *param, VikLayerParamData data )
  36 {
  37   // Perform pre conversion if necessary
  38   VikLayerParamData vlpd = data;
  39   if ( param->convert_to_display )
  40    vlpd = param->convert_to_display ( data );
  41
  42   GtkWidget *rv = NULL;
  43   switch ( param->widget_type )
  44   {
  45     case VIK_LAYER_WIDGET_COLOR:
  46       if ( param->type == VIK_LAYER_PARAM_COLOR )
  47         rv = gtk_color_button_new_with_color ( &(vlpd.c) );
  48       break;
  49     case VIK_LAYER_WIDGET_CHECKBUTTON:
  50       if ( param->type == VIK_LAYER_PARAM_BOOLEAN )
  51       {
  52         //rv = gtk_check_button_new_with_label ( //param->title );
  53         rv = gtk_check_button_new ();
  54         if ( vlpd.b )
  55           gtk_toggle_button_set_active ( GTK_TOGGLE_BUTTON(rv), TRUE );
  56       }
  57       break;
  58     case VIK_LAYER_WIDGET_COMBOBOX:
  59       if ( param->type == VIK_LAYER_PARAM_UINT && param->widget_data )
  60       {
  61         /* Build a simple combobox */
  62         gchar **pstr = param->widget_data;
  63         rv = vik_combo_box_text_new ();
  64         while ( *pstr )
  65           vik_combo_box_text_append ( rv, *(pstr++) );
  66         if ( param->extra_widget_data ) /* map of alternate uint values for options */
  67         {
  68           /* Set the effective default value */
  69           int i;
  70           for ( i = 0; ((const char **)param->widget_data)[i]; i++ )
  71             if ( ((guint *)param->extra_widget_data)[i] == vlpd.u )
  72             {
  73               /* Match default value */
  74               gtk_combo_box_set_active ( GTK_COMBO_BOX(rv), i );
  75               break;
  76             }
  77         }
  78         else
  79           gtk_combo_box_set_active ( GTK_COMBO_BOX ( rv ), vlpd.u );
  80       }
  81       else if ( param->type == VIK_LAYER_PARAM_STRING && param->widget_data && !param->extra_widget_data )
  82       {
  83         /* Build a combobox with editable text */
  84         gchar **pstr = param->widget_data;
  85 #if GTK_CHECK_VERSION (2, 24, 0)
  86         rv = gtk_combo_box_text_new_with_entry ();
  87 #else
  88         rv = gtk_combo_box_entry_new_text ();
  89 #endif
  90         if ( vlpd.s )
  91           vik_combo_box_text_append ( rv, vlpd.s );
  92         while ( *pstr )
  93           vik_combo_box_text_append ( rv, *(pstr++) );
  94         if ( vlpd.s )
  95           gtk_combo_box_set_active ( GTK_COMBO_BOX ( rv ), 0 );
  96       }
  97       else if ( param->type == VIK_LAYER_PARAM_STRING && param->widget_data && param->extra_widget_data)
  98       {
  99         /* Build a combobox with fixed selections without editable text */
 100         gchar **pstr = param->widget_data;
 101         rv = GTK_WIDGET ( vik_combo_box_text_new () );
 102         while ( *pstr )
 103           vik_combo_box_text_append ( rv, *(pstr++) );
 104         if ( vlpd.s )
 105         {
 106           /* Set the effective default value */
 107           /* In case of value does not exist, set the first value */
 108           gtk_combo_box_set_active ( GTK_COMBO_BOX ( rv ), 0 );
 109           int i;
 110           for ( i = 0; ((const char **)param->widget_data)[i]; i++ )
 111             if ( strcmp(((const char **)param->extra_widget_data)[i], vlpd.s) == 0 )
 112             {
 113               /* Match default value */
 114               gtk_combo_box_set_active ( GTK_COMBO_BOX ( rv ), i );
 115               break;
 116             }
 117         }
 118         else
 119           gtk_combo_box_set_active ( GTK_COMBO_BOX ( rv ), 0 );
 120       }
 121       break;
 122     case VIK_LAYER_WIDGET_RADIOGROUP:
 123       /* widget_data and extra_widget_data are GList */
 124       if ( param->type == VIK_LAYER_PARAM_UINT && param->widget_data )
 125       {
 126         rv = vik_radio_group_new ( param->widget_data );
 127         if ( param->extra_widget_data ) /* map of alternate uint values for options */
 128         {
 129           int i;
 130           int nb_elem = g_list_length(param->widget_data);
 131           for ( i = 0; i < nb_elem; i++ )
 132             if ( GPOINTER_TO_UINT ( g_list_nth_data(param->extra_widget_data, i) ) == vlpd.u )
 133             {
 134               vik_radio_group_set_selected ( VIK_RADIO_GROUP(rv), i );
 135               break;
 136             }
 137         }
 138         else if ( vlpd.u ) /* zero is already default */
 139           vik_radio_group_set_selected ( VIK_RADIO_GROUP(rv), vlpd.u );
 140       }
 141       break;
 142     case VIK_LAYER_WIDGET_RADIOGROUP_STATIC:
 143       if ( param->type == VIK_LAYER_PARAM_UINT && param->widget_data )
 144       {
 145         rv = vik_radio_group_new_static ( (const gchar **) param->widget_data );
 146         if ( param->extra_widget_data ) /* map of alternate uint values for options */
 147         {
 148           int i;
 149           for ( i = 0; ((const char **)param->widget_data)[i]; i++ )
 150             if ( ((guint *)param->extra_widget_data)[i] == vlpd.u )
 151             {
 152               vik_radio_group_set_selected ( VIK_RADIO_GROUP(rv), i );
 153               break;
 154             }
 155         }
 156         else if ( vlpd.u ) /* zero is already default */
 157           vik_radio_group_set_selected ( VIK_RADIO_GROUP(rv), vlpd.u );
 158       }
 159       break;
 160     case VIK_LAYER_WIDGET_SPINBUTTON:
 161       if ( (param->type == VIK_LAYER_PARAM_DOUBLE || param->type == VIK_LAYER_PARAM_UINT
 162            || param->type == VIK_LAYER_PARAM_INT)  && param->widget_data )
 163       {
 164         gdouble init_val = (param->type == VIK_LAYER_PARAM_DOUBLE) ? vlpd.d : (param->type == VIK_LAYER_PARAM_UINT ? vlpd.u : vlpd.i);
 165         VikLayerParamScale *scale = (VikLayerParamScale *) param->widget_data;
 166         rv = gtk_spin_button_new ( GTK_ADJUSTMENT(gtk_adjustment_new( init_val, scale->min, scale->max, scale->step, scale->step, 0 )), scale->step, scale->digits );
 167       }
 168     break;
 169     case VIK_LAYER_WIDGET_ENTRY:
 170       if ( param->type == VIK_LAYER_PARAM_STRING )
 171       {
 172         rv = gtk_entry_new ();
 173         if ( vlpd.s )
 174           gtk_entry_set_text ( GTK_ENTRY(rv), vlpd.s );
 175       }
 176       break;
 177     case VIK_LAYER_WIDGET_PASSWORD:
 178       if ( param->type == VIK_LAYER_PARAM_STRING )
 179       {
 180         rv = gtk_entry_new ();
 181         gtk_entry_set_visibility ( GTK_ENTRY(rv), FALSE );
 182         if ( vlpd.s )
 183           gtk_entry_set_text ( GTK_ENTRY(rv), vlpd.s );
 184         gtk_widget_set_tooltip_text ( GTK_WIDGET(rv),
 185                                      _("Take care that this password will be stored clearly in a plain file.") );
 186       }
 187       break;
 188     case VIK_LAYER_WIDGET_FILEENTRY:
 189       if ( param->type == VIK_LAYER_PARAM_STRING )
 190       {
 191         rv = vik_file_entry_new (GTK_FILE_CHOOSER_ACTION_OPEN);
 192         if ( vlpd.s )
 193           vik_file_entry_set_filename ( VIK_FILE_ENTRY(rv), vlpd.s );
 194       }
 195       break;
 196     case VIK_LAYER_WIDGET_FOLDERENTRY:
 197       if ( param->type == VIK_LAYER_PARAM_STRING )
 198       {
 199         rv = vik_file_entry_new (GTK_FILE_CHOOSER_ACTION_SELECT_FOLDER);
 200         if ( vlpd.s )
 201           vik_file_entry_set_filename ( VIK_FILE_ENTRY(rv), vlpd.s );
 202       }
 203       break;
 204
 205     case VIK_LAYER_WIDGET_FILELIST:
 206       if ( param->type == VIK_LAYER_PARAM_STRING_LIST )
 207       {
 208         rv = vik_file_list_new ( _(param->title) );
 209         vik_file_list_set_files ( VIK_FILE_LIST(rv), vlpd.sl );
 210       }
 211       break;
 212     case VIK_LAYER_WIDGET_HSCALE:
 213       if ( (param->type == VIK_LAYER_PARAM_DOUBLE || param->type == VIK_LAYER_PARAM_UINT
 214            || param->type == VIK_LAYER_PARAM_INT)  && param->widget_data )
 215       {
 216         gdouble init_val = (param->type == VIK_LAYER_PARAM_DOUBLE) ? vlpd.d : (param->type == VIK_LAYER_PARAM_UINT ? vlpd.u : vlpd.i);
 217         VikLayerParamScale *scale = (VikLayerParamScale *) param->widget_data;
 218         rv = gtk_hscale_new_with_range ( scale->min, scale->max, scale->step );
 219         gtk_scale_set_digits ( GTK_SCALE(rv), scale->digits );
 220         gtk_range_set_value ( GTK_RANGE(rv), init_val );
 221       }
 222   }
 223   if ( rv && !gtk_widget_get_tooltip_text ( rv ) ) {
 224     if ( param->tooltip )
 225       gtk_widget_set_tooltip_text ( rv, _(param->tooltip) );
 226   }
 227   return rv;
 228 }
 229
 230 VikLayerParamData a_uibuilder_widget_get_value ( GtkWidget *widget, VikLayerParam *param )
 231 {
 232   VikLayerParamData rv;
 233   switch ( param->widget_type )
 234   {
 235     case VIK_LAYER_WIDGET_COLOR:
 236       gtk_color_button_get_color ( GTK_COLOR_BUTTON(widget), &(rv.c) );
 237       break;
 238     case VIK_LAYER_WIDGET_CHECKBUTTON:
 239       rv.b = gtk_toggle_button_get_active(GTK_TOGGLE_BUTTON(widget));
 240       break;
 241     case VIK_LAYER_WIDGET_COMBOBOX:
 242       if ( param->type == VIK_LAYER_PARAM_UINT )
 243       {
 244         rv.i = gtk_combo_box_get_active ( GTK_COMBO_BOX(widget) );
 245         if ( rv.i == -1 ) rv.i = 0;
 246         rv.u = rv.i;
 247         if ( param->extra_widget_data )
 248           rv.u = ((guint *)param->extra_widget_data)[rv.u];
 249       }
 250       if ( param->type == VIK_LAYER_PARAM_STRING)
 251       {
 252         if ( param->extra_widget_data )
 253         {
 254           /* Combobox displays labels and we want values from extra */
 255           int pos = gtk_combo_box_get_active ( GTK_COMBO_BOX(widget) );
 256           rv.s = ((const char **)param->extra_widget_data)[pos];
 257         }
 258         else
 259         {
 260           /* Return raw value */
 261 #if GTK_CHECK_VERSION (2, 24, 0)
 262           rv.s = gtk_entry_get_text (GTK_ENTRY (gtk_bin_get_child (GTK_BIN (widget))));
 263 #else
 264           rv.s = gtk_combo_box_get_active_text ( GTK_COMBO_BOX(widget) );
 265 #endif
 266         }
 267         g_debug("%s: %s", __FUNCTION__, rv.s);
 268       }
 269       break;
 270     case VIK_LAYER_WIDGET_RADIOGROUP:
 271     case VIK_LAYER_WIDGET_RADIOGROUP_STATIC:
 272       rv.u = vik_radio_group_get_selected(VIK_RADIO_GROUP(widget));
 273       if ( param->extra_widget_data )
 274         rv.u = GPOINTER_TO_UINT ( g_list_nth_data(param->extra_widget_data, rv.u) );
 275       break;
 276     case VIK_LAYER_WIDGET_SPINBUTTON:
 277       if ( param->type == VIK_LAYER_PARAM_UINT )
 278         rv.u = gtk_spin_button_get_value_as_int ( GTK_SPIN_BUTTON(widget) );
 279       else if ( param->type == VIK_LAYER_PARAM_INT )
 280         rv.i = gtk_spin_button_get_value_as_int ( GTK_SPIN_BUTTON(widget) );
 281       else
 282         rv.d = gtk_spin_button_get_value ( GTK_SPIN_BUTTON(widget) );
 283       break;
 284     case VIK_LAYER_WIDGET_ENTRY:
 285     case VIK_LAYER_WIDGET_PASSWORD:
 286       rv.s = gtk_entry_get_text ( GTK_ENTRY(widget) );
 287       break;
 288     case VIK_LAYER_WIDGET_FILEENTRY:
 289     case VIK_LAYER_WIDGET_FOLDERENTRY:
 290       rv.s = vik_file_entry_get_filename ( VIK_FILE_ENTRY(widget) );
 291       break;
 292     case VIK_LAYER_WIDGET_FILELIST:
 293       rv.sl = vik_file_list_get_files ( VIK_FILE_LIST(widget) );
 294       break;
 295     case VIK_LAYER_WIDGET_HSCALE:
 296       if ( param->type == VIK_LAYER_PARAM_UINT )
 297         rv.u = (guint32) gtk_range_get_value ( GTK_RANGE(widget) );
 298       else if ( param->type == VIK_LAYER_PARAM_INT )
 299         rv.i = (gint32) gtk_range_get_value ( GTK_RANGE(widget) );
 300       else
 301         rv.d = gtk_range_get_value ( GTK_RANGE(widget) );
 302       break;
 303   }
 304
 305   // Perform conversion if necessary
 306   if ( param->convert_to_internal )
 307     rv = param->convert_to_internal ( rv );
 308
 309   return rv;
 310 }
 311
 312 gint a_uibuilder_properties_factory ( const gchar *dialog_name, GtkWindow *parent, VikLayerParam *params,
 313                                       guint16 params_count, gchar **groups, guint8 groups_count,
 314                                       gboolean (*setparam) (gpointer,guint16,VikLayerParamData,gpointer,gboolean),
 315                                       gpointer pass_along1, gpointer pass_along2,
 316                                       VikLayerParamData (*getparam) (gpointer,guint16,gboolean),
 317                                       gpointer pass_along_getparam )
 318                                       /* pass_along1 and pass_along2 are for set_param first and last params */
 319 {
 320   guint16 i, j, widget_count = 0;
 321   gboolean must_redraw = FALSE;
 322
 323   if ( ! params )
 324     return 1; /* no params == no options, so all is good */
 325
 326   for ( i = 0; i < params_count; i++ )
 327     if ( params[i].group != VIK_LAYER_NOT_IN_PROPERTIES )
 328       widget_count++;
 329
 330   if ( widget_count == 0)
 331     return 0; /* TODO -- should be one? */
 332   else
 333   {
 334     /* create widgets and titles; place in table */
 335     GtkWidget *dialog = gtk_dialog_new_with_buttons ( dialog_name,
 336                                                       parent,
 337                                                       GTK_DIALOG_MODAL | GTK_DIALOG_DESTROY_WITH_PARENT,
 338                                                       GTK_STOCK_CANCEL, GTK_RESPONSE_REJECT,
 339                                                       GTK_STOCK_OK, GTK_RESPONSE_ACCEPT, NULL );
 340     gtk_dialog_set_default_response ( GTK_DIALOG(dialog), GTK_RESPONSE_ACCEPT );
 341     GtkWidget *response_w = NULL;
 342 #if GTK_CHECK_VERSION (2, 20, 0)
 343     response_w = gtk_dialog_get_widget_for_response ( GTK_DIALOG(dialog), GTK_RESPONSE_ACCEPT );
 344 #endif
 345     gint resp;
 346
 347     GtkWidget *table = NULL;
 348     GtkWidget **tables = NULL; /* for more than one group */
 349
 350     GtkWidget *notebook = NULL;
 351     GtkWidget **widgets = g_malloc ( sizeof(GtkWidget *) * widget_count );
 352
 353     if ( groups && groups_count > 1 )
 354     {
 355       guint8 current_group;
 356       guint16 tab_widget_count;
 357       notebook = gtk_notebook_new ();
 358       // Switch to vertical notebook mode when many groups
 359       if ( groups_count > 4 )
 360         gtk_notebook_set_tab_pos ( GTK_NOTEBOOK(notebook), GTK_POS_LEFT );
 361       gtk_box_pack_start (GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(dialog))), notebook, FALSE, FALSE, 0);
 362       tables = g_malloc ( sizeof(GtkWidget *) * groups_count );
 363       for ( current_group = 0; current_group < groups_count; current_group++ )
 364       {
 365         tab_widget_count = 0;
 366         for ( j = 0; j < params_count; j ++ )
 367           if ( params[j].group == current_group )
 368             tab_widget_count++;
 369
 370         if ( tab_widget_count )
 371         {
 372           tables[current_group] = gtk_table_new ( tab_widget_count, 1, FALSE );
 373           gtk_notebook_append_page ( GTK_NOTEBOOK(notebook), tables[current_group], gtk_label_new(groups[current_group]) );
 374         }
 375       }
 376     }
 377     else
 378     {
 379       table = gtk_table_new( widget_count, 1, FALSE );
 380       gtk_box_pack_start (GTK_BOX(gtk_dialog_get_content_area(GTK_DIALOG(dialog))), table, FALSE, FALSE, 0);
 381     }
 382
 383     for ( i = 0, j = 0; i < params_count; i++ )
 384     {
 385       if ( params[i].group != VIK_LAYER_NOT_IN_PROPERTIES )
 386       {
 387         if ( tables )
 388           table = tables[MAX(0, params[i].group)]; /* round up NOT_IN_GROUP, that's not reasonable here */
 389
 390         widgets[j] = a_uibuilder_new_widget ( &(params[i]), getparam ( pass_along_getparam, i, FALSE ) );
 391
 392         if ( widgets[j] ) {
 393           gtk_table_attach ( GTK_TABLE(table), gtk_label_new(_(params[i].title)), 0, 1, j, j+1, 0, 0, 0, 0 );
 394           gtk_table_attach ( GTK_TABLE(table), widgets[j], 1, 2, j, j+1, GTK_EXPAND | GTK_FILL, 0, 2, 2 );
 395         }
 396         j++;
 397       }
 398     }
 399
 400     if ( response_w )
 401       gtk_widget_grab_focus ( response_w );
 402
 403     gtk_widget_show_all ( dialog );
 404
 405     resp = gtk_dialog_run (GTK_DIALOG (dialog));
 406     if ( resp == GTK_RESPONSE_ACCEPT )
 407     {
 408       for ( i = 0, j = 0; i < params_count; i++ )
 409       {
 410         if ( params[i].group != VIK_LAYER_NOT_IN_PROPERTIES )
 411         {
 412           if ( setparam ( pass_along1,
 413                           i,
 414                           a_uibuilder_widget_get_value ( widgets[j], &(params[i]) ),
 415                           pass_along2,
 416                           FALSE ) )
 417             must_redraw = TRUE;
 418           j++;
 419         }
 420       }
 421
 422       gtk_widget_destroy ( dialog ); /* hide before redrawing. */
 423       g_free ( widgets );
 424       if ( tables )
 425         g_free ( tables );
 426
 427       return must_redraw ? 2 : 3; /* user clicked OK */
 428     }
 429
 430     if ( tables )
 431       g_free ( tables );
 432     gtk_widget_destroy ( dialog );
 433     g_free ( widgets );
 434     return 0;
 435   }
 436 }
 437
 438
 439 static void uibuilder_run_setparam ( VikLayerParamData *paramdatas, guint16 i, VikLayerParamData data, VikLayerParam *params )
 440 {
 441   /* could have to copy it if it's a string! */
 442   switch ( params[i].type ) {
 443     case VIK_LAYER_PARAM_STRING:
 444       paramdatas[i].s = g_strdup ( data.s );
 445       break;
 446     default:
 447      paramdatas[i] = data; /* string list will have to be freed by layer. anything else not freed */
 448   }
 449 }
 450
 451 static VikLayerParamData uibuilder_run_getparam ( VikLayerParamData *params_defaults, guint16 i )
 452 {
 453   return params_defaults[i];
 454 }
 455
 456
 457 VikLayerParamData *a_uibuilder_run_dialog (  const gchar *dialog_name, GtkWindow *parent, VikLayerParam *params,
 458                         guint16 params_count, gchar **groups, guint8 groups_count,
 459                         VikLayerParamData *params_defaults )
 460 {
 461     VikLayerParamData *paramdatas = g_new(VikLayerParamData, params_count);
 462     if ( a_uibuilder_properties_factory ( dialog_name,
 463                                           parent,
 464                                           params,
 465                                           params_count,
 466                                           groups,
 467                                           groups_count,
 468                                           (gpointer) uibuilder_run_setparam,
 469                                           paramdatas,
 470                                           params,
 471                                           (gpointer) uibuilder_run_getparam,
 472                                           params_defaults ) > 0 ) {
 473
 474       return paramdatas;
 475     }
 476     g_free ( paramdatas );
 477     return NULL;
 478 }
 479
 480 /* frees data from last (if ness) */
 481 void a_uibuilder_free_paramdatas ( VikLayerParamData *paramdatas, VikLayerParam *params, guint16 params_count )
 482 {
 483   int i;
 484   /* may have to free strings, etc. */
 485   for ( i = 0; i < params_count; i++ ) {
 486     switch ( params[i].type ) {
 487       case VIK_LAYER_PARAM_STRING:
 488         g_free ( (gchar *) paramdatas[i].s );
 489         break;
 490       case VIK_LAYER_PARAM_STRING_LIST: {
 491         /* should make a util function out of this */
 492         GList *iter = paramdatas[i].sl;
 493         while ( iter ) {
 494           g_free ( iter->data );
 495           iter = iter->next;
 496         }
 497         g_list_free ( paramdatas[i].sl );
 498         break;
 499       default:
 500         break;
 501       }
 502     }
 503   }
 504   g_free ( paramdatas );
 505 }