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