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