]> git.street.me.uk Git - andy/viking.git/blame - src/viklayer.h
Insert a level of abstraction in map type hierarchie
[andy/viking.git] / src / viklayer.h
CommitLineData
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 40typedef struct _VikLayer VikLayer;
50a14534
EB
41typedef struct _VikLayerClass VikLayerClass;
42
43struct _VikLayerClass
44{
45 GObjectClass object_class;
46 void (* update) (VikLayer *vl);
47};
48
49GType vik_layer_get_type ();
50
51struct _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
66enum {
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
85typedef 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 */
95typedef gpointer (*VikToolConstructorFunc) (VikWindow *, VikViewport *);
96typedef void (*VikToolDestructorFunc) (gpointer);
97typedef VikLayerToolFuncStatus (*VikToolMouseFunc) (VikLayer *, GdkEventButton *, gpointer);
dc2c040e 98typedef VikLayerToolFuncStatus (*VikToolMouseMoveFunc) (VikLayer *, GdkEventMotion *, gpointer);
941aa6e9 99typedef void (*VikToolActivationFunc) (VikLayer *, gpointer);
777e2d4d 100typedef gboolean (*VikToolKeyFunc) (VikLayer *, GdkEventKey *, gpointer);
50a14534
EB
101
102typedef struct _VikToolInterface VikToolInterface;
103struct _VikToolInterface {
104 gchar *name;
941aa6e9
AF
105 VikToolConstructorFunc create;
106 VikToolDestructorFunc destroy;
107 VikToolActivationFunc activate;
108 VikToolActivationFunc deactivate;
109 VikToolMouseFunc click;
dc2c040e 110 VikToolMouseMoveFunc move;
941aa6e9 111 VikToolMouseFunc release;
777e2d4d 112 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
113 GdkCursorType cursor_type;
114 const GdkPixdata *cursor_data;
115 const GdkCursor *cursor;
50a14534
EB
116};
117
118/* Parameters (for I/O and Properties) */
28c82d8b 119/* --> moved to uibuilder.h */
50a14534 120
50a14534
EB
121
122/* layer interface functions */
123
124/* Create a new layer of a certain type. Should be filled with defaults */
125typedef VikLayer * (*VikLayerFuncCreate) (VikViewport *);
126
127/* normally only needed for layers with sublayers. This is called when they
128 * are added to the treeview so they can add sublayers to the treeview. */
129typedef void (*VikLayerFuncRealize) (VikLayer *,VikTreeview *,GtkTreeIter *);
130
131/* rarely used, this is called after a read operation or properties box is run.
132 * usually used to create GC's that depend on params,
133 * but GC's can also be created from create() or set_param() */
07059501 134typedef void (*VikLayerFuncPostRead) (VikLayer *,VikViewport *vp,gboolean from_file);
50a14534
EB
135
136typedef void (*VikLayerFuncFree) (VikLayer *);
137
138/* do _not_ use this unless absolutely neccesary. Use the dynamic properties (see coordlayer for example)
139 * returns TRUE if OK was pressed */
07059501 140typedef gboolean (*VikLayerFuncProperties) (VikLayer *,VikViewport *);
50a14534
EB
141
142typedef void (*VikLayerFuncDraw) (VikLayer *,VikViewport *);
143typedef void (*VikLayerFuncChangeCoordMode) (VikLayer *,VikCoordMode);
144
20c7a3a0
QT
145typedef void (*VikLayerFuncSetMenuItemsSelection) (VikLayer *,guint16);
146typedef guint16 (*VikLayerFuncGetMenuItemsSelection) (VikLayer *);
50a14534
EB
147typedef void (*VikLayerFuncAddMenuItems) (VikLayer *,GtkMenu *,gpointer); /* gpointer is a VikLayersPanel */
148typedef gboolean (*VikLayerFuncSublayerAddMenuItems) (VikLayer *,GtkMenu *,gpointer, /* first gpointer is a VikLayersPanel */
149 gint,gpointer,GtkTreeIter *);
150typedef const gchar * (*VikLayerFuncSublayerRenameRequest) (VikLayer *,const gchar *,gpointer,
151 gint,VikViewport *,GtkTreeIter *); /* first gpointer is a VikLayersPanel */
152typedef gboolean (*VikLayerFuncSublayerToggleVisible) (VikLayer *,gint,gpointer);
153
911400b5
AF
154typedef void (*VikLayerFuncMarshall) (VikLayer *, guint8 **, gint *);
155typedef VikLayer * (*VikLayerFuncUnmarshall) (guint8 *, gint, VikViewport *);
50a14534
EB
156
157/* returns TRUE if needs to redraw due to changed param */
158typedef gboolean (*VikLayerFuncSetParam) (VikLayer *, guint16, VikLayerParamData, VikViewport *);
159
160typedef VikLayerParamData
161 (*VikLayerFuncGetParam) (VikLayer *, guint16);
162
163typedef void (*VikLayerFuncReadFileData) (VikLayer *, FILE *);
164typedef void (*VikLayerFuncWriteFileData) (VikLayer *, FILE *);
165
33534cd8
AF
166/* item manipulation */
167typedef void (*VikLayerFuncDeleteItem) (VikLayer *, gint, gpointer);
168 /* layer, subtype, pointer to sub-item */
ddc47a46 169typedef void (*VikLayerFuncCopyItem) (VikLayer *, gint, gpointer, guint8 **, guint *);
33534cd8 170 /* layer, subtype, pointer to sub-item, return pointer, return len */
ddc47a46 171typedef gboolean (*VikLayerFuncPasteItem) (VikLayer *, gint, guint8 *, guint);
50a14534
EB
172typedef 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 */
177typedef void (*VikLayerFuncDragDropRequest) (VikLayer *, VikLayer *, GtkTreeIter *, GtkTreePath *);
178
5a4a28bf
QT
179typedef enum {
180 VIK_MENU_ITEM_PROPERTY=1,
181 VIK_MENU_ITEM_CUT=2,
182 VIK_MENU_ITEM_COPY=4,
183 VIK_MENU_ITEM_PASTE=8,
184 VIK_MENU_ITEM_DELETE=16,
185 VIK_MENU_ITEM_ALL=0xff
186} VikStdLayerMenuItem;
50a14534
EB
187
188typedef struct _VikLayerInterface VikLayerInterface;
189
190/* See vik_layer_* for function parameter names */
191struct _VikLayerInterface {
192 const gchar * name;
193 const GdkPixdata * icon;
194
195 VikToolInterface * tools;
196 guint16 tools_count;
197
198 /* for I/O reading to and from .vik files -- params like coordline width, color, etc. */
199 VikLayerParam * params;
200 guint16 params_count;
201 gchar ** params_groups;
202 guint8 params_groups_count;
203
5a4a28bf
QT
204 /* menu items to be created */
205 VikStdLayerMenuItem menu_items_selection;
206
50a14534
EB
207 VikLayerFuncCreate create;
208 VikLayerFuncRealize realize;
209 VikLayerFuncPostRead post_read;
210 VikLayerFuncFree free;
211
212 VikLayerFuncProperties properties;
213 VikLayerFuncDraw draw;
214 VikLayerFuncChangeCoordMode change_coord_mode;
215
20c7a3a0
QT
216 VikLayerFuncSetMenuItemsSelection set_menu_selection;
217 VikLayerFuncGetMenuItemsSelection get_menu_selection;
218
50a14534
EB
219 VikLayerFuncAddMenuItems add_menu_items;
220 VikLayerFuncSublayerAddMenuItems sublayer_add_menu_items;
221 VikLayerFuncSublayerRenameRequest sublayer_rename_request;
222 VikLayerFuncSublayerToggleVisible sublayer_toggle_visible;
223
911400b5
AF
224 VikLayerFuncMarshall marshall;
225 VikLayerFuncUnmarshall unmarshall;
50a14534
EB
226
227 /* for I/O */
228 VikLayerFuncSetParam set_param;
229 VikLayerFuncGetParam get_param;
230
231 /* for I/O -- extra non-param data like TrwLayer data */
232 VikLayerFuncReadFileData read_file_data;
233 VikLayerFuncWriteFileData write_file_data;
234
33534cd8 235 VikLayerFuncDeleteItem delete_item;
50a14534
EB
236 VikLayerFuncCopyItem copy_item;
237 VikLayerFuncPasteItem paste_item;
238 VikLayerFuncFreeCopiedItem free_copied_item;
70a23263
AF
239
240 VikLayerFuncDragDropRequest drag_drop_request;
50a14534
EB
241};
242
243VikLayerInterface *vik_layer_get_interface ( gint type );
244
245
246void vik_layer_init ( VikLayer *vl, gint type );
247void vik_layer_draw ( VikLayer *l, gpointer data );
248void vik_layer_change_coord_mode ( VikLayer *l, VikCoordMode mode );
249void vik_layer_rename ( VikLayer *l, const gchar *new_name );
250void vik_layer_rename_no_copy ( VikLayer *l, gchar *new_name );
92558066 251const gchar *vik_layer_get_name ( VikLayer *l );
50a14534
EB
252
253gboolean vik_layer_set_param (VikLayer *layer, guint16 id, VikLayerParamData data, gpointer vp);
254
255void vik_layer_emit_update ( VikLayer *vl );
256
257/* GUI */
20c7a3a0
QT
258void vik_layer_set_menu_items_selection(VikLayer *l, guint16 selection);
259guint16 vik_layer_get_menu_items_selection(VikLayer *l);
50a14534
EB
260void vik_layer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp );
261VikLayer *vik_layer_create ( gint type, gpointer vp, GtkWindow *w, gboolean interactive );
262gboolean vik_layer_properties ( VikLayer *layer, gpointer vp );
263
264void vik_layer_realize ( VikLayer *l, VikTreeview *vt, GtkTreeIter * layer_iter );
07059501 265void vik_layer_post_read ( VikLayer *layer, VikViewport *vp, gboolean from_file );
50a14534
EB
266
267gboolean vik_layer_sublayer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter );
268
269VikLayer *vik_layer_copy ( VikLayer *vl, gpointer vp );
911400b5
AF
270void vik_layer_marshall ( VikLayer *vl, guint8 **data, gint *len );
271VikLayer *vik_layer_unmarshall ( guint8 *data, gint len, VikViewport *vvp );
272void vik_layer_marshall_params ( VikLayer *vl, guint8 **data, gint *len );
273void vik_layer_unmarshall_params ( VikLayer *vl, guint8 *data, gint len, VikViewport *vvp );
50a14534
EB
274
275const gchar *vik_layer_sublayer_rename_request ( VikLayer *l, const gchar *newname, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter );
276
277gboolean vik_layer_sublayer_toggle_visible ( VikLayer *l, gint subtype, gpointer sublayer );
278
279/* TODO: put in layerspanel */
280GdkPixbuf *vik_layer_load_icon ( gint type );
281
0df66d57
EB
282VikLayer *vik_layer_get_and_reset_trigger();
283void vik_layer_emit_update_secondary ( VikLayer *vl ); /* to be called by aggregate layer only. doesn't set the trigger */
284void vik_layer_emit_update_although_invisible ( VikLayer *vl );
285
50a14534 286#endif