Ensure highlight for a single track or waypoint is always shown on top.

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

diff --git a/src/uibuilder.h b/src/uibuilder.h
index b9669c4ec48007d4503e2114bda695ca40ef0f84..cc399ce3b67235d4137a5f9df47eafde7c929bf2 100644 (file)
--- a/src/uibuilder.h
+++ b/src/uibuilder.h
@@ -23,6 +23,8 @@
 
 #include <gtk/gtk.h>
 
 
 #include <gtk/gtk.h>
 

+G_BEGIN_DECLS
+

 /* Parameters (for I/O and Properties) */
 
 typedef union {
 /* Parameters (for I/O and Properties) */
 
 typedef union {


@@ -35,14 +37,76 @@ typedef union {
   GList *sl;
 } VikLayerParamData;
 
   GList *sl;
 } VikLayerParamData;
 

+typedef enum {
+  VIK_LAYER_WIDGET_CHECKBUTTON=0,
+  VIK_LAYER_WIDGET_RADIOGROUP,
+  VIK_LAYER_WIDGET_RADIOGROUP_STATIC,
+  VIK_LAYER_WIDGET_SPINBUTTON,
+  VIK_LAYER_WIDGET_ENTRY,
+  VIK_LAYER_WIDGET_PASSWORD,
+  VIK_LAYER_WIDGET_FILEENTRY,
+  VIK_LAYER_WIDGET_FOLDERENTRY,
+  VIK_LAYER_WIDGET_HSCALE,
+  VIK_LAYER_WIDGET_COLOR,
+  VIK_LAYER_WIDGET_COMBOBOX,
+  VIK_LAYER_WIDGET_FILELIST,
+} VikLayerWidgetType;
+
+/* id is index */
+typedef enum {
+VIK_LAYER_PARAM_DOUBLE=1,
+VIK_LAYER_PARAM_UINT,
+VIK_LAYER_PARAM_INT,
+
+/* in my_layer_set_param, if you want to use the string, you should dup it
+ * in my_layer_get_param, the string returned will NOT be free'd, you are responsible for managing it (I think) */
+VIK_LAYER_PARAM_STRING,
+VIK_LAYER_PARAM_BOOLEAN,
+VIK_LAYER_PARAM_COLOR,
+
+/* NOTE: string list works uniquely: data.sl should NOT be free'd when
+ * the internals call get_param -- i.e. it should be managed w/in the layer.
+ * The value passed by the internals into set_param should also be managed
+ * by the layer -- i.e. free'd by the layer.
+ */
+
+VIK_LAYER_PARAM_STRING_LIST,
+} 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 {
 typedef struct {

+  VikLayerTypeEnum layer;

   const gchar *name;
   const gchar *name;

-  guint8 type;
+  VikLayerParamType type;

   gint16 group;
   const gchar *title;
   gint16 group;
   const gchar *title;

-  guint8 widget_type;
+  VikLayerWidgetType widget_type;

   gpointer widget_data;
   gpointer extra_widget_data;
   gpointer widget_data;
   gpointer extra_widget_data;

+  const gchar *tooltip;
+  VikLayerDefaultFunc default_value;
+  VikLayerConvertFunc convert_to_display;
+  VikLayerConvertFunc convert_to_internal;

 } VikLayerParam;
 
 enum {
 } VikLayerParam;
 
 enum {


@@ -50,21 +114,6 @@ VIK_LAYER_NOT_IN_PROPERTIES=-2,
 VIK_LAYER_GROUP_NONE=-1
 };
 
 VIK_LAYER_GROUP_NONE=-1
 };
 

-enum {
-VIK_LAYER_WIDGET_CHECKBUTTON=0,
-VIK_LAYER_WIDGET_RADIOGROUP,
-VIK_LAYER_WIDGET_RADIOGROUP_STATIC,
-VIK_LAYER_WIDGET_SPINBUTTON,
-VIK_LAYER_WIDGET_ENTRY,
-VIK_LAYER_WIDGET_PASSWORD,
-VIK_LAYER_WIDGET_FILEENTRY,
-VIK_LAYER_WIDGET_FOLDERENTRY,
-VIK_LAYER_WIDGET_HSCALE,
-VIK_LAYER_WIDGET_COLOR,
-VIK_LAYER_WIDGET_COMBOBOX,
-VIK_LAYER_WIDGET_FILELIST,
-};
-

 typedef struct {
   gdouble min;
   gdouble max;
 typedef struct {
   gdouble min;
   gdouble max;


@@ -72,43 +121,81 @@ typedef struct {
   guint8 digits;
 } VikLayerParamScale;
 
   guint8 digits;
 } VikLayerParamScale;
 

-/* id is index */
-enum {
-VIK_LAYER_PARAM_DOUBLE=1,
-VIK_LAYER_PARAM_UINT,
-VIK_LAYER_PARAM_INT,

 
 

-/* in my_layer_set_param, if you want to use the string, you should dup it
- * in my_layer_get_param, the string returned will NOT be free'd, you are responsible for managing it (I think) */
-VIK_LAYER_PARAM_STRING,
-VIK_LAYER_PARAM_BOOLEAN,
-VIK_LAYER_PARAM_COLOR,
+  /* 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

 
 

-/* NOTE: string list works uniquely: data.sl should NOT be free'd when
- * the internals call get_param -- i.e. it should be managed w/in the layer.
- * The value passed by the internals into set_param should also be managed
- * by the layer -- i.e. free'd by the layer.
- */
+VikLayerParamData vik_lpd_true_default ( void );
+VikLayerParamData vik_lpd_false_default ( void );

 
 

-VIK_LAYER_PARAM_STRING_LIST,
-};
+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 );
 
 GtkWidget *a_uibuilder_new_widget ( VikLayerParam *param, VikLayerParamData data );
 VikLayerParamData a_uibuilder_widget_get_value ( GtkWidget *widget, VikLayerParam *param );

-gint a_uibuilder_properties_factory ( GtkWindow *parent, VikLayerParam *params,
-                        guint16 params_count, gchar **groups, guint8 groups_count,
-                        gboolean (*setparam) (gpointer,guint16,VikLayerParamData,gpointer),
-                        gpointer pass_along1, gpointer pass_along2,
-                        VikLayerParamData (*getparam) (gpointer,guint16),
-                        gpointer pass_along_getparam );
-                                /* pass_along1 and pass_along2 are for set_param first and last params */
-
-
-VikLayerParamData *a_uibuilder_run_dialog ( GtkWindow *parent, VikLayerParam *params,
+gint a_uibuilder_properties_factory ( const gchar *dialog_name,
+                                      GtkWindow *parent,
+                                      VikLayerParam *params,
+                                      guint16 params_count,
+                                      gchar **groups,
+                                      guint8 groups_count,
+                                      gboolean (*setparam) (gpointer,guint16,VikLayerParamData,gpointer,gboolean), // AKA VikLayerFuncSetParam in viklayer.h
+                                      gpointer pass_along1,
+                                      gpointer pass_along2,
+                                      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,

                         guint16 params_count, gchar **groups, guint8 groups_count,
                        VikLayerParamData *params_defaults );
 
 /* frees data from last (if ness) */
 void a_uibuilder_free_paramdatas ( VikLayerParamData *paramdatas, VikLayerParam *params, guint16 params_count );
 
                         guint16 params_count, gchar **groups, guint8 groups_count,
                        VikLayerParamData *params_defaults );
 
 /* 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
 #endif