]> git.street.me.uk Git - andy/viking.git/blobdiff - src/viklayer.h
SF#3178554: Fix Sun Studio build
[andy/viking.git] / src / viklayer.h
index 543da016671e16ec05703db971919915dc311855..4ea846868d95dac441df5a027857527e803734d2 100644 (file)
@@ -25,8 +25,9 @@
 #include <glib.h>
 #include <gtk/gtk.h>
 #include <gdk-pixbuf/gdk-pixdata.h>
 #include <glib.h>
 #include <gtk/gtk.h>
 #include <gdk-pixbuf/gdk-pixdata.h>
-#include "vikwindow.h"
 
 
+#include "uibuilder.h"
+#include "vikwindow.h"
 #include "viktreeview.h"
 #include "vikviewport.h"
 
 #include "viktreeview.h"
 #include "vikviewport.h"
 
@@ -53,7 +54,7 @@ struct _VikLayer {
   gboolean visible;
 
   gboolean realized;
   gboolean visible;
 
   gboolean realized;
-  VikTreeview *vt; /* simply a refernce */
+  VikTreeview *vt; /* simply a reference */
   GtkTreeIter iter;
 
   /* for explicit "polymorphism" (function type switching) */
   GtkTreeIter iter;
 
   /* for explicit "polymorphism" (function type switching) */
@@ -69,22 +70,34 @@ enum {
   VIK_LAYER_GEOREF,
   VIK_LAYER_GPS,
   VIK_LAYER_MAPS,
   VIK_LAYER_GEOREF,
   VIK_LAYER_GPS,
   VIK_LAYER_MAPS,
+  VIK_LAYER_DEM,
   VIK_LAYER_NUM_TYPES
 };
 
   VIK_LAYER_NUM_TYPES
 };
 
+/* I think most of these are ignored,
+ * returning GRAB_FOCUS grabs the focus for mouse move,
+ * mouse click, release always grabs focus. Focus allows key presses
+ * to be handled.
+ * It used to be that, if ignored, Viking could look for other layers.
+ * this was useful for clicking a way/trackpoint in any layer,
+ * if no layer was selected (find way/trackpoint)
+ */
 typedef enum { 
   VIK_LAYER_TOOL_IGNORED=0,
   VIK_LAYER_TOOL_ACK,
   VIK_LAYER_TOOL_ACK_REDRAW_ABOVE,
   VIK_LAYER_TOOL_ACK_REDRAW_ALL,
 typedef enum { 
   VIK_LAYER_TOOL_IGNORED=0,
   VIK_LAYER_TOOL_ACK,
   VIK_LAYER_TOOL_ACK_REDRAW_ABOVE,
   VIK_LAYER_TOOL_ACK_REDRAW_ALL,
-  VIK_LAYER_TOOL_ACK_REDRAW_IF_VISIBLE 
+  VIK_LAYER_TOOL_ACK_REDRAW_IF_VISIBLE,
+  VIK_LAYER_TOOL_ACK_GRAB_FOCUS, /* only for move */
 } VikLayerToolFuncStatus;
 
 /* gpointer is tool-specific state created in the constructor */
 typedef gpointer (*VikToolConstructorFunc) (VikWindow *, VikViewport *);
 typedef void (*VikToolDestructorFunc) (gpointer);
 typedef VikLayerToolFuncStatus (*VikToolMouseFunc) (VikLayer *, GdkEventButton *, gpointer);
 } VikLayerToolFuncStatus;
 
 /* gpointer is tool-specific state created in the constructor */
 typedef gpointer (*VikToolConstructorFunc) (VikWindow *, VikViewport *);
 typedef void (*VikToolDestructorFunc) (gpointer);
 typedef VikLayerToolFuncStatus (*VikToolMouseFunc) (VikLayer *, GdkEventButton *, gpointer);
+typedef VikLayerToolFuncStatus (*VikToolMouseMoveFunc) (VikLayer *, GdkEventMotion *, gpointer);
 typedef void (*VikToolActivationFunc) (VikLayer *, gpointer);
 typedef void (*VikToolActivationFunc) (VikLayer *, gpointer);
+typedef gboolean (*VikToolKeyFunc) (VikLayer *, GdkEventKey *, gpointer);
 
 typedef struct _VikToolInterface VikToolInterface;
 struct _VikToolInterface {
 
 typedef struct _VikToolInterface VikToolInterface;
 struct _VikToolInterface {
@@ -94,63 +107,17 @@ struct _VikToolInterface {
   VikToolActivationFunc activate;
   VikToolActivationFunc deactivate;
   VikToolMouseFunc click;
   VikToolActivationFunc activate;
   VikToolActivationFunc deactivate;
   VikToolMouseFunc click;
-  VikToolMouseFunc move;
+  VikToolMouseMoveFunc move;
   VikToolMouseFunc release;
   VikToolMouseFunc release;
+  VikToolKeyFunc key_press; /* return FALSE if we don't use the key press -- should return AFLSE most of the time if we want any shortcuts / UI keybindings to work! use sparingly. */
+  GdkCursorType cursor_type;
+  const GdkPixdata *cursor_data;
+  const GdkCursor *cursor;
 };
 
 /* Parameters (for I/O and Properties) */
 };
 
 /* Parameters (for I/O and Properties) */
+/* --> moved to uibuilder.h */
 
 
-typedef union {
-  gdouble d;
-  guint32 u;
-  gint32 i;
-  gboolean b;
-  const gchar *s;
-  GdkColor c;
-} VikLayerParamData;
-
-typedef struct {
-  const gchar *name;
-  guint8 type;
-  gint16 group;
-  const gchar *title;
-  guint8 widget_type;
-  const gpointer widget_data;
-  const gpointer extra_widget_data;
-} VikLayerParam;
-
-enum {
-VIK_LAYER_NOT_IN_PROPERTIES=-2,
-VIK_LAYER_GROUP_NONE=-1
-};
-
-enum {
-VIK_LAYER_WIDGET_CHECKBUTTON=0,
-VIK_LAYER_WIDGET_RADIOGROUP,
-VIK_LAYER_WIDGET_SPINBUTTON,
-VIK_LAYER_WIDGET_ENTRY,
-VIK_LAYER_WIDGET_FILEENTRY,
-VIK_LAYER_WIDGET_HSCALE,
-VIK_LAYER_WIDGET_COLOR,
-VIK_LAYER_WIDGET_COMBOBOX,
-};
-
-typedef struct {
-  gdouble min;
-  gdouble max;
-  gdouble step;
-  guint8 digits;
-} VikLayerParamScale;
-
-/* id is index */
-enum {
-VIK_LAYER_PARAM_DOUBLE=1,
-VIK_LAYER_PARAM_UINT,
-VIK_LAYER_PARAM_INT,
-VIK_LAYER_PARAM_STRING,
-VIK_LAYER_PARAM_BOOLEAN,
-VIK_LAYER_PARAM_COLOR,
-};
 
 /* layer interface functions */
 
 
 /* layer interface functions */
 
@@ -164,35 +131,39 @@ typedef void          (*VikLayerFuncRealize)               (VikLayer *,VikTreevi
 /* rarely used, this is called after a read operation or properties box is run.
  * usually used to create GC's that depend on params,
  * but GC's can also be created from create() or set_param() */
 /* rarely used, this is called after a read operation or properties box is run.
  * usually used to create GC's that depend on params,
  * but GC's can also be created from create() or set_param() */
-typedef void          (*VikLayerFuncPostRead)              (VikLayer *,gpointer vp);
+typedef void          (*VikLayerFuncPostRead)              (VikLayer *,VikViewport *vp,gboolean from_file);
 
 typedef void          (*VikLayerFuncFree)                  (VikLayer *);
 
 /* do _not_ use this unless absolutely neccesary. Use the dynamic properties (see coordlayer for example)
   * returns TRUE if OK was pressed */
 
 typedef void          (*VikLayerFuncFree)                  (VikLayer *);
 
 /* do _not_ use this unless absolutely neccesary. Use the dynamic properties (see coordlayer for example)
   * returns TRUE if OK was pressed */
-typedef gboolean      (*VikLayerFuncProperties)            (VikLayer *,VikViewport *); /* gpointer is a VikViewport */
+typedef gboolean      (*VikLayerFuncProperties)            (VikLayer *,VikViewport *);
 
 typedef void          (*VikLayerFuncDraw)                  (VikLayer *,VikViewport *);
 typedef void          (*VikLayerFuncChangeCoordMode)       (VikLayer *,VikCoordMode);
 
 typedef void          (*VikLayerFuncSetMenuItemsSelection)          (VikLayer *,guint16);
 typedef guint16          (*VikLayerFuncGetMenuItemsSelection)          (VikLayer *);
 
 typedef void          (*VikLayerFuncDraw)                  (VikLayer *,VikViewport *);
 typedef void          (*VikLayerFuncChangeCoordMode)       (VikLayer *,VikCoordMode);
 
 typedef void          (*VikLayerFuncSetMenuItemsSelection)          (VikLayer *,guint16);
 typedef guint16          (*VikLayerFuncGetMenuItemsSelection)          (VikLayer *);
+
 typedef void          (*VikLayerFuncAddMenuItems)          (VikLayer *,GtkMenu *,gpointer); /* gpointer is a VikLayersPanel */
 typedef gboolean      (*VikLayerFuncSublayerAddMenuItems)  (VikLayer *,GtkMenu *,gpointer, /* first gpointer is a VikLayersPanel */
                                                             gint,gpointer,GtkTreeIter *);
 typedef const gchar * (*VikLayerFuncSublayerRenameRequest) (VikLayer *,const gchar *,gpointer,
                                                             gint,VikViewport *,GtkTreeIter *); /* first gpointer is a VikLayersPanel */
 typedef gboolean      (*VikLayerFuncSublayerToggleVisible) (VikLayer *,gint,gpointer);
 typedef void          (*VikLayerFuncAddMenuItems)          (VikLayer *,GtkMenu *,gpointer); /* gpointer is a VikLayersPanel */
 typedef gboolean      (*VikLayerFuncSublayerAddMenuItems)  (VikLayer *,GtkMenu *,gpointer, /* first gpointer is a VikLayersPanel */
                                                             gint,gpointer,GtkTreeIter *);
 typedef const gchar * (*VikLayerFuncSublayerRenameRequest) (VikLayer *,const gchar *,gpointer,
                                                             gint,VikViewport *,GtkTreeIter *); /* first gpointer is a VikLayersPanel */
 typedef gboolean      (*VikLayerFuncSublayerToggleVisible) (VikLayer *,gint,gpointer);
+typedef const gchar * (*VikLayerFuncSublayerTooltip)       (VikLayer *,gint,gpointer);
+typedef const gchar * (*VikLayerFuncLayerTooltip)          (VikLayer *);
 
 
-typedef VikLayer *    (*VikLayerFuncCopy)                  (VikLayer *,VikViewport *);
 typedef void          (*VikLayerFuncMarshall)              (VikLayer *, guint8 **, gint *);
 typedef VikLayer *    (*VikLayerFuncUnmarshall)            (guint8 *, gint, VikViewport *);
 
 /* returns TRUE if needs to redraw due to changed param */
 typedef void          (*VikLayerFuncMarshall)              (VikLayer *, guint8 **, gint *);
 typedef VikLayer *    (*VikLayerFuncUnmarshall)            (guint8 *, gint, VikViewport *);
 
 /* returns TRUE if needs to redraw due to changed param */
-typedef gboolean      (*VikLayerFuncSetParam)              (VikLayer *, guint16, VikLayerParamData, VikViewport *);
+/* in parameter gboolean denotes if for file I/O, as opposed to display/cut/copy etc... operations */
+typedef gboolean      (*VikLayerFuncSetParam)              (VikLayer *, guint16, VikLayerParamData, VikViewport *, gboolean);
 
 
+/* in parameter gboolean denotes if for file I/O, as opposed to display/cut/copy etc... operations */
 typedef VikLayerParamData
 typedef VikLayerParamData
-                      (*VikLayerFuncGetParam)              (VikLayer *, guint16);
+                      (*VikLayerFuncGetParam)              (VikLayer *, guint16, gboolean);
 
 typedef void          (*VikLayerFuncReadFileData)          (VikLayer *, FILE *);
 typedef void          (*VikLayerFuncWriteFileData)         (VikLayer *, FILE *);
 
 typedef void          (*VikLayerFuncReadFileData)          (VikLayer *, FILE *);
 typedef void          (*VikLayerFuncWriteFileData)         (VikLayer *, FILE *);
@@ -200,6 +171,7 @@ typedef void          (*VikLayerFuncWriteFileData)         (VikLayer *, FILE *);
 /* item manipulation */
 typedef void          (*VikLayerFuncDeleteItem)            (VikLayer *, gint, gpointer);
                                                          /*      layer, subtype, pointer to sub-item */
 /* item manipulation */
 typedef void          (*VikLayerFuncDeleteItem)            (VikLayer *, gint, gpointer);
                                                          /*      layer, subtype, pointer to sub-item */
+typedef void          (*VikLayerFuncCutItem)               (VikLayer *, gint, gpointer);
 typedef void          (*VikLayerFuncCopyItem)              (VikLayer *, gint, gpointer, guint8 **, guint *);
                                                          /*      layer, subtype, pointer to sub-item, return pointer, return len */
 typedef gboolean      (*VikLayerFuncPasteItem)             (VikLayer *, gint, guint8 *, guint);
 typedef void          (*VikLayerFuncCopyItem)              (VikLayer *, gint, gpointer, guint8 **, guint *);
                                                          /*      layer, subtype, pointer to sub-item, return pointer, return len */
 typedef gboolean      (*VikLayerFuncPasteItem)             (VikLayer *, gint, guint8 *, guint);
@@ -254,8 +226,9 @@ struct _VikLayerInterface {
   VikLayerFuncSublayerAddMenuItems  sublayer_add_menu_items;
   VikLayerFuncSublayerRenameRequest sublayer_rename_request;
   VikLayerFuncSublayerToggleVisible sublayer_toggle_visible;
   VikLayerFuncSublayerAddMenuItems  sublayer_add_menu_items;
   VikLayerFuncSublayerRenameRequest sublayer_rename_request;
   VikLayerFuncSublayerToggleVisible sublayer_toggle_visible;
+  VikLayerFuncSublayerTooltip       sublayer_tooltip;
+  VikLayerFuncLayerTooltip          layer_tooltip;
 
 
-  VikLayerFuncCopy                  copy;
   VikLayerFuncMarshall              marshall;
   VikLayerFuncUnmarshall            unmarshall;
 
   VikLayerFuncMarshall              marshall;
   VikLayerFuncUnmarshall            unmarshall;
 
@@ -268,6 +241,7 @@ struct _VikLayerInterface {
   VikLayerFuncWriteFileData         write_file_data;
 
   VikLayerFuncDeleteItem            delete_item;
   VikLayerFuncWriteFileData         write_file_data;
 
   VikLayerFuncDeleteItem            delete_item;
+  VikLayerFuncCutItem               cut_item;
   VikLayerFuncCopyItem              copy_item;
   VikLayerFuncPasteItem             paste_item;
   VikLayerFuncFreeCopiedItem        free_copied_item;
   VikLayerFuncCopyItem              copy_item;
   VikLayerFuncPasteItem             paste_item;
   VikLayerFuncFreeCopiedItem        free_copied_item;
@@ -283,8 +257,9 @@ void vik_layer_draw ( VikLayer *l, gpointer data );
 void vik_layer_change_coord_mode ( VikLayer *l, VikCoordMode mode );
 void vik_layer_rename ( VikLayer *l, const gchar *new_name );
 void vik_layer_rename_no_copy ( VikLayer *l, gchar *new_name );
 void vik_layer_change_coord_mode ( VikLayer *l, VikCoordMode mode );
 void vik_layer_rename ( VikLayer *l, const gchar *new_name );
 void vik_layer_rename_no_copy ( VikLayer *l, gchar *new_name );
+const gchar *vik_layer_get_name ( VikLayer *l );
 
 
-gboolean vik_layer_set_param (VikLayer *layer, guint16 id, VikLayerParamData data, gpointer vp);
+gboolean vik_layer_set_param (VikLayer *layer, guint16 id, VikLayerParamData data, gpointer vp, gboolean is_file_operation);
 
 void vik_layer_emit_update ( VikLayer *vl );
 
 
 void vik_layer_emit_update ( VikLayer *vl );
 
@@ -296,7 +271,7 @@ VikLayer *vik_layer_create ( gint type, gpointer vp, GtkWindow *w, gboolean inte
 gboolean vik_layer_properties ( VikLayer *layer, gpointer vp );
 
 void vik_layer_realize ( VikLayer *l, VikTreeview *vt, GtkTreeIter * layer_iter );
 gboolean vik_layer_properties ( VikLayer *layer, gpointer vp );
 
 void vik_layer_realize ( VikLayer *l, VikTreeview *vt, GtkTreeIter * layer_iter );
-void vik_layer_post_read ( VikLayer *layer, gpointer vp );
+void vik_layer_post_read ( VikLayer *layer, VikViewport *vp, gboolean from_file );
 
 gboolean vik_layer_sublayer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter );
 
 
 gboolean vik_layer_sublayer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter );
 
@@ -310,7 +285,15 @@ const gchar *vik_layer_sublayer_rename_request ( VikLayer *l, const gchar *newna
 
 gboolean vik_layer_sublayer_toggle_visible ( VikLayer *l, gint subtype, gpointer sublayer );
 
 
 gboolean vik_layer_sublayer_toggle_visible ( VikLayer *l, gint subtype, gpointer sublayer );
 
+const gchar* vik_layer_sublayer_tooltip ( VikLayer *l, gint subtype, gpointer sublayer );
+
+const gchar* vik_layer_layer_tooltip ( VikLayer *l );
+
 /* TODO: put in layerspanel */
 GdkPixbuf *vik_layer_load_icon ( gint type );
 
 /* TODO: put in layerspanel */
 GdkPixbuf *vik_layer_load_icon ( gint type );
 
+VikLayer *vik_layer_get_and_reset_trigger();
+void vik_layer_emit_update_secondary ( VikLayer *vl ); /* to be called by aggregate layer only. doesn't set the trigger */
+void vik_layer_emit_update_although_invisible ( VikLayer *vl );
+
 #endif
 #endif