2 * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
4 * Copyright (C) 2003-2005, 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_LAYER_H
22 #define _VIKING_LAYER_H
27 #include <gdk-pixbuf/gdk-pixdata.h>
29 #include "uibuilder.h"
30 #include "vikwindow.h"
31 #include "viktreeview.h"
32 #include "vikviewport.h"
36 #define VIK_LAYER_TYPE (vik_layer_get_type ())
37 #define VIK_LAYER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), VIK_LAYER_TYPE, VikLayer))
38 #define VIK_LAYER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), VIK_LAYER_TYPE, VikLayerClass))
39 #define IS_VIK_LAYER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), VIK_LAYER_TYPE))
40 #define IS_VIK_LAYER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), VIK_LAYER_TYPE))
42 typedef struct _VikLayer VikLayer;
43 typedef struct _VikLayerClass VikLayerClass;
47 GObjectClass object_class;
48 void (* update) (VikLayer *vl);
51 GType vik_layer_get_type ();
59 VikTreeview *vt; /* simply a reference */
62 /* for explicit "polymorphism" (function type switching) */
63 VikLayerTypeEnum type;
66 /* I think most of these are ignored,
67 * returning GRAB_FOCUS grabs the focus for mouse move,
68 * mouse click, release always grabs focus. Focus allows key presses
70 * It used to be that, if ignored, Viking could look for other layers.
71 * this was useful for clicking a way/trackpoint in any layer,
72 * if no layer was selected (find way/trackpoint)
75 VIK_LAYER_TOOL_IGNORED=0,
77 VIK_LAYER_TOOL_ACK_REDRAW_ABOVE,
78 VIK_LAYER_TOOL_ACK_REDRAW_ALL,
79 VIK_LAYER_TOOL_ACK_REDRAW_IF_VISIBLE,
80 VIK_LAYER_TOOL_ACK_GRAB_FOCUS, /* only for move */
81 } VikLayerToolFuncStatus;
83 /* gpointer is tool-specific state created in the constructor */
84 typedef gpointer (*VikToolConstructorFunc) (VikWindow *, VikViewport *);
85 typedef void (*VikToolDestructorFunc) (gpointer);
86 typedef VikLayerToolFuncStatus (*VikToolMouseFunc) (VikLayer *, GdkEventButton *, gpointer);
87 typedef VikLayerToolFuncStatus (*VikToolMouseMoveFunc) (VikLayer *, GdkEventMotion *, gpointer);
88 typedef void (*VikToolActivationFunc) (VikLayer *, gpointer);
89 typedef gboolean (*VikToolKeyFunc) (VikLayer *, GdkEventKey *, gpointer);
91 typedef struct _VikToolInterface VikToolInterface;
92 struct _VikToolInterface {
93 GtkRadioActionEntry radioActionEntry;
94 VikToolConstructorFunc create;
95 VikToolDestructorFunc destroy;
96 VikToolActivationFunc activate;
97 VikToolActivationFunc deactivate;
98 VikToolMouseFunc click;
99 VikToolMouseMoveFunc move;
100 VikToolMouseFunc release;
101 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. */
102 gboolean pan_handler; // Call click & release funtions even when 'Pan Mode' is on
103 GdkCursorType cursor_type;
104 const GdkPixdata *cursor_data;
105 const GdkCursor *cursor;
108 /* Parameters (for I/O and Properties) */
109 /* --> moved to uibuilder.h */
112 /* layer interface functions */
114 /* Create a new layer of a certain type. Should be filled with defaults */
115 typedef VikLayer * (*VikLayerFuncCreate) (VikViewport *);
117 /* normally only needed for layers with sublayers. This is called when they
118 * are added to the treeview so they can add sublayers to the treeview. */
119 typedef void (*VikLayerFuncRealize) (VikLayer *,VikTreeview *,GtkTreeIter *);
121 /* rarely used, this is called after a read operation or properties box is run.
122 * usually used to create GC's that depend on params,
123 * but GC's can also be created from create() or set_param() */
124 typedef void (*VikLayerFuncPostRead) (VikLayer *,VikViewport *vp,gboolean from_file);
126 typedef void (*VikLayerFuncFree) (VikLayer *);
128 /* do _not_ use this unless absolutely neccesary. Use the dynamic properties (see coordlayer for example)
129 * returns TRUE if OK was pressed */
130 typedef gboolean (*VikLayerFuncProperties) (VikLayer *,VikViewport *);
132 typedef void (*VikLayerFuncDraw) (VikLayer *,VikViewport *);
133 typedef void (*VikLayerFuncChangeCoordMode) (VikLayer *,VikCoordMode);
135 typedef void (*VikLayerFuncSetMenuItemsSelection) (VikLayer *,guint16);
136 typedef guint16 (*VikLayerFuncGetMenuItemsSelection) (VikLayer *);
138 typedef void (*VikLayerFuncAddMenuItems) (VikLayer *,GtkMenu *,gpointer); /* gpointer is a VikLayersPanel */
139 typedef gboolean (*VikLayerFuncSublayerAddMenuItems) (VikLayer *,GtkMenu *,gpointer, /* first gpointer is a VikLayersPanel */
140 gint,gpointer,GtkTreeIter *,VikViewport *);
141 typedef const gchar * (*VikLayerFuncSublayerRenameRequest) (VikLayer *,const gchar *,gpointer,
142 gint,VikViewport *,GtkTreeIter *); /* first gpointer is a VikLayersPanel */
143 typedef gboolean (*VikLayerFuncSublayerToggleVisible) (VikLayer *,gint,gpointer);
144 typedef const gchar * (*VikLayerFuncSublayerTooltip) (VikLayer *,gint,gpointer);
145 typedef const gchar * (*VikLayerFuncLayerTooltip) (VikLayer *);
146 typedef gboolean (*VikLayerFuncLayerSelected) (VikLayer *,gint,gpointer,gint,gpointer); /* 2nd gpointer is a VikLayersPanel */
148 typedef void (*VikLayerFuncMarshall) (VikLayer *, guint8 **, gint *);
149 typedef VikLayer * (*VikLayerFuncUnmarshall) (guint8 *, gint, VikViewport *);
151 /* returns TRUE if needs to redraw due to changed param */
152 /* in parameter gboolean denotes if for file I/O, as opposed to display/cut/copy etc... operations */
153 typedef gboolean (*VikLayerFuncSetParam) (VikLayer *, guint16, VikLayerParamData, VikViewport *, gboolean);
155 /* in parameter gboolean denotes if for file I/O, as opposed to display/cut/copy etc... operations */
156 typedef VikLayerParamData
157 (*VikLayerFuncGetParam) (VikLayer *, guint16, gboolean);
159 typedef gboolean (*VikLayerFuncReadFileData) (VikLayer *, FILE *); // Should report success or failure
160 typedef void (*VikLayerFuncWriteFileData) (VikLayer *, FILE *);
162 /* item manipulation */
163 typedef void (*VikLayerFuncDeleteItem) (VikLayer *, gint, gpointer);
164 /* layer, subtype, pointer to sub-item */
165 typedef void (*VikLayerFuncCutItem) (VikLayer *, gint, gpointer);
166 typedef void (*VikLayerFuncCopyItem) (VikLayer *, gint, gpointer, guint8 **, guint *);
167 /* layer, subtype, pointer to sub-item, return pointer, return len */
168 typedef gboolean (*VikLayerFuncPasteItem) (VikLayer *, gint, guint8 *, guint);
169 typedef void (*VikLayerFuncFreeCopiedItem) (gint, gpointer);
171 /* treeview drag and drop method. called on the destination layer. it is given a source and destination layer,
172 * and the source and destination iters in the treeview.
174 typedef void (*VikLayerFuncDragDropRequest) (VikLayer *, VikLayer *, GtkTreeIter *, GtkTreePath *);
176 typedef gboolean (*VikLayerFuncSelectClick) (VikLayer *, GdkEventButton *, VikViewport *, tool_ed_t*);
177 typedef gboolean (*VikLayerFuncSelectMove) (VikLayer *, GdkEventButton *, VikViewport *, tool_ed_t*);
178 typedef gboolean (*VikLayerFuncSelectRelease) (VikLayer *, GdkEventButton *, VikViewport *, tool_ed_t*);
179 typedef gboolean (*VikLayerFuncSelectedViewportMenu) (VikLayer *, GdkEventButton *, VikViewport *);
182 VIK_MENU_ITEM_PROPERTY=1,
184 VIK_MENU_ITEM_COPY=4,
185 VIK_MENU_ITEM_PASTE=8,
186 VIK_MENU_ITEM_DELETE=16,
187 VIK_MENU_ITEM_ALL=0xff
188 } VikStdLayerMenuItem;
190 typedef struct _VikLayerInterface VikLayerInterface;
192 /* See vik_layer_* for function parameter names */
193 struct _VikLayerInterface {
194 const gchar * fixed_layer_name; // Used in .vik files - this should never change to maintain file compatibility
195 const gchar * name; // Translate-able name used for display purposes
196 const gchar * accelerator;
197 const GdkPixdata * icon;
199 VikToolInterface * tools;
202 /* for I/O reading to and from .vik files -- params like coordline width, color, etc. */
203 VikLayerParam * params;
204 guint16 params_count;
205 gchar ** params_groups;
206 guint8 params_groups_count;
208 /* menu items to be created */
209 VikStdLayerMenuItem menu_items_selection;
211 VikLayerFuncCreate create;
212 VikLayerFuncRealize realize;
213 VikLayerFuncPostRead post_read;
214 VikLayerFuncFree free;
216 VikLayerFuncProperties properties;
217 VikLayerFuncDraw draw;
218 VikLayerFuncChangeCoordMode change_coord_mode;
220 VikLayerFuncSetMenuItemsSelection set_menu_selection;
221 VikLayerFuncGetMenuItemsSelection get_menu_selection;
223 VikLayerFuncAddMenuItems add_menu_items;
224 VikLayerFuncSublayerAddMenuItems sublayer_add_menu_items;
225 VikLayerFuncSublayerRenameRequest sublayer_rename_request;
226 VikLayerFuncSublayerToggleVisible sublayer_toggle_visible;
227 VikLayerFuncSublayerTooltip sublayer_tooltip;
228 VikLayerFuncLayerTooltip layer_tooltip;
229 VikLayerFuncLayerSelected layer_selected;
231 VikLayerFuncMarshall marshall;
232 VikLayerFuncUnmarshall unmarshall;
235 VikLayerFuncSetParam set_param;
236 VikLayerFuncGetParam get_param;
238 /* for I/O -- extra non-param data like TrwLayer data */
239 VikLayerFuncReadFileData read_file_data;
240 VikLayerFuncWriteFileData write_file_data;
242 VikLayerFuncDeleteItem delete_item;
243 VikLayerFuncCutItem cut_item;
244 VikLayerFuncCopyItem copy_item;
245 VikLayerFuncPasteItem paste_item;
246 VikLayerFuncFreeCopiedItem free_copied_item;
248 VikLayerFuncDragDropRequest drag_drop_request;
250 VikLayerFuncSelectClick select_click;
251 VikLayerFuncSelectMove select_move;
252 VikLayerFuncSelectRelease select_release;
253 VikLayerFuncSelectedViewportMenu show_viewport_menu;
256 VikLayerInterface *vik_layer_get_interface ( VikLayerTypeEnum type );
259 void vik_layer_set_type ( VikLayer *vl, VikLayerTypeEnum type );
260 void vik_layer_draw ( VikLayer *l, gpointer data );
261 void vik_layer_change_coord_mode ( VikLayer *l, VikCoordMode mode );
262 void vik_layer_rename ( VikLayer *l, const gchar *new_name );
263 void vik_layer_rename_no_copy ( VikLayer *l, gchar *new_name );
264 const gchar *vik_layer_get_name ( VikLayer *l );
266 gboolean vik_layer_set_param (VikLayer *layer, guint16 id, VikLayerParamData data, gpointer vp, gboolean is_file_operation);
268 void vik_layer_set_defaults ( VikLayer *vl, VikViewport *vvp );
270 void vik_layer_emit_update ( VikLayer *vl );
273 void vik_layer_set_menu_items_selection(VikLayer *l, guint16 selection);
274 guint16 vik_layer_get_menu_items_selection(VikLayer *l);
275 void vik_layer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp );
276 VikLayer *vik_layer_create ( VikLayerTypeEnum type, gpointer vp, GtkWindow *w, gboolean interactive );
277 gboolean vik_layer_properties ( VikLayer *layer, gpointer vp );
279 void vik_layer_realize ( VikLayer *l, VikTreeview *vt, GtkTreeIter * layer_iter );
280 void vik_layer_post_read ( VikLayer *layer, VikViewport *vp, gboolean from_file );
282 gboolean vik_layer_sublayer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter, VikViewport *vvp );
284 VikLayer *vik_layer_copy ( VikLayer *vl, gpointer vp );
285 void vik_layer_marshall ( VikLayer *vl, guint8 **data, gint *len );
286 VikLayer *vik_layer_unmarshall ( guint8 *data, gint len, VikViewport *vvp );
287 void vik_layer_marshall_params ( VikLayer *vl, guint8 **data, gint *len );
288 void vik_layer_unmarshall_params ( VikLayer *vl, guint8 *data, gint len, VikViewport *vvp );
290 const gchar *vik_layer_sublayer_rename_request ( VikLayer *l, const gchar *newname, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter );
292 gboolean vik_layer_sublayer_toggle_visible ( VikLayer *l, gint subtype, gpointer sublayer );
294 const gchar* vik_layer_sublayer_tooltip ( VikLayer *l, gint subtype, gpointer sublayer );
296 const gchar* vik_layer_layer_tooltip ( VikLayer *l );
298 gboolean vik_layer_selected ( VikLayer *l, gint subtype, gpointer sublayer, gint type, gpointer vlp );
300 /* TODO: put in layerspanel */
301 GdkPixbuf *vik_layer_load_icon ( VikLayerTypeEnum type );
303 VikLayer *vik_layer_get_and_reset_trigger();
304 void vik_layer_emit_update_secondary ( VikLayer *vl ); /* to be called by aggregate layer only. doesn't set the trigger */
305 void vik_layer_emit_update_although_invisible ( VikLayer *vl );
307 VikLayerTypeEnum vik_layer_type_from_string ( const gchar *str );
310 VikLayerParamData data;
311 VikLayerParamType type;
312 } VikLayerTypedParamData;
314 void vik_layer_typed_param_data_free ( gpointer gp );
315 VikLayerTypedParamData *vik_layer_typed_param_data_copy_from_data ( VikLayerParamType type, VikLayerParamData val );
316 VikLayerTypedParamData *vik_layer_data_typed_param_copy_from_string ( VikLayerParamType type, const gchar *str );