]>
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 EB |
33 | |
34 | #define VIK_LAYER_TYPE (vik_layer_get_type ()) | |
35 | #define VIK_LAYER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), VIK_LAYER_TYPE, VikLayer)) | |
36 | #define VIK_LAYER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), VIK_LAYER_TYPE, VikLayerClass)) | |
37 | #define IS_VIK_LAYER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), VIK_LAYER_TYPE)) | |
38 | #define IS_VIK_LAYER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), VIK_LAYER_TYPE)) | |
39 | ||
369e959a | 40 | typedef struct _VikLayer VikLayer; |
50a14534 EB |
41 | typedef struct _VikLayerClass VikLayerClass; |
42 | ||
43 | struct _VikLayerClass | |
44 | { | |
45 | GObjectClass object_class; | |
46 | void (* update) (VikLayer *vl); | |
47 | }; | |
48 | ||
49 | GType vik_layer_get_type (); | |
50 | ||
51 | struct _VikLayer { | |
52 | GObject obj; | |
53 | gchar *name; | |
54 | gboolean visible; | |
55 | ||
56 | gboolean realized; | |
94933cb8 | 57 | VikTreeview *vt; /* simply a reference */ |
50a14534 EB |
58 | GtkTreeIter iter; |
59 | ||
60 | /* for explicit "polymorphism" (function type switching) */ | |
61 | guint16 type; | |
62 | }; | |
63 | ||
64 | ||
65 | ||
66 | enum { | |
941aa6e9 AF |
67 | VIK_LAYER_AGGREGATE = 0, |
68 | VIK_LAYER_TRW, | |
69 | VIK_LAYER_COORD, | |
70 | VIK_LAYER_GEOREF, | |
b364d6bc | 71 | VIK_LAYER_GPS, |
941aa6e9 | 72 | VIK_LAYER_MAPS, |
ad0a8c2d | 73 | VIK_LAYER_DEM, |
941aa6e9 | 74 | VIK_LAYER_NUM_TYPES |
50a14534 EB |
75 | }; |
76 | ||
165d30aa EB |
77 | /* I think most of these are ignored, |
78 | * returning GRAB_FOCUS grabs the focus for mouse move, | |
79 | * mouse click, release always grabs focus. Focus allows key presses | |
80 | * to be handled. | |
81 | * It used to be that, if ignored, Viking could look for other layers. | |
82 | * this was useful for clicking a way/trackpoint in any layer, | |
83 | * if no layer was selected (find way/trackpoint) | |
84 | */ | |
941aa6e9 AF |
85 | typedef enum { |
86 | VIK_LAYER_TOOL_IGNORED=0, | |
87 | VIK_LAYER_TOOL_ACK, | |
88 | VIK_LAYER_TOOL_ACK_REDRAW_ABOVE, | |
89 | VIK_LAYER_TOOL_ACK_REDRAW_ALL, | |
165d30aa EB |
90 | VIK_LAYER_TOOL_ACK_REDRAW_IF_VISIBLE, |
91 | VIK_LAYER_TOOL_ACK_GRAB_FOCUS, /* only for move */ | |
941aa6e9 | 92 | } VikLayerToolFuncStatus; |
50a14534 | 93 | |
941aa6e9 AF |
94 | /* gpointer is tool-specific state created in the constructor */ |
95 | typedef gpointer (*VikToolConstructorFunc) (VikWindow *, VikViewport *); | |
96 | typedef void (*VikToolDestructorFunc) (gpointer); | |
97 | typedef VikLayerToolFuncStatus (*VikToolMouseFunc) (VikLayer *, GdkEventButton *, gpointer); | |
98 | typedef void (*VikToolActivationFunc) (VikLayer *, gpointer); | |
777e2d4d | 99 | typedef gboolean (*VikToolKeyFunc) (VikLayer *, GdkEventKey *, gpointer); |
50a14534 EB |
100 | |
101 | typedef struct _VikToolInterface VikToolInterface; | |
102 | struct _VikToolInterface { | |
103 | gchar *name; | |
941aa6e9 AF |
104 | VikToolConstructorFunc create; |
105 | VikToolDestructorFunc destroy; | |
106 | VikToolActivationFunc activate; | |
107 | VikToolActivationFunc deactivate; | |
108 | VikToolMouseFunc click; | |
109 | VikToolMouseFunc move; | |
110 | VikToolMouseFunc release; | |
777e2d4d | 111 | 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. */ |
f2f2f7bf GB |
112 | GdkCursorType cursor_type; |
113 | const GdkPixdata *cursor_data; | |
114 | const GdkCursor *cursor; | |
50a14534 EB |
115 | }; |
116 | ||
117 | /* Parameters (for I/O and Properties) */ | |
28c82d8b | 118 | /* --> moved to uibuilder.h */ |
50a14534 | 119 | |
50a14534 EB |
120 | |
121 | /* layer interface functions */ | |
122 | ||
123 | /* Create a new layer of a certain type. Should be filled with defaults */ | |
124 | typedef VikLayer * (*VikLayerFuncCreate) (VikViewport *); | |
125 | ||
126 | /* normally only needed for layers with sublayers. This is called when they | |
127 | * are added to the treeview so they can add sublayers to the treeview. */ | |
128 | typedef void (*VikLayerFuncRealize) (VikLayer *,VikTreeview *,GtkTreeIter *); | |
129 | ||
130 | /* rarely used, this is called after a read operation or properties box is run. | |
131 | * usually used to create GC's that depend on params, | |
132 | * but GC's can also be created from create() or set_param() */ | |
07059501 | 133 | typedef void (*VikLayerFuncPostRead) (VikLayer *,VikViewport *vp,gboolean from_file); |
50a14534 EB |
134 | |
135 | typedef void (*VikLayerFuncFree) (VikLayer *); | |
136 | ||
137 | /* do _not_ use this unless absolutely neccesary. Use the dynamic properties (see coordlayer for example) | |
138 | * returns TRUE if OK was pressed */ | |
07059501 | 139 | typedef gboolean (*VikLayerFuncProperties) (VikLayer *,VikViewport *); |
50a14534 EB |
140 | |
141 | typedef void (*VikLayerFuncDraw) (VikLayer *,VikViewport *); | |
142 | typedef void (*VikLayerFuncChangeCoordMode) (VikLayer *,VikCoordMode); | |
143 | ||
20c7a3a0 QT |
144 | typedef void (*VikLayerFuncSetMenuItemsSelection) (VikLayer *,guint16); |
145 | typedef guint16 (*VikLayerFuncGetMenuItemsSelection) (VikLayer *); | |
50a14534 EB |
146 | typedef void (*VikLayerFuncAddMenuItems) (VikLayer *,GtkMenu *,gpointer); /* gpointer is a VikLayersPanel */ |
147 | typedef gboolean (*VikLayerFuncSublayerAddMenuItems) (VikLayer *,GtkMenu *,gpointer, /* first gpointer is a VikLayersPanel */ | |
148 | gint,gpointer,GtkTreeIter *); | |
149 | typedef const gchar * (*VikLayerFuncSublayerRenameRequest) (VikLayer *,const gchar *,gpointer, | |
150 | gint,VikViewport *,GtkTreeIter *); /* first gpointer is a VikLayersPanel */ | |
151 | typedef gboolean (*VikLayerFuncSublayerToggleVisible) (VikLayer *,gint,gpointer); | |
152 | ||
911400b5 AF |
153 | typedef void (*VikLayerFuncMarshall) (VikLayer *, guint8 **, gint *); |
154 | typedef VikLayer * (*VikLayerFuncUnmarshall) (guint8 *, gint, VikViewport *); | |
50a14534 EB |
155 | |
156 | /* returns TRUE if needs to redraw due to changed param */ | |
157 | typedef gboolean (*VikLayerFuncSetParam) (VikLayer *, guint16, VikLayerParamData, VikViewport *); | |
158 | ||
159 | typedef VikLayerParamData | |
160 | (*VikLayerFuncGetParam) (VikLayer *, guint16); | |
161 | ||
162 | typedef void (*VikLayerFuncReadFileData) (VikLayer *, FILE *); | |
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 */ | |
ddc47a46 | 168 | typedef void (*VikLayerFuncCopyItem) (VikLayer *, gint, gpointer, guint8 **, guint *); |
33534cd8 | 169 | /* layer, subtype, pointer to sub-item, return pointer, return len */ |
ddc47a46 | 170 | typedef gboolean (*VikLayerFuncPasteItem) (VikLayer *, gint, guint8 *, guint); |
50a14534 EB |
171 | typedef void (*VikLayerFuncFreeCopiedItem) (gint, gpointer); |
172 | ||
70a23263 AF |
173 | /* treeview drag and drop method. called on the destination layer. it is given a source and destination layer, |
174 | * and the source and destination iters in the treeview. | |
175 | */ | |
176 | typedef void (*VikLayerFuncDragDropRequest) (VikLayer *, VikLayer *, GtkTreeIter *, GtkTreePath *); | |
177 | ||
5a4a28bf QT |
178 | typedef enum { |
179 | VIK_MENU_ITEM_PROPERTY=1, | |
180 | VIK_MENU_ITEM_CUT=2, | |
181 | VIK_MENU_ITEM_COPY=4, | |
182 | VIK_MENU_ITEM_PASTE=8, | |
183 | VIK_MENU_ITEM_DELETE=16, | |
184 | VIK_MENU_ITEM_ALL=0xff | |
185 | } VikStdLayerMenuItem; | |
50a14534 EB |
186 | |
187 | typedef struct _VikLayerInterface VikLayerInterface; | |
188 | ||
189 | /* See vik_layer_* for function parameter names */ | |
190 | struct _VikLayerInterface { | |
191 | const gchar * name; | |
192 | const GdkPixdata * icon; | |
193 | ||
194 | VikToolInterface * tools; | |
195 | guint16 tools_count; | |
196 | ||
197 | /* for I/O reading to and from .vik files -- params like coordline width, color, etc. */ | |
198 | VikLayerParam * params; | |
199 | guint16 params_count; | |
200 | gchar ** params_groups; | |
201 | guint8 params_groups_count; | |
202 | ||
5a4a28bf QT |
203 | /* menu items to be created */ |
204 | VikStdLayerMenuItem menu_items_selection; | |
205 | ||
50a14534 EB |
206 | VikLayerFuncCreate create; |
207 | VikLayerFuncRealize realize; | |
208 | VikLayerFuncPostRead post_read; | |
209 | VikLayerFuncFree free; | |
210 | ||
211 | VikLayerFuncProperties properties; | |
212 | VikLayerFuncDraw draw; | |
213 | VikLayerFuncChangeCoordMode change_coord_mode; | |
214 | ||
20c7a3a0 QT |
215 | VikLayerFuncSetMenuItemsSelection set_menu_selection; |
216 | VikLayerFuncGetMenuItemsSelection get_menu_selection; | |
217 | ||
50a14534 EB |
218 | VikLayerFuncAddMenuItems add_menu_items; |
219 | VikLayerFuncSublayerAddMenuItems sublayer_add_menu_items; | |
220 | VikLayerFuncSublayerRenameRequest sublayer_rename_request; | |
221 | VikLayerFuncSublayerToggleVisible sublayer_toggle_visible; | |
222 | ||
911400b5 AF |
223 | VikLayerFuncMarshall marshall; |
224 | VikLayerFuncUnmarshall unmarshall; | |
50a14534 EB |
225 | |
226 | /* for I/O */ | |
227 | VikLayerFuncSetParam set_param; | |
228 | VikLayerFuncGetParam get_param; | |
229 | ||
230 | /* for I/O -- extra non-param data like TrwLayer data */ | |
231 | VikLayerFuncReadFileData read_file_data; | |
232 | VikLayerFuncWriteFileData write_file_data; | |
233 | ||
33534cd8 | 234 | VikLayerFuncDeleteItem delete_item; |
50a14534 EB |
235 | VikLayerFuncCopyItem copy_item; |
236 | VikLayerFuncPasteItem paste_item; | |
237 | VikLayerFuncFreeCopiedItem free_copied_item; | |
70a23263 AF |
238 | |
239 | VikLayerFuncDragDropRequest drag_drop_request; | |
50a14534 EB |
240 | }; |
241 | ||
242 | VikLayerInterface *vik_layer_get_interface ( gint type ); | |
243 | ||
244 | ||
245 | void vik_layer_init ( VikLayer *vl, gint type ); | |
246 | void vik_layer_draw ( VikLayer *l, gpointer data ); | |
247 | void vik_layer_change_coord_mode ( VikLayer *l, VikCoordMode mode ); | |
248 | void vik_layer_rename ( VikLayer *l, const gchar *new_name ); | |
249 | void vik_layer_rename_no_copy ( VikLayer *l, gchar *new_name ); | |
92558066 | 250 | const gchar *vik_layer_get_name ( VikLayer *l ); |
50a14534 EB |
251 | |
252 | gboolean vik_layer_set_param (VikLayer *layer, guint16 id, VikLayerParamData data, gpointer vp); | |
253 | ||
254 | void vik_layer_emit_update ( VikLayer *vl ); | |
255 | ||
256 | /* GUI */ | |
20c7a3a0 QT |
257 | void vik_layer_set_menu_items_selection(VikLayer *l, guint16 selection); |
258 | guint16 vik_layer_get_menu_items_selection(VikLayer *l); | |
50a14534 EB |
259 | void vik_layer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp ); |
260 | VikLayer *vik_layer_create ( gint type, gpointer vp, GtkWindow *w, gboolean interactive ); | |
261 | gboolean vik_layer_properties ( VikLayer *layer, gpointer vp ); | |
262 | ||
263 | void vik_layer_realize ( VikLayer *l, VikTreeview *vt, GtkTreeIter * layer_iter ); | |
07059501 | 264 | void vik_layer_post_read ( VikLayer *layer, VikViewport *vp, gboolean from_file ); |
50a14534 EB |
265 | |
266 | gboolean vik_layer_sublayer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter ); | |
267 | ||
268 | VikLayer *vik_layer_copy ( VikLayer *vl, gpointer vp ); | |
911400b5 AF |
269 | void vik_layer_marshall ( VikLayer *vl, guint8 **data, gint *len ); |
270 | VikLayer *vik_layer_unmarshall ( guint8 *data, gint len, VikViewport *vvp ); | |
271 | void vik_layer_marshall_params ( VikLayer *vl, guint8 **data, gint *len ); | |
272 | void vik_layer_unmarshall_params ( VikLayer *vl, guint8 *data, gint len, VikViewport *vvp ); | |
50a14534 EB |
273 | |
274 | const gchar *vik_layer_sublayer_rename_request ( VikLayer *l, const gchar *newname, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter ); | |
275 | ||
276 | gboolean vik_layer_sublayer_toggle_visible ( VikLayer *l, gint subtype, gpointer sublayer ); | |
277 | ||
278 | /* TODO: put in layerspanel */ | |
279 | GdkPixbuf *vik_layer_load_icon ( gint type ); | |
280 | ||
0df66d57 EB |
281 | VikLayer *vik_layer_get_and_reset_trigger(); |
282 | void vik_layer_emit_update_secondary ( VikLayer *vl ); /* to be called by aggregate layer only. doesn't set the trigger */ | |
283 | void vik_layer_emit_update_although_invisible ( VikLayer *vl ); | |
284 | ||
50a14534 | 285 | #endif |