]> git.street.me.uk Git - andy/viking.git/blame - src/viklayer.h
Simplify tools enable/disable codes
[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
cdcaf41c 29#include "vikwindow.h"
a25c4c50
GB
30#include "viktreeview.h"
31#include "vikviewport.h"
50a14534
EB
32
33#define VIK_LAYER_TYPE (vik_layer_get_type ())
34#define VIK_LAYER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), VIK_LAYER_TYPE, VikLayer))
35#define VIK_LAYER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), VIK_LAYER_TYPE, VikLayerClass))
36#define IS_VIK_LAYER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), VIK_LAYER_TYPE))
37#define IS_VIK_LAYER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), VIK_LAYER_TYPE))
38
50a14534
EB
39typedef struct _VikLayerClass VikLayerClass;
40
41struct _VikLayerClass
42{
43 GObjectClass object_class;
44 void (* update) (VikLayer *vl);
45};
46
47GType vik_layer_get_type ();
48
49struct _VikLayer {
50 GObject obj;
51 gchar *name;
52 gboolean visible;
53
54 gboolean realized;
55 VikTreeview *vt; /* simply a refernce */
56 GtkTreeIter iter;
57
58 /* for explicit "polymorphism" (function type switching) */
59 guint16 type;
60};
61
62
63
64enum {
941aa6e9
AF
65 VIK_LAYER_AGGREGATE = 0,
66 VIK_LAYER_TRW,
67 VIK_LAYER_COORD,
68 VIK_LAYER_GEOREF,
b364d6bc 69 VIK_LAYER_GPS,
941aa6e9
AF
70 VIK_LAYER_MAPS,
71 VIK_LAYER_NUM_TYPES
50a14534
EB
72};
73
941aa6e9
AF
74typedef enum {
75 VIK_LAYER_TOOL_IGNORED=0,
76 VIK_LAYER_TOOL_ACK,
77 VIK_LAYER_TOOL_ACK_REDRAW_ABOVE,
78 VIK_LAYER_TOOL_ACK_REDRAW_ALL,
79 VIK_LAYER_TOOL_ACK_REDRAW_IF_VISIBLE
80} VikLayerToolFuncStatus;
50a14534 81
941aa6e9
AF
82/* gpointer is tool-specific state created in the constructor */
83typedef gpointer (*VikToolConstructorFunc) (VikWindow *, VikViewport *);
84typedef void (*VikToolDestructorFunc) (gpointer);
85typedef VikLayerToolFuncStatus (*VikToolMouseFunc) (VikLayer *, GdkEventButton *, gpointer);
86typedef void (*VikToolActivationFunc) (VikLayer *, gpointer);
50a14534
EB
87
88typedef struct _VikToolInterface VikToolInterface;
89struct _VikToolInterface {
90 gchar *name;
941aa6e9
AF
91 VikToolConstructorFunc create;
92 VikToolDestructorFunc destroy;
93 VikToolActivationFunc activate;
94 VikToolActivationFunc deactivate;
95 VikToolMouseFunc click;
96 VikToolMouseFunc move;
97 VikToolMouseFunc release;
50a14534
EB
98};
99
100/* Parameters (for I/O and Properties) */
101
102typedef union {
103 gdouble d;
104 guint32 u;
105 gint32 i;
106 gboolean b;
107 const gchar *s;
108 GdkColor c;
109} VikLayerParamData;
110
111typedef struct {
112 const gchar *name;
113 guint8 type;
114 gint16 group;
115 const gchar *title;
116 guint8 widget_type;
cdcaf41c
QT
117 gpointer widget_data;
118 gpointer extra_widget_data;
50a14534
EB
119} VikLayerParam;
120
121enum {
122VIK_LAYER_NOT_IN_PROPERTIES=-2,
123VIK_LAYER_GROUP_NONE=-1
124};
125
126enum {
127VIK_LAYER_WIDGET_CHECKBUTTON=0,
128VIK_LAYER_WIDGET_RADIOGROUP,
129VIK_LAYER_WIDGET_SPINBUTTON,
130VIK_LAYER_WIDGET_ENTRY,
131VIK_LAYER_WIDGET_FILEENTRY,
132VIK_LAYER_WIDGET_HSCALE,
133VIK_LAYER_WIDGET_COLOR,
134VIK_LAYER_WIDGET_COMBOBOX,
135};
136
137typedef struct {
138 gdouble min;
139 gdouble max;
140 gdouble step;
141 guint8 digits;
142} VikLayerParamScale;
143
144/* id is index */
145enum {
146VIK_LAYER_PARAM_DOUBLE=1,
147VIK_LAYER_PARAM_UINT,
148VIK_LAYER_PARAM_INT,
149VIK_LAYER_PARAM_STRING,
150VIK_LAYER_PARAM_BOOLEAN,
151VIK_LAYER_PARAM_COLOR,
152};
153
154/* layer interface functions */
155
156/* Create a new layer of a certain type. Should be filled with defaults */
157typedef VikLayer * (*VikLayerFuncCreate) (VikViewport *);
158
159/* normally only needed for layers with sublayers. This is called when they
160 * are added to the treeview so they can add sublayers to the treeview. */
161typedef void (*VikLayerFuncRealize) (VikLayer *,VikTreeview *,GtkTreeIter *);
162
163/* rarely used, this is called after a read operation or properties box is run.
164 * usually used to create GC's that depend on params,
165 * but GC's can also be created from create() or set_param() */
166typedef void (*VikLayerFuncPostRead) (VikLayer *,gpointer vp);
167
168typedef void (*VikLayerFuncFree) (VikLayer *);
169
170/* do _not_ use this unless absolutely neccesary. Use the dynamic properties (see coordlayer for example)
171 * returns TRUE if OK was pressed */
172typedef gboolean (*VikLayerFuncProperties) (VikLayer *,VikViewport *); /* gpointer is a VikViewport */
173
174typedef void (*VikLayerFuncDraw) (VikLayer *,VikViewport *);
175typedef void (*VikLayerFuncChangeCoordMode) (VikLayer *,VikCoordMode);
176
20c7a3a0
QT
177typedef void (*VikLayerFuncSetMenuItemsSelection) (VikLayer *,guint16);
178typedef guint16 (*VikLayerFuncGetMenuItemsSelection) (VikLayer *);
50a14534
EB
179typedef void (*VikLayerFuncAddMenuItems) (VikLayer *,GtkMenu *,gpointer); /* gpointer is a VikLayersPanel */
180typedef gboolean (*VikLayerFuncSublayerAddMenuItems) (VikLayer *,GtkMenu *,gpointer, /* first gpointer is a VikLayersPanel */
181 gint,gpointer,GtkTreeIter *);
182typedef const gchar * (*VikLayerFuncSublayerRenameRequest) (VikLayer *,const gchar *,gpointer,
183 gint,VikViewport *,GtkTreeIter *); /* first gpointer is a VikLayersPanel */
184typedef gboolean (*VikLayerFuncSublayerToggleVisible) (VikLayer *,gint,gpointer);
185
186typedef VikLayer * (*VikLayerFuncCopy) (VikLayer *,VikViewport *);
911400b5
AF
187typedef void (*VikLayerFuncMarshall) (VikLayer *, guint8 **, gint *);
188typedef VikLayer * (*VikLayerFuncUnmarshall) (guint8 *, gint, VikViewport *);
50a14534
EB
189
190/* returns TRUE if needs to redraw due to changed param */
191typedef gboolean (*VikLayerFuncSetParam) (VikLayer *, guint16, VikLayerParamData, VikViewport *);
192
193typedef VikLayerParamData
194 (*VikLayerFuncGetParam) (VikLayer *, guint16);
195
196typedef void (*VikLayerFuncReadFileData) (VikLayer *, FILE *);
197typedef void (*VikLayerFuncWriteFileData) (VikLayer *, FILE *);
198
33534cd8
AF
199/* item manipulation */
200typedef void (*VikLayerFuncDeleteItem) (VikLayer *, gint, gpointer);
201 /* layer, subtype, pointer to sub-item */
ddc47a46 202typedef void (*VikLayerFuncCopyItem) (VikLayer *, gint, gpointer, guint8 **, guint *);
33534cd8 203 /* layer, subtype, pointer to sub-item, return pointer, return len */
ddc47a46 204typedef gboolean (*VikLayerFuncPasteItem) (VikLayer *, gint, guint8 *, guint);
50a14534
EB
205typedef void (*VikLayerFuncFreeCopiedItem) (gint, gpointer);
206
70a23263
AF
207/* treeview drag and drop method. called on the destination layer. it is given a source and destination layer,
208 * and the source and destination iters in the treeview.
209 */
210typedef void (*VikLayerFuncDragDropRequest) (VikLayer *, VikLayer *, GtkTreeIter *, GtkTreePath *);
211
5a4a28bf
QT
212typedef enum {
213 VIK_MENU_ITEM_PROPERTY=1,
214 VIK_MENU_ITEM_CUT=2,
215 VIK_MENU_ITEM_COPY=4,
216 VIK_MENU_ITEM_PASTE=8,
217 VIK_MENU_ITEM_DELETE=16,
218 VIK_MENU_ITEM_ALL=0xff
219} VikStdLayerMenuItem;
50a14534
EB
220
221typedef struct _VikLayerInterface VikLayerInterface;
222
223/* See vik_layer_* for function parameter names */
224struct _VikLayerInterface {
225 const gchar * name;
226 const GdkPixdata * icon;
227
228 VikToolInterface * tools;
229 guint16 tools_count;
230
231 /* for I/O reading to and from .vik files -- params like coordline width, color, etc. */
232 VikLayerParam * params;
233 guint16 params_count;
234 gchar ** params_groups;
235 guint8 params_groups_count;
236
5a4a28bf
QT
237 /* menu items to be created */
238 VikStdLayerMenuItem menu_items_selection;
239
50a14534
EB
240 VikLayerFuncCreate create;
241 VikLayerFuncRealize realize;
242 VikLayerFuncPostRead post_read;
243 VikLayerFuncFree free;
244
245 VikLayerFuncProperties properties;
246 VikLayerFuncDraw draw;
247 VikLayerFuncChangeCoordMode change_coord_mode;
248
20c7a3a0
QT
249 VikLayerFuncSetMenuItemsSelection set_menu_selection;
250 VikLayerFuncGetMenuItemsSelection get_menu_selection;
251
50a14534
EB
252 VikLayerFuncAddMenuItems add_menu_items;
253 VikLayerFuncSublayerAddMenuItems sublayer_add_menu_items;
254 VikLayerFuncSublayerRenameRequest sublayer_rename_request;
255 VikLayerFuncSublayerToggleVisible sublayer_toggle_visible;
256
257 VikLayerFuncCopy copy;
911400b5
AF
258 VikLayerFuncMarshall marshall;
259 VikLayerFuncUnmarshall unmarshall;
50a14534
EB
260
261 /* for I/O */
262 VikLayerFuncSetParam set_param;
263 VikLayerFuncGetParam get_param;
264
265 /* for I/O -- extra non-param data like TrwLayer data */
266 VikLayerFuncReadFileData read_file_data;
267 VikLayerFuncWriteFileData write_file_data;
268
33534cd8 269 VikLayerFuncDeleteItem delete_item;
50a14534
EB
270 VikLayerFuncCopyItem copy_item;
271 VikLayerFuncPasteItem paste_item;
272 VikLayerFuncFreeCopiedItem free_copied_item;
70a23263
AF
273
274 VikLayerFuncDragDropRequest drag_drop_request;
50a14534
EB
275};
276
277VikLayerInterface *vik_layer_get_interface ( gint type );
278
279
280void vik_layer_init ( VikLayer *vl, gint type );
281void vik_layer_draw ( VikLayer *l, gpointer data );
282void vik_layer_change_coord_mode ( VikLayer *l, VikCoordMode mode );
283void vik_layer_rename ( VikLayer *l, const gchar *new_name );
284void vik_layer_rename_no_copy ( VikLayer *l, gchar *new_name );
285
286gboolean vik_layer_set_param (VikLayer *layer, guint16 id, VikLayerParamData data, gpointer vp);
287
288void vik_layer_emit_update ( VikLayer *vl );
289
290/* GUI */
20c7a3a0
QT
291void vik_layer_set_menu_items_selection(VikLayer *l, guint16 selection);
292guint16 vik_layer_get_menu_items_selection(VikLayer *l);
50a14534
EB
293void vik_layer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp );
294VikLayer *vik_layer_create ( gint type, gpointer vp, GtkWindow *w, gboolean interactive );
295gboolean vik_layer_properties ( VikLayer *layer, gpointer vp );
296
297void vik_layer_realize ( VikLayer *l, VikTreeview *vt, GtkTreeIter * layer_iter );
298void vik_layer_post_read ( VikLayer *layer, gpointer vp );
299
300gboolean vik_layer_sublayer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter );
301
302VikLayer *vik_layer_copy ( VikLayer *vl, gpointer vp );
911400b5
AF
303void vik_layer_marshall ( VikLayer *vl, guint8 **data, gint *len );
304VikLayer *vik_layer_unmarshall ( guint8 *data, gint len, VikViewport *vvp );
305void vik_layer_marshall_params ( VikLayer *vl, guint8 **data, gint *len );
306void vik_layer_unmarshall_params ( VikLayer *vl, guint8 *data, gint len, VikViewport *vvp );
50a14534
EB
307
308const gchar *vik_layer_sublayer_rename_request ( VikLayer *l, const gchar *newname, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter );
309
310gboolean vik_layer_sublayer_toggle_visible ( VikLayer *l, gint subtype, gpointer sublayer );
311
312/* TODO: put in layerspanel */
313GdkPixbuf *vik_layer_load_icon ( gint type );
314
315#endif