Enable Cache conversion in the Python tool viking-cache.py

[andy/viking.git] / src / uibuilder.h

diff --git a/src/uibuilder.h b/src/uibuilder.h
index 531159ad21ca56da8e99629e45b7004f7111d471..7052e5b18d0724576f4c9ad1dd33c5c3335d8df4 100644 (file)
--- a/src/uibuilder.h
+++ b/src/uibuilder.h
@@ -35,6 +35,7 @@ typedef union {
   const gchar *s;
   GdkColor c;
   GList *sl;
+  gpointer ptr; // For internal usage - don't save this value in a file!
 } VikLayerParamData;
 
 typedef enum {
@@ -50,6 +51,7 @@ typedef enum {
   VIK_LAYER_WIDGET_COLOR,
   VIK_LAYER_WIDGET_COMBOBOX,
   VIK_LAYER_WIDGET_FILELIST,
+  VIK_LAYER_WIDGET_BUTTON,
 } VikLayerWidgetType;
 
 /* id is index */
@@ -71,9 +73,32 @@ VIK_LAYER_PARAM_COLOR,
  */
 
 VIK_LAYER_PARAM_STRING_LIST,
+VIK_LAYER_PARAM_PTR, // Not really a 'parameter' but useful to route to extended configuration (e.g. toolbar order)
 } VikLayerParamType;
 
+typedef enum {
+  VIK_LAYER_AGGREGATE = 0,
+  VIK_LAYER_TRW,
+  VIK_LAYER_COORD,
+  VIK_LAYER_GEOREF,
+  VIK_LAYER_GPS,
+  VIK_LAYER_MAPS,
+  VIK_LAYER_DEM,
+  VIK_LAYER_NUM_TYPES // Also use this value to indicate no layer association
+} VikLayerTypeEnum;
+
+// Default value has to be returned via a function
+//  because certain types value are can not be statically allocated
+//  (i.e. a string value that is dependent on other functions)
+// Also easier for colours to be set via a function call rather than a static assignment
+typedef VikLayerParamData (*VikLayerDefaultFunc) ( void );
+
+// Convert between the value held internally and the value used for display
+//  e.g. keep the internal value in seconds yet use days in the display
+typedef VikLayerParamData (*VikLayerConvertFunc) ( VikLayerParamData );
+
 typedef struct {
+  VikLayerTypeEnum layer;
   const gchar *name;
   VikLayerParamType type;
   gint16 group;
@@ -82,6 +107,9 @@ typedef struct {
   gpointer widget_data;
   gpointer extra_widget_data;
   const gchar *tooltip;
+  VikLayerDefaultFunc default_value;
+  VikLayerConvertFunc convert_to_display;
+  VikLayerConvertFunc convert_to_internal;
 } VikLayerParam;
 
 enum {
@@ -97,8 +125,35 @@ typedef struct {
 } VikLayerParamScale;
 
 
+  /* Annoyingly 'C' cannot initialize unions properly */
+  /* It's dependent on the standard used or the compiler support... */
+#if defined __STDC_VERSION__ && __STDC_VERSION__ >= 199901L || __GNUC__
+#define VIK_LPD_BOOLEAN(X)     (VikLayerParamData) { .b = (X) }
+#define VIK_LPD_INT(X)         (VikLayerParamData) { .u = (X) }
+#define VIK_LPD_UINT(X)        (VikLayerParamData) { .i = (X) }
+#define VIK_LPD_COLOR(X,Y,Z,A) (VikLayerParamData) { .c = (GdkColor){ (X), (Y), (Z), (A) } }
+#define VIK_LPD_DOUBLE(X)      (VikLayerParamData) { .d = (X) }
+#else
+#define VIK_LPD_BOOLEAN(X)     (VikLayerParamData) { (X) }
+#define VIK_LPD_INT(X)         (VikLayerParamData) { (X) }
+#define VIK_LPD_UINT(X)        (VikLayerParamData) { (X) }
+#define VIK_LPD_COLOR(X,Y,Z,A) (VikLayerParamData) { (X), (Y), (Z), (A) }
+#define VIK_LPD_DOUBLE(X)      (VikLayerParamData) { (X) }
+#endif
+
+VikLayerParamData vik_lpd_true_default ( void );
+VikLayerParamData vik_lpd_false_default ( void );
 
+typedef enum {
+  UI_CHG_LAYER = 0,
+  UI_CHG_PARAM,
+  UI_CHG_PARAM_ID,
+  UI_CHG_WIDGETS,
+  UI_CHG_LABELS,
+  UI_CHG_LAST
+} ui_change_index;
 
+typedef gpointer ui_change_values[UI_CHG_LAST];
 
 GtkWidget *a_uibuilder_new_widget ( VikLayerParam *param, VikLayerParamData data );
 VikLayerParamData a_uibuilder_widget_get_value ( GtkWidget *widget, VikLayerParam *param );
@@ -108,11 +163,12 @@ gint a_uibuilder_properties_factory ( const gchar *dialog_name,
                                       guint16 params_count,
                                       gchar **groups,
                                       guint8 groups_count,
-                                      gboolean (*setparam) (gpointer,guint16,VikLayerParamData,gpointer,gboolean),
+                                      gboolean (*setparam) (gpointer,guint16,VikLayerParamData,gpointer,gboolean), // AKA VikLayerFuncSetParam in viklayer.h
                                       gpointer pass_along1,
                                       gpointer pass_along2,
-                                      VikLayerParamData (*getparam) (gpointer,guint16,gboolean),
-                                      gpointer pass_along_getparam );
+                                      VikLayerParamData (*getparam) (gpointer,guint16,gboolean),  // AKA VikLayerFuncGetParam in viklayer.h
+                                      gpointer pass_along_getparam,
+                                      void (*changeparam) (GtkWidget*, ui_change_values) ); // AKA VikLayerFuncChangeParam in viklayer.h
                                       /* pass_along1 and pass_along2 are for set_param first and last params */
 
 VikLayerParamData *a_uibuilder_run_dialog ( const gchar *dialog_name, GtkWindow *parent, VikLayerParam *params,
@@ -122,6 +178,27 @@ VikLayerParamData *a_uibuilder_run_dialog ( const gchar *dialog_name, GtkWindow
 /* frees data from last (if ness) */
 void a_uibuilder_free_paramdatas ( VikLayerParamData *paramdatas, VikLayerParam *params, guint16 params_count );
 
+/*
+ * Since combo boxes are used in various places
+ * keep the code reasonably tidy and only have one ifdef to cater for the naming variances
+ */
+#if GTK_CHECK_VERSION (2, 24, 0)
+#define vik_combo_box_text_new gtk_combo_box_text_new
+#define vik_combo_box_text_append(X,Y) gtk_combo_box_text_append_text(GTK_COMBO_BOX_TEXT(X),Y)
+#else
+#define vik_combo_box_text_new gtk_combo_box_new_text
+#define vik_combo_box_text_append(X,Y) gtk_combo_box_append_text(GTK_COMBO_BOX(X),Y)
+#endif
+
+// Consider adding sort options such as by time
+//  However use within the treeview then is more complicated as one would need to store that data in the treeview...
+typedef enum {
+  VL_SO_NONE = 0,
+  VL_SO_ALPHABETICAL_ASCENDING,
+  VL_SO_ALPHABETICAL_DESCENDING,
+  VL_SO_LAST
+} vik_layer_sort_order_t;
+
 G_END_DECLS
 
 #endif