src/uibuilder.h

   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 #ifndef _VIKING_UIBUILDER_H
  22 #define _VIKING_UIBUILDER_H
  23
  24 #include <gtk/gtk.h>
  25
  26 /* Parameters (for I/O and Properties) */
  27
  28 typedef union {
  29   gdouble d;
  30   guint32 u;
  31   gint32 i;
  32   gboolean b;
  33   const gchar *s;
  34   GdkColor c;
  35   GList *sl;
  36 } VikLayerParamData;
  37
  38 typedef struct {
  39   const gchar *name;
  40   guint8 type;
  41   gint16 group;
  42   const gchar *title;
  43   guint8 widget_type;
  44   gpointer widget_data;
  45   gpointer extra_widget_data;
  46 } VikLayerParam;
  47
  48 enum {
  49 VIK_LAYER_NOT_IN_PROPERTIES=-2,
  50 VIK_LAYER_GROUP_NONE=-1
  51 };
  52
  53 enum {
  54 VIK_LAYER_WIDGET_CHECKBUTTON=0,
  55 VIK_LAYER_WIDGET_RADIOGROUP,
  56 VIK_LAYER_WIDGET_RADIOGROUP_STATIC,
  57 VIK_LAYER_WIDGET_SPINBUTTON,
  58 VIK_LAYER_WIDGET_ENTRY,
  59 VIK_LAYER_WIDGET_FILEENTRY,
  60 VIK_LAYER_WIDGET_HSCALE,
  61 VIK_LAYER_WIDGET_COLOR,
  62 VIK_LAYER_WIDGET_COMBOBOX,
  63 VIK_LAYER_WIDGET_FILELIST,
  64 };
  65
  66 typedef struct {
  67   gdouble min;
  68   gdouble max;
  69   gdouble step;
  70   guint8 digits;
  71 } VikLayerParamScale;
  72
  73 /* id is index */
  74 enum {
  75 VIK_LAYER_PARAM_DOUBLE=1,
  76 VIK_LAYER_PARAM_UINT,
  77 VIK_LAYER_PARAM_INT,
  78
  79 /* in my_layer_set_param, if you want to use the string, you should dup it
  80  * in my_layer_get_param, the string returned will NOT be free'd, you are responsible for managing it (I think) */
  81 VIK_LAYER_PARAM_STRING,
  82 VIK_LAYER_PARAM_BOOLEAN,
  83 VIK_LAYER_PARAM_COLOR,
  84
  85 /* NOTE: string list works uniquely: data.sl should NOT be free'd when
  86  * the internals call get_param -- i.e. it should be managed w/in the layer.
  87  * The value passed by the internals into set_param should also be managed
  88  * by the layer -- i.e. free'd by the layer.
  89  */
  90
  91 VIK_LAYER_PARAM_STRING_LIST,
  92 };
  93
  94 GtkWidget *a_uibuilder_new_widget ( VikLayerParam *param, VikLayerParamData data );
  95 VikLayerParamData a_uibuilder_widget_get_value ( GtkWidget *widget, VikLayerParam *param );
  96 gint a_uibuilder_properties_factory ( GtkWindow *parent, VikLayerParam *params,
  97                         guint16 params_count, gchar **groups, guint8 groups_count,
  98                         gboolean (*setparam) (gpointer,guint16,VikLayerParamData,gpointer),
  99                         gpointer pass_along1, gpointer pass_along2,
 100                         VikLayerParamData (*getparam) (gpointer,guint16),
 101                         gpointer pass_along_getparam );
 102                                 /* pass_along1 and pass_along2 are for set_param first and last params */
 103
 104
 105 VikLayerParamData *a_uibuilder_run_dialog ( GtkWindow *parent, VikLayerParam *params,
 106                         guint16 params_count, gchar **groups, guint8 groups_count,
 107                         VikLayerParamData *params_defaults );
 108
 109 /* frees data from last (if ness) */
 110 void a_uibuilder_free_paramdatas ( VikLayerParamData *paramdatas, VikLayerParam *params, guint16 params_count );
 111
 112 #endif