X-Git-Url: https://git.street.me.uk/andy/viking.git/blobdiff_plain/70a23263f2aea090c9134e379601e72131797af2..d61ec067563735c651f81e6ad0f31be01a8c202b:/src/viklayer.h?ds=sidebyside diff --git a/src/viklayer.h b/src/viklayer.h index 22404e2b..8abb37ea 100644 --- a/src/viklayer.h +++ b/src/viklayer.h @@ -18,11 +18,21 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA * */ -#include - #ifndef _VIKING_LAYER_H #define _VIKING_LAYER_H +#include +#include +#include +#include + +#include "uibuilder.h" +#include "vikwindow.h" +#include "viktreeview.h" +#include "vikviewport.h" + +G_BEGIN_DECLS + #define VIK_LAYER_TYPE (vik_layer_get_type ()) #define VIK_LAYER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), VIK_LAYER_TYPE, VikLayer)) #define VIK_LAYER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), VIK_LAYER_TYPE, VikLayerClass)) @@ -46,94 +56,59 @@ struct _VikLayer { gboolean visible; gboolean realized; - VikTreeview *vt; /* simply a refernce */ + VikViewport *vvp;/* simply a reference */ + VikTreeview *vt; /* simply a reference */ GtkTreeIter iter; /* for explicit "polymorphism" (function type switching) */ - guint16 type; -}; - - - -enum { -VIK_LAYER_AGGREGATE = 0, -VIK_LAYER_TRW, -VIK_LAYER_COORD, -VIK_LAYER_GEOREF, -VIK_LAYER_MAPS, -VIK_LAYER_NUM_TYPES + VikLayerTypeEnum type; }; -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 } - VikLayerToolFuncStatus; -typedef VikLayerToolFuncStatus (*VikToolInterfaceFunc) (VikLayer *,GdkEventButton *,gpointer); - -/* gpointer is viewport */ +/* 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, + 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); +typedef VikLayerToolFuncStatus (*VikToolMouseMoveFunc) (VikLayer *, GdkEventMotion *, gpointer); +typedef void (*VikToolActivationFunc) (VikLayer *, gpointer); +typedef gboolean (*VikToolKeyFunc) (VikLayer *, GdkEventKey *, gpointer); typedef struct _VikToolInterface VikToolInterface; struct _VikToolInterface { - gchar *name; - VikToolInterfaceFunc callback; - VikToolInterfaceFunc callback_release; + GtkRadioActionEntry radioActionEntry; + VikToolConstructorFunc create; + VikToolDestructorFunc destroy; + VikToolActivationFunc activate; + VikToolActivationFunc deactivate; + VikToolMouseFunc click; + VikToolMouseMoveFunc move; + VikToolMouseFunc release; + VikToolKeyFunc key_press; /* return FALSE if we don't use the key press -- should return FALSE most of the time if we want any shortcuts / UI keybindings to work! use sparingly. */ + gboolean pan_handler; // Call click & release funtions even when 'Pan Mode' is on + GdkCursorType cursor_type; + const GdkPixdata *cursor_data; + const GdkCursor *cursor; }; /* 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 */ @@ -147,37 +122,53 @@ 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() */ -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 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 (*VikLayerFuncAddMenuItems) (VikLayer *,GtkMenu *,gpointer); /* gpointer is a VikLayersPanel */ typedef gboolean (*VikLayerFuncSublayerAddMenuItems) (VikLayer *,GtkMenu *,gpointer, /* first gpointer is a VikLayersPanel */ - gint,gpointer,GtkTreeIter *); + gint,gpointer,GtkTreeIter *,VikViewport *); 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 gboolean (*VikLayerFuncLayerSelected) (VikLayer *,gint,gpointer,gint,gpointer); /* 2nd gpointer is a VikLayersPanel */ -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 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 - (*VikLayerFuncGetParam) (VikLayer *, guint16); + (*VikLayerFuncGetParam) (VikLayer *, guint16, gboolean); + +typedef void (*VikLayerFuncChangeParam) (GtkWidget *, ui_change_values ); -typedef void (*VikLayerFuncReadFileData) (VikLayer *, FILE *); +typedef gboolean (*VikLayerFuncReadFileData) (VikLayer *, FILE *, const gchar *); // gchar* is the directory path. Function should report success or failure typedef void (*VikLayerFuncWriteFileData) (VikLayer *, FILE *); -typedef gpointer (*VikLayerFuncCopyItem) (VikLayer *, gint, gpointer); -typedef gboolean (*VikLayerFuncPasteItem) (VikLayer *, gint, gpointer); +/* 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 (*VikLayerFuncFreeCopiedItem) (gint, gpointer); /* treeview drag and drop method. called on the destination layer. it is given a source and destination layer, @@ -185,12 +176,29 @@ typedef void (*VikLayerFuncFreeCopiedItem) (gint, gpointer); */ typedef void (*VikLayerFuncDragDropRequest) (VikLayer *, VikLayer *, GtkTreeIter *, GtkTreePath *); +typedef gboolean (*VikLayerFuncSelectClick) (VikLayer *, GdkEventButton *, VikViewport *, tool_ed_t*); +typedef gboolean (*VikLayerFuncSelectMove) (VikLayer *, GdkEventMotion *, VikViewport *, tool_ed_t*); +typedef gboolean (*VikLayerFuncSelectRelease) (VikLayer *, GdkEventButton *, VikViewport *, tool_ed_t*); +typedef gboolean (*VikLayerFuncSelectedViewportMenu) (VikLayer *, GdkEventButton *, VikViewport *); + +typedef time_t (*VikLayerFuncGetTimestamp) (VikLayer *); + +typedef enum { + VIK_MENU_ITEM_PROPERTY=1, + VIK_MENU_ITEM_CUT=2, + VIK_MENU_ITEM_COPY=4, + VIK_MENU_ITEM_PASTE=8, + VIK_MENU_ITEM_DELETE=16, + VIK_MENU_ITEM_ALL=0xff +} VikStdLayerMenuItem; typedef struct _VikLayerInterface VikLayerInterface; /* See vik_layer_* for function parameter names */ struct _VikLayerInterface { - const gchar * name; + const gchar * fixed_layer_name; // Used in .vik files - this should never change to maintain file compatibility + const gchar * name; // Translate-able name used for display purposes + const gchar * accelerator; const GdkPixdata * icon; VikToolInterface * tools; @@ -202,6 +210,9 @@ struct _VikLayerInterface { gchar ** params_groups; guint8 params_groups_count; + /* menu items to be created */ + VikStdLayerMenuItem menu_items_selection; + VikLayerFuncCreate create; VikLayerFuncRealize realize; VikLayerFuncPostRead post_read; @@ -211,58 +222,109 @@ struct _VikLayerInterface { VikLayerFuncDraw draw; VikLayerFuncChangeCoordMode change_coord_mode; + VikLayerFuncGetTimestamp get_timestamp; + + VikLayerFuncSetMenuItemsSelection set_menu_selection; + VikLayerFuncGetMenuItemsSelection get_menu_selection; + VikLayerFuncAddMenuItems add_menu_items; VikLayerFuncSublayerAddMenuItems sublayer_add_menu_items; VikLayerFuncSublayerRenameRequest sublayer_rename_request; VikLayerFuncSublayerToggleVisible sublayer_toggle_visible; + VikLayerFuncSublayerTooltip sublayer_tooltip; + VikLayerFuncLayerTooltip layer_tooltip; + VikLayerFuncLayerSelected layer_selected; - VikLayerFuncCopy copy; + VikLayerFuncMarshall marshall; + VikLayerFuncUnmarshall unmarshall; /* for I/O */ VikLayerFuncSetParam set_param; VikLayerFuncGetParam get_param; + VikLayerFuncChangeParam change_param; /* for I/O -- extra non-param data like TrwLayer data */ VikLayerFuncReadFileData read_file_data; VikLayerFuncWriteFileData write_file_data; + VikLayerFuncDeleteItem delete_item; + VikLayerFuncCutItem cut_item; VikLayerFuncCopyItem copy_item; VikLayerFuncPasteItem paste_item; VikLayerFuncFreeCopiedItem free_copied_item; VikLayerFuncDragDropRequest drag_drop_request; + + VikLayerFuncSelectClick select_click; + VikLayerFuncSelectMove select_move; + VikLayerFuncSelectRelease select_release; + VikLayerFuncSelectedViewportMenu show_viewport_menu; }; -VikLayerInterface *vik_layer_get_interface ( gint type ); +VikLayerInterface *vik_layer_get_interface ( VikLayerTypeEnum type ); -void vik_layer_init ( VikLayer *vl, gint type ); -void vik_layer_draw ( VikLayer *l, gpointer data ); +void vik_layer_set_type ( VikLayer *vl, VikLayerTypeEnum type ); +void vik_layer_draw ( VikLayer *l, VikViewport *vp ); 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 ); + +time_t vik_layer_get_timestamp ( VikLayer *vl ); -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_set_defaults ( VikLayer *vl, VikViewport *vvp ); void vik_layer_emit_update ( VikLayer *vl ); /* GUI */ +void vik_layer_set_menu_items_selection(VikLayer *l, guint16 selection); +guint16 vik_layer_get_menu_items_selection(VikLayer *l); void vik_layer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp ); -VikLayer *vik_layer_create ( gint type, gpointer vp, GtkWindow *w, gboolean interactive ); -gboolean vik_layer_properties ( VikLayer *layer, gpointer vp ); +VikLayer *vik_layer_create ( VikLayerTypeEnum type, VikViewport *vp, gboolean interactive ); +gboolean vik_layer_properties ( VikLayer *layer, VikViewport *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, VikViewport *vvp ); VikLayer *vik_layer_copy ( VikLayer *vl, gpointer vp ); +void vik_layer_marshall ( VikLayer *vl, guint8 **data, gint *len ); +VikLayer *vik_layer_unmarshall ( guint8 *data, gint len, VikViewport *vvp ); +void vik_layer_marshall_params ( VikLayer *vl, guint8 **data, gint *len ); +void vik_layer_unmarshall_params ( VikLayer *vl, guint8 *data, gint len, VikViewport *vvp ); const gchar *vik_layer_sublayer_rename_request ( VikLayer *l, const gchar *newname, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter ); 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 ); + +gboolean vik_layer_selected ( VikLayer *l, gint subtype, gpointer sublayer, gint type, gpointer vlp ); + /* TODO: put in layerspanel */ -GdkPixbuf *vik_layer_load_icon ( gint type ); +GdkPixbuf *vik_layer_load_icon ( VikLayerTypeEnum 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 ); + +VikLayerTypeEnum vik_layer_type_from_string ( const gchar *str ); + +typedef struct { + VikLayerParamData data; + VikLayerParamType type; +} VikLayerTypedParamData; + +void vik_layer_typed_param_data_free ( gpointer gp ); +VikLayerTypedParamData *vik_layer_typed_param_data_copy_from_data ( VikLayerParamType type, VikLayerParamData val ); +VikLayerTypedParamData *vik_layer_data_typed_param_copy_from_string ( VikLayerParamType type, const gchar *str ); + +G_END_DECLS #endif