2 * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
4 * Copyright (C) 2003-2007, Evan Battaglia <gtoevan@gmx.net>
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.
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.
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
21 #ifndef _VIKING_UIBUILDER_H
22 #define _VIKING_UIBUILDER_H
28 /* Parameters (for I/O and Properties) */
41 VIK_LAYER_WIDGET_CHECKBUTTON=0,
42 VIK_LAYER_WIDGET_RADIOGROUP,
43 VIK_LAYER_WIDGET_RADIOGROUP_STATIC,
44 VIK_LAYER_WIDGET_SPINBUTTON,
45 VIK_LAYER_WIDGET_ENTRY,
46 VIK_LAYER_WIDGET_PASSWORD,
47 VIK_LAYER_WIDGET_FILEENTRY,
48 VIK_LAYER_WIDGET_FOLDERENTRY,
49 VIK_LAYER_WIDGET_HSCALE,
50 VIK_LAYER_WIDGET_COLOR,
51 VIK_LAYER_WIDGET_COMBOBOX,
52 VIK_LAYER_WIDGET_FILELIST,
57 VIK_LAYER_PARAM_DOUBLE=1,
61 /* in my_layer_set_param, if you want to use the string, you should dup it
62 * in my_layer_get_param, the string returned will NOT be free'd, you are responsible for managing it (I think) */
63 VIK_LAYER_PARAM_STRING,
64 VIK_LAYER_PARAM_BOOLEAN,
65 VIK_LAYER_PARAM_COLOR,
67 /* NOTE: string list works uniquely: data.sl should NOT be free'd when
68 * the internals call get_param -- i.e. it should be managed w/in the layer.
69 * The value passed by the internals into set_param should also be managed
70 * by the layer -- i.e. free'd by the layer.
73 VIK_LAYER_PARAM_STRING_LIST,
77 VIK_LAYER_AGGREGATE = 0,
84 VIK_LAYER_NUM_TYPES // Also use this value to indicate no layer association
87 // Default value has to be returned via a function
88 // because certain types value are can not be statically allocated
89 // (i.e. a string value that is dependent on other functions)
90 // Also easier for colours to be set via a function call rather than a static assignment
91 typedef VikLayerParamData (*VikLayerDefaultFunc) ( void );
94 VikLayerTypeEnum layer;
96 VikLayerParamType type;
99 VikLayerWidgetType widget_type;
100 gpointer widget_data;
101 gpointer extra_widget_data;
102 const gchar *tooltip;
103 VikLayerDefaultFunc default_value;
107 VIK_LAYER_NOT_IN_PROPERTIES=-2,
108 VIK_LAYER_GROUP_NONE=-1
116 } VikLayerParamScale;
119 /* Annoyingly 'C' cannot initialize unions properly */
120 /* It's dependent on the standard used or the compiler support... */
121 #if defined __STDC_VERSION__ && __STDC_VERSION__ >= 199901L || __GNUC__
122 #define VIK_LPD_BOOLEAN(X) (VikLayerParamData) { .b = (X) }
123 #define VIK_LPD_INT(X) (VikLayerParamData) { .u = (X) }
124 #define VIK_LPD_UINT(X) (VikLayerParamData) { .i = (X) }
125 #define VIK_LPD_COLOR(X,Y,Z,A) (VikLayerParamData) { .c = (GdkColor){ (X), (Y), (Z), (A) } }
126 #define VIK_LPD_DOUBLE(X) (VikLayerParamData) { .d = (X) }
128 #define VIK_LPD_BOOLEAN(X) (VikLayerParamData) { (X) }
129 #define VIK_LPD_INT(X) (VikLayerParamData) { (X) }
130 #define VIK_LPD_UINT(X) (VikLayerParamData) { (X) }
131 #define VIK_LPD_COLOR(X,Y,Z,A) (VikLayerParamData) { (X), (Y), (Z), (A) }
132 #define VIK_LPD_DOUBLE(X) (VikLayerParamData) { (X) }
135 VikLayerParamData vik_lpd_true_default ( void );
136 VikLayerParamData vik_lpd_false_default ( void );
138 GtkWidget *a_uibuilder_new_widget ( VikLayerParam *param, VikLayerParamData data );
139 VikLayerParamData a_uibuilder_widget_get_value ( GtkWidget *widget, VikLayerParam *param );
140 gint a_uibuilder_properties_factory ( const gchar *dialog_name,
142 VikLayerParam *params,
143 guint16 params_count,
146 gboolean (*setparam) (gpointer,guint16,VikLayerParamData,gpointer,gboolean),
147 gpointer pass_along1,
148 gpointer pass_along2,
149 VikLayerParamData (*getparam) (gpointer,guint16,gboolean),
150 gpointer pass_along_getparam );
151 /* pass_along1 and pass_along2 are for set_param first and last params */
153 VikLayerParamData *a_uibuilder_run_dialog ( const gchar *dialog_name, GtkWindow *parent, VikLayerParam *params,
154 guint16 params_count, gchar **groups, guint8 groups_count,
155 VikLayerParamData *params_defaults );
157 /* frees data from last (if ness) */
158 void a_uibuilder_free_paramdatas ( VikLayerParamData *paramdatas, VikLayerParam *params, guint16 params_count );
161 * Since combo boxes are used in various places
162 * keep the code reasonably tidy and only have one ifdef to cater for the naming variances
164 #if GTK_CHECK_VERSION (2, 24, 0)
165 #define vik_combo_box_text_new gtk_combo_box_text_new
166 #define vik_combo_box_text_append(X,Y) gtk_combo_box_text_append_text(GTK_COMBO_BOX_TEXT(X),Y)
168 #define vik_combo_box_text_new gtk_combo_box_new_text
169 #define vik_combo_box_text_append(X,Y) gtk_combo_box_append_text(GTK_COMBO_BOX(X),Y)
172 // Consider adding sort options such as by time
173 // However use within the treeview then is more complicated as one would need to store that data in the treeview...
176 VL_SO_ALPHABETICAL_ASCENDING,
177 VL_SO_ALPHABETICAL_DESCENDING,
179 } vik_layer_sort_order_t;