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