]>
Commit | Line | Data |
---|---|---|
50a14534 EB |
1 | /* |
2 | * viking -- GPS Data and Topo Analyzer, Explorer, and Manager | |
3 | * | |
4 | * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net> | |
5 | * | |
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. | |
10 | * | |
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. | |
15 | * | |
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 | |
19 | * | |
20 | */ | |
a25c4c50 GB |
21 | #ifndef _VIKING_LAYER_H |
22 | #define _VIKING_LAYER_H | |
23 | ||
e4afc73a | 24 | #include <stdio.h> |
a25c4c50 GB |
25 | #include <glib.h> |
26 | #include <gtk/gtk.h> | |
27 | #include <gdk-pixbuf/gdk-pixdata.h> | |
50a14534 | 28 | |
28c82d8b | 29 | #include "uibuilder.h" |
cdcaf41c | 30 | #include "vikwindow.h" |
a25c4c50 GB |
31 | #include "viktreeview.h" |
32 | #include "vikviewport.h" | |
50a14534 | 33 | |
722b5481 RN |
34 | G_BEGIN_DECLS |
35 | ||
50a14534 EB |
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)) | |
41 | ||
369e959a | 42 | typedef struct _VikLayer VikLayer; |
50a14534 EB |
43 | typedef struct _VikLayerClass VikLayerClass; |
44 | ||
45 | struct _VikLayerClass | |
46 | { | |
47 | GObjectClass object_class; | |
48 | void (* update) (VikLayer *vl); | |
49 | }; | |
50 | ||
51 | GType vik_layer_get_type (); | |
52 | ||
53 | struct _VikLayer { | |
54 | GObject obj; | |
55 | gchar *name; | |
56 | gboolean visible; | |
57 | ||
58 | gboolean realized; | |
94933cb8 | 59 | VikTreeview *vt; /* simply a reference */ |
50a14534 EB |
60 | GtkTreeIter iter; |
61 | ||
62 | /* for explicit "polymorphism" (function type switching) */ | |
63 | guint16 type; | |
64 | }; | |
65 | ||
66 | ||
67 | ||
68 | enum { | |
941aa6e9 AF |
69 | VIK_LAYER_AGGREGATE = 0, |
70 | VIK_LAYER_TRW, | |
71 | VIK_LAYER_COORD, | |
72 | VIK_LAYER_GEOREF, | |
b364d6bc | 73 | VIK_LAYER_GPS, |
941aa6e9 | 74 | VIK_LAYER_MAPS, |
ad0a8c2d | 75 | VIK_LAYER_DEM, |
941aa6e9 | 76 | VIK_LAYER_NUM_TYPES |
50a14534 EB |
77 | }; |
78 | ||
165d30aa EB |
79 | /* I think most of these are ignored, |
80 | * returning GRAB_FOCUS grabs the focus for mouse move, | |
81 | * mouse click, release always grabs focus. Focus allows key presses | |
82 | * to be handled. | |
83 | * It used to be that, if ignored, Viking could look for other layers. | |
84 | * this was useful for clicking a way/trackpoint in any layer, | |
85 | * if no layer was selected (find way/trackpoint) | |
86 | */ | |
941aa6e9 AF |
87 | typedef enum { |
88 | VIK_LAYER_TOOL_IGNORED=0, | |
89 | VIK_LAYER_TOOL_ACK, | |
90 | VIK_LAYER_TOOL_ACK_REDRAW_ABOVE, | |
91 | VIK_LAYER_TOOL_ACK_REDRAW_ALL, | |
165d30aa EB |
92 | VIK_LAYER_TOOL_ACK_REDRAW_IF_VISIBLE, |
93 | VIK_LAYER_TOOL_ACK_GRAB_FOCUS, /* only for move */ | |
941aa6e9 | 94 | } VikLayerToolFuncStatus; |
50a14534 | 95 | |
941aa6e9 AF |
96 | /* gpointer is tool-specific state created in the constructor */ |
97 | typedef gpointer (*VikToolConstructorFunc) (VikWindow *, VikViewport *); | |
98 | typedef void (*VikToolDestructorFunc) (gpointer); | |
99 | typedef VikLayerToolFuncStatus (*VikToolMouseFunc) (VikLayer *, GdkEventButton *, gpointer); | |
dc2c040e | 100 | typedef VikLayerToolFuncStatus (*VikToolMouseMoveFunc) (VikLayer *, GdkEventMotion *, gpointer); |
941aa6e9 | 101 | typedef void (*VikToolActivationFunc) (VikLayer *, gpointer); |
777e2d4d | 102 | typedef gboolean (*VikToolKeyFunc) (VikLayer *, GdkEventKey *, gpointer); |
50a14534 EB |
103 | |
104 | typedef struct _VikToolInterface VikToolInterface; | |
105 | struct _VikToolInterface { | |
79dce0cb | 106 | GtkRadioActionEntry radioActionEntry; |
941aa6e9 AF |
107 | VikToolConstructorFunc create; |
108 | VikToolDestructorFunc destroy; | |
109 | VikToolActivationFunc activate; | |
110 | VikToolActivationFunc deactivate; | |
111 | VikToolMouseFunc click; | |
dc2c040e | 112 | VikToolMouseMoveFunc move; |
941aa6e9 | 113 | VikToolMouseFunc release; |
61a9fb73 | 114 | 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. */ |
ef5e8132 | 115 | gboolean pan_handler; // Call click & release funtions even when 'Pan Mode' is on |
f2f2f7bf GB |
116 | GdkCursorType cursor_type; |
117 | const GdkPixdata *cursor_data; | |
118 | const GdkCursor *cursor; | |
50a14534 EB |
119 | }; |
120 | ||
121 | /* Parameters (for I/O and Properties) */ | |
28c82d8b | 122 | /* --> moved to uibuilder.h */ |
50a14534 | 123 | |
50a14534 EB |
124 | |
125 | /* layer interface functions */ | |
126 | ||
127 | /* Create a new layer of a certain type. Should be filled with defaults */ | |
128 | typedef VikLayer * (*VikLayerFuncCreate) (VikViewport *); | |
129 | ||
130 | /* normally only needed for layers with sublayers. This is called when they | |
131 | * are added to the treeview so they can add sublayers to the treeview. */ | |
132 | typedef void (*VikLayerFuncRealize) (VikLayer *,VikTreeview *,GtkTreeIter *); | |
133 | ||
134 | /* rarely used, this is called after a read operation or properties box is run. | |
135 | * usually used to create GC's that depend on params, | |
136 | * but GC's can also be created from create() or set_param() */ | |
07059501 | 137 | typedef void (*VikLayerFuncPostRead) (VikLayer *,VikViewport *vp,gboolean from_file); |
50a14534 EB |
138 | |
139 | typedef void (*VikLayerFuncFree) (VikLayer *); | |
140 | ||
141 | /* do _not_ use this unless absolutely neccesary. Use the dynamic properties (see coordlayer for example) | |
142 | * returns TRUE if OK was pressed */ | |
07059501 | 143 | typedef gboolean (*VikLayerFuncProperties) (VikLayer *,VikViewport *); |
50a14534 EB |
144 | |
145 | typedef void (*VikLayerFuncDraw) (VikLayer *,VikViewport *); | |
146 | typedef void (*VikLayerFuncChangeCoordMode) (VikLayer *,VikCoordMode); | |
147 | ||
20c7a3a0 QT |
148 | typedef void (*VikLayerFuncSetMenuItemsSelection) (VikLayer *,guint16); |
149 | typedef guint16 (*VikLayerFuncGetMenuItemsSelection) (VikLayer *); | |
9da7faf2 | 150 | |
50a14534 EB |
151 | typedef void (*VikLayerFuncAddMenuItems) (VikLayer *,GtkMenu *,gpointer); /* gpointer is a VikLayersPanel */ |
152 | typedef gboolean (*VikLayerFuncSublayerAddMenuItems) (VikLayer *,GtkMenu *,gpointer, /* first gpointer is a VikLayersPanel */ | |
50eadc64 | 153 | gint,gpointer,GtkTreeIter *,VikViewport *); |
50a14534 EB |
154 | typedef const gchar * (*VikLayerFuncSublayerRenameRequest) (VikLayer *,const gchar *,gpointer, |
155 | gint,VikViewport *,GtkTreeIter *); /* first gpointer is a VikLayersPanel */ | |
156 | typedef gboolean (*VikLayerFuncSublayerToggleVisible) (VikLayer *,gint,gpointer); | |
9da7faf2 | 157 | typedef const gchar * (*VikLayerFuncSublayerTooltip) (VikLayer *,gint,gpointer); |
1e8b7f57 | 158 | typedef const gchar * (*VikLayerFuncLayerTooltip) (VikLayer *); |
a5dcfdb7 | 159 | typedef gboolean (*VikLayerFuncLayerSelected) (VikLayer *,gint,gpointer,gint,gpointer); /* 2nd gpointer is a VikLayersPanel */ |
50a14534 | 160 | |
911400b5 AF |
161 | typedef void (*VikLayerFuncMarshall) (VikLayer *, guint8 **, gint *); |
162 | typedef VikLayer * (*VikLayerFuncUnmarshall) (guint8 *, gint, VikViewport *); | |
50a14534 EB |
163 | |
164 | /* returns TRUE if needs to redraw due to changed param */ | |
158b3642 RN |
165 | /* in parameter gboolean denotes if for file I/O, as opposed to display/cut/copy etc... operations */ |
166 | typedef gboolean (*VikLayerFuncSetParam) (VikLayer *, guint16, VikLayerParamData, VikViewport *, gboolean); | |
50a14534 | 167 | |
158b3642 | 168 | /* in parameter gboolean denotes if for file I/O, as opposed to display/cut/copy etc... operations */ |
50a14534 | 169 | typedef VikLayerParamData |
158b3642 | 170 | (*VikLayerFuncGetParam) (VikLayer *, guint16, gboolean); |
50a14534 | 171 | |
119ada4c | 172 | typedef gboolean (*VikLayerFuncReadFileData) (VikLayer *, FILE *); // Should report success or failure |
50a14534 EB |
173 | typedef void (*VikLayerFuncWriteFileData) (VikLayer *, FILE *); |
174 | ||
33534cd8 AF |
175 | /* item manipulation */ |
176 | typedef void (*VikLayerFuncDeleteItem) (VikLayer *, gint, gpointer); | |
177 | /* layer, subtype, pointer to sub-item */ | |
d5874ef9 | 178 | typedef void (*VikLayerFuncCutItem) (VikLayer *, gint, gpointer); |
ddc47a46 | 179 | typedef void (*VikLayerFuncCopyItem) (VikLayer *, gint, gpointer, guint8 **, guint *); |
33534cd8 | 180 | /* layer, subtype, pointer to sub-item, return pointer, return len */ |
ddc47a46 | 181 | typedef gboolean (*VikLayerFuncPasteItem) (VikLayer *, gint, guint8 *, guint); |
50a14534 EB |
182 | typedef void (*VikLayerFuncFreeCopiedItem) (gint, gpointer); |
183 | ||
70a23263 AF |
184 | /* treeview drag and drop method. called on the destination layer. it is given a source and destination layer, |
185 | * and the source and destination iters in the treeview. | |
186 | */ | |
187 | typedef void (*VikLayerFuncDragDropRequest) (VikLayer *, VikLayer *, GtkTreeIter *, GtkTreePath *); | |
188 | ||
08f14055 RN |
189 | typedef gboolean (*VikLayerFuncSelectClick) (VikLayer *, GdkEventButton *, VikViewport *, tool_ed_t*); |
190 | typedef gboolean (*VikLayerFuncSelectMove) (VikLayer *, GdkEventButton *, VikViewport *, tool_ed_t*); | |
191 | typedef gboolean (*VikLayerFuncSelectRelease) (VikLayer *, GdkEventButton *, VikViewport *, tool_ed_t*); | |
e46f259a | 192 | typedef gboolean (*VikLayerFuncSelectedViewportMenu) (VikLayer *, GdkEventButton *, VikViewport *); |
77ad64fa | 193 | |
5a4a28bf QT |
194 | typedef enum { |
195 | VIK_MENU_ITEM_PROPERTY=1, | |
196 | VIK_MENU_ITEM_CUT=2, | |
197 | VIK_MENU_ITEM_COPY=4, | |
198 | VIK_MENU_ITEM_PASTE=8, | |
199 | VIK_MENU_ITEM_DELETE=16, | |
200 | VIK_MENU_ITEM_ALL=0xff | |
201 | } VikStdLayerMenuItem; | |
50a14534 EB |
202 | |
203 | typedef struct _VikLayerInterface VikLayerInterface; | |
204 | ||
205 | /* See vik_layer_* for function parameter names */ | |
206 | struct _VikLayerInterface { | |
db386630 RN |
207 | const gchar * fixed_layer_name; // Used in .vik files - this should never change to maintain file compatibility |
208 | const gchar * name; // Translate-able name used for display purposes | |
75078768 | 209 | const gchar * accelerator; |
50a14534 EB |
210 | const GdkPixdata * icon; |
211 | ||
212 | VikToolInterface * tools; | |
213 | guint16 tools_count; | |
214 | ||
215 | /* for I/O reading to and from .vik files -- params like coordline width, color, etc. */ | |
216 | VikLayerParam * params; | |
217 | guint16 params_count; | |
218 | gchar ** params_groups; | |
219 | guint8 params_groups_count; | |
220 | ||
5a4a28bf QT |
221 | /* menu items to be created */ |
222 | VikStdLayerMenuItem menu_items_selection; | |
223 | ||
50a14534 EB |
224 | VikLayerFuncCreate create; |
225 | VikLayerFuncRealize realize; | |
226 | VikLayerFuncPostRead post_read; | |
227 | VikLayerFuncFree free; | |
228 | ||
229 | VikLayerFuncProperties properties; | |
230 | VikLayerFuncDraw draw; | |
231 | VikLayerFuncChangeCoordMode change_coord_mode; | |
232 | ||
20c7a3a0 QT |
233 | VikLayerFuncSetMenuItemsSelection set_menu_selection; |
234 | VikLayerFuncGetMenuItemsSelection get_menu_selection; | |
235 | ||
50a14534 EB |
236 | VikLayerFuncAddMenuItems add_menu_items; |
237 | VikLayerFuncSublayerAddMenuItems sublayer_add_menu_items; | |
238 | VikLayerFuncSublayerRenameRequest sublayer_rename_request; | |
239 | VikLayerFuncSublayerToggleVisible sublayer_toggle_visible; | |
9da7faf2 | 240 | VikLayerFuncSublayerTooltip sublayer_tooltip; |
1e8b7f57 | 241 | VikLayerFuncLayerTooltip layer_tooltip; |
a5dcfdb7 | 242 | VikLayerFuncLayerSelected layer_selected; |
50a14534 | 243 | |
911400b5 AF |
244 | VikLayerFuncMarshall marshall; |
245 | VikLayerFuncUnmarshall unmarshall; | |
50a14534 EB |
246 | |
247 | /* for I/O */ | |
248 | VikLayerFuncSetParam set_param; | |
249 | VikLayerFuncGetParam get_param; | |
250 | ||
251 | /* for I/O -- extra non-param data like TrwLayer data */ | |
252 | VikLayerFuncReadFileData read_file_data; | |
253 | VikLayerFuncWriteFileData write_file_data; | |
254 | ||
33534cd8 | 255 | VikLayerFuncDeleteItem delete_item; |
d5874ef9 | 256 | VikLayerFuncCutItem cut_item; |
50a14534 EB |
257 | VikLayerFuncCopyItem copy_item; |
258 | VikLayerFuncPasteItem paste_item; | |
259 | VikLayerFuncFreeCopiedItem free_copied_item; | |
70a23263 AF |
260 | |
261 | VikLayerFuncDragDropRequest drag_drop_request; | |
77ad64fa RN |
262 | |
263 | VikLayerFuncSelectClick select_click; | |
08f14055 RN |
264 | VikLayerFuncSelectMove select_move; |
265 | VikLayerFuncSelectRelease select_release; | |
e46f259a | 266 | VikLayerFuncSelectedViewportMenu show_viewport_menu; |
50a14534 EB |
267 | }; |
268 | ||
269 | VikLayerInterface *vik_layer_get_interface ( gint type ); | |
270 | ||
271 | ||
a0c65899 | 272 | void vik_layer_set_type ( VikLayer *vl, gint type ); |
50a14534 EB |
273 | void vik_layer_draw ( VikLayer *l, gpointer data ); |
274 | void vik_layer_change_coord_mode ( VikLayer *l, VikCoordMode mode ); | |
275 | void vik_layer_rename ( VikLayer *l, const gchar *new_name ); | |
276 | void vik_layer_rename_no_copy ( VikLayer *l, gchar *new_name ); | |
92558066 | 277 | const gchar *vik_layer_get_name ( VikLayer *l ); |
50a14534 | 278 | |
158b3642 | 279 | gboolean vik_layer_set_param (VikLayer *layer, guint16 id, VikLayerParamData data, gpointer vp, gboolean is_file_operation); |
50a14534 | 280 | |
da121f9b | 281 | void vik_layer_emit_update ( VikLayer *vl ); |
50a14534 EB |
282 | |
283 | /* GUI */ | |
20c7a3a0 QT |
284 | void vik_layer_set_menu_items_selection(VikLayer *l, guint16 selection); |
285 | guint16 vik_layer_get_menu_items_selection(VikLayer *l); | |
50a14534 EB |
286 | void vik_layer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp ); |
287 | VikLayer *vik_layer_create ( gint type, gpointer vp, GtkWindow *w, gboolean interactive ); | |
288 | gboolean vik_layer_properties ( VikLayer *layer, gpointer vp ); | |
289 | ||
290 | void vik_layer_realize ( VikLayer *l, VikTreeview *vt, GtkTreeIter * layer_iter ); | |
07059501 | 291 | void vik_layer_post_read ( VikLayer *layer, VikViewport *vp, gboolean from_file ); |
50a14534 | 292 | |
50eadc64 | 293 | gboolean vik_layer_sublayer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter, VikViewport *vvp ); |
50a14534 EB |
294 | |
295 | VikLayer *vik_layer_copy ( VikLayer *vl, gpointer vp ); | |
911400b5 AF |
296 | void vik_layer_marshall ( VikLayer *vl, guint8 **data, gint *len ); |
297 | VikLayer *vik_layer_unmarshall ( guint8 *data, gint len, VikViewport *vvp ); | |
298 | void vik_layer_marshall_params ( VikLayer *vl, guint8 **data, gint *len ); | |
299 | void vik_layer_unmarshall_params ( VikLayer *vl, guint8 *data, gint len, VikViewport *vvp ); | |
50a14534 EB |
300 | |
301 | const gchar *vik_layer_sublayer_rename_request ( VikLayer *l, const gchar *newname, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter ); | |
302 | ||
303 | gboolean vik_layer_sublayer_toggle_visible ( VikLayer *l, gint subtype, gpointer sublayer ); | |
304 | ||
9da7faf2 RN |
305 | const gchar* vik_layer_sublayer_tooltip ( VikLayer *l, gint subtype, gpointer sublayer ); |
306 | ||
1e8b7f57 RN |
307 | const gchar* vik_layer_layer_tooltip ( VikLayer *l ); |
308 | ||
a5dcfdb7 RN |
309 | gboolean vik_layer_selected ( VikLayer *l, gint subtype, gpointer sublayer, gint type, gpointer vlp ); |
310 | ||
50a14534 EB |
311 | /* TODO: put in layerspanel */ |
312 | GdkPixbuf *vik_layer_load_icon ( gint type ); | |
313 | ||
0df66d57 EB |
314 | VikLayer *vik_layer_get_and_reset_trigger(); |
315 | void vik_layer_emit_update_secondary ( VikLayer *vl ); /* to be called by aggregate layer only. doesn't set the trigger */ | |
316 | void vik_layer_emit_update_although_invisible ( VikLayer *vl ); | |
317 | ||
722b5481 RN |
318 | G_END_DECLS |
319 | ||
50a14534 | 320 | #endif |