]> git.street.me.uk Git - andy/viking.git/blame - src/viklayer.h
copy/paste of individual track- and waypoints- between processes now works
[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 */
e4afc73a 21#include <stdio.h>
50a14534
EB
22
23#ifndef _VIKING_LAYER_H
24#define _VIKING_LAYER_H
25
26#define VIK_LAYER_TYPE (vik_layer_get_type ())
27#define VIK_LAYER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), VIK_LAYER_TYPE, VikLayer))
28#define VIK_LAYER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), VIK_LAYER_TYPE, VikLayerClass))
29#define IS_VIK_LAYER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), VIK_LAYER_TYPE))
30#define IS_VIK_LAYER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), VIK_LAYER_TYPE))
31
32typedef struct _VikLayer VikLayer;
33typedef struct _VikLayerClass VikLayerClass;
34
35struct _VikLayerClass
36{
37 GObjectClass object_class;
38 void (* update) (VikLayer *vl);
39};
40
41GType vik_layer_get_type ();
42
43struct _VikLayer {
44 GObject obj;
45 gchar *name;
46 gboolean visible;
47
48 gboolean realized;
49 VikTreeview *vt; /* simply a refernce */
50 GtkTreeIter iter;
51
52 /* for explicit "polymorphism" (function type switching) */
53 guint16 type;
54};
55
56
57
58enum {
59VIK_LAYER_AGGREGATE = 0,
60VIK_LAYER_TRW,
61VIK_LAYER_COORD,
62VIK_LAYER_GEOREF,
63VIK_LAYER_MAPS,
64VIK_LAYER_NUM_TYPES
65};
66
67typedef enum { VIK_LAYER_TOOL_IGNORED=0,
68 VIK_LAYER_TOOL_ACK,
69 VIK_LAYER_TOOL_ACK_REDRAW_ABOVE,
70 VIK_LAYER_TOOL_ACK_REDRAW_ALL,
71 VIK_LAYER_TOOL_ACK_REDRAW_IF_VISIBLE }
72 VikLayerToolFuncStatus;
73typedef VikLayerToolFuncStatus (*VikToolInterfaceFunc) (VikLayer *,GdkEventButton *,gpointer);
74
75/* gpointer is viewport */
76
77typedef struct _VikToolInterface VikToolInterface;
78struct _VikToolInterface {
79 gchar *name;
80 VikToolInterfaceFunc callback;
81 VikToolInterfaceFunc callback_release;
82};
83
84/* Parameters (for I/O and Properties) */
85
86typedef union {
87 gdouble d;
88 guint32 u;
89 gint32 i;
90 gboolean b;
91 const gchar *s;
92 GdkColor c;
93} VikLayerParamData;
94
95typedef struct {
96 const gchar *name;
97 guint8 type;
98 gint16 group;
99 const gchar *title;
100 guint8 widget_type;
101 const gpointer widget_data;
102 const gpointer extra_widget_data;
103} VikLayerParam;
104
105enum {
106VIK_LAYER_NOT_IN_PROPERTIES=-2,
107VIK_LAYER_GROUP_NONE=-1
108};
109
110enum {
111VIK_LAYER_WIDGET_CHECKBUTTON=0,
112VIK_LAYER_WIDGET_RADIOGROUP,
113VIK_LAYER_WIDGET_SPINBUTTON,
114VIK_LAYER_WIDGET_ENTRY,
115VIK_LAYER_WIDGET_FILEENTRY,
116VIK_LAYER_WIDGET_HSCALE,
117VIK_LAYER_WIDGET_COLOR,
118VIK_LAYER_WIDGET_COMBOBOX,
119};
120
121typedef struct {
122 gdouble min;
123 gdouble max;
124 gdouble step;
125 guint8 digits;
126} VikLayerParamScale;
127
128/* id is index */
129enum {
130VIK_LAYER_PARAM_DOUBLE=1,
131VIK_LAYER_PARAM_UINT,
132VIK_LAYER_PARAM_INT,
133VIK_LAYER_PARAM_STRING,
134VIK_LAYER_PARAM_BOOLEAN,
135VIK_LAYER_PARAM_COLOR,
136};
137
138/* layer interface functions */
139
140/* Create a new layer of a certain type. Should be filled with defaults */
141typedef VikLayer * (*VikLayerFuncCreate) (VikViewport *);
142
143/* normally only needed for layers with sublayers. This is called when they
144 * are added to the treeview so they can add sublayers to the treeview. */
145typedef void (*VikLayerFuncRealize) (VikLayer *,VikTreeview *,GtkTreeIter *);
146
147/* rarely used, this is called after a read operation or properties box is run.
148 * usually used to create GC's that depend on params,
149 * but GC's can also be created from create() or set_param() */
150typedef void (*VikLayerFuncPostRead) (VikLayer *,gpointer vp);
151
152typedef void (*VikLayerFuncFree) (VikLayer *);
153
154/* do _not_ use this unless absolutely neccesary. Use the dynamic properties (see coordlayer for example)
155 * returns TRUE if OK was pressed */
156typedef gboolean (*VikLayerFuncProperties) (VikLayer *,VikViewport *); /* gpointer is a VikViewport */
157
158typedef void (*VikLayerFuncDraw) (VikLayer *,VikViewport *);
159typedef void (*VikLayerFuncChangeCoordMode) (VikLayer *,VikCoordMode);
160
161typedef void (*VikLayerFuncAddMenuItems) (VikLayer *,GtkMenu *,gpointer); /* gpointer is a VikLayersPanel */
162typedef gboolean (*VikLayerFuncSublayerAddMenuItems) (VikLayer *,GtkMenu *,gpointer, /* first gpointer is a VikLayersPanel */
163 gint,gpointer,GtkTreeIter *);
164typedef const gchar * (*VikLayerFuncSublayerRenameRequest) (VikLayer *,const gchar *,gpointer,
165 gint,VikViewport *,GtkTreeIter *); /* first gpointer is a VikLayersPanel */
166typedef gboolean (*VikLayerFuncSublayerToggleVisible) (VikLayer *,gint,gpointer);
167
168typedef VikLayer * (*VikLayerFuncCopy) (VikLayer *,VikViewport *);
911400b5
AF
169typedef void (*VikLayerFuncMarshall) (VikLayer *, guint8 **, gint *);
170typedef VikLayer * (*VikLayerFuncUnmarshall) (guint8 *, gint, VikViewport *);
50a14534
EB
171
172/* returns TRUE if needs to redraw due to changed param */
173typedef gboolean (*VikLayerFuncSetParam) (VikLayer *, guint16, VikLayerParamData, VikViewport *);
174
175typedef VikLayerParamData
176 (*VikLayerFuncGetParam) (VikLayer *, guint16);
177
178typedef void (*VikLayerFuncReadFileData) (VikLayer *, FILE *);
179typedef void (*VikLayerFuncWriteFileData) (VikLayer *, FILE *);
180
ddc47a46
AF
181typedef void (*VikLayerFuncCopyItem) (VikLayer *, gint, gpointer, guint8 **, guint *);
182typedef gboolean (*VikLayerFuncPasteItem) (VikLayer *, gint, guint8 *, guint);
50a14534
EB
183typedef void (*VikLayerFuncFreeCopiedItem) (gint, gpointer);
184
70a23263
AF
185/* treeview drag and drop method. called on the destination layer. it is given a source and destination layer,
186 * and the source and destination iters in the treeview.
187 */
188typedef void (*VikLayerFuncDragDropRequest) (VikLayer *, VikLayer *, GtkTreeIter *, GtkTreePath *);
189
50a14534
EB
190
191typedef struct _VikLayerInterface VikLayerInterface;
192
193/* See vik_layer_* for function parameter names */
194struct _VikLayerInterface {
195 const gchar * name;
196 const GdkPixdata * icon;
197
198 VikToolInterface * tools;
199 guint16 tools_count;
200
201 /* for I/O reading to and from .vik files -- params like coordline width, color, etc. */
202 VikLayerParam * params;
203 guint16 params_count;
204 gchar ** params_groups;
205 guint8 params_groups_count;
206
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
216 VikLayerFuncAddMenuItems add_menu_items;
217 VikLayerFuncSublayerAddMenuItems sublayer_add_menu_items;
218 VikLayerFuncSublayerRenameRequest sublayer_rename_request;
219 VikLayerFuncSublayerToggleVisible sublayer_toggle_visible;
220
221 VikLayerFuncCopy copy;
911400b5
AF
222 VikLayerFuncMarshall marshall;
223 VikLayerFuncUnmarshall unmarshall;
50a14534
EB
224
225 /* for I/O */
226 VikLayerFuncSetParam set_param;
227 VikLayerFuncGetParam get_param;
228
229 /* for I/O -- extra non-param data like TrwLayer data */
230 VikLayerFuncReadFileData read_file_data;
231 VikLayerFuncWriteFileData write_file_data;
232
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 );
248
249gboolean vik_layer_set_param (VikLayer *layer, guint16 id, VikLayerParamData data, gpointer vp);
250
251void vik_layer_emit_update ( VikLayer *vl );
252
253/* GUI */
254void vik_layer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp );
255VikLayer *vik_layer_create ( gint type, gpointer vp, GtkWindow *w, gboolean interactive );
256gboolean vik_layer_properties ( VikLayer *layer, gpointer vp );
257
258void vik_layer_realize ( VikLayer *l, VikTreeview *vt, GtkTreeIter * layer_iter );
259void vik_layer_post_read ( VikLayer *layer, gpointer vp );
260
261gboolean vik_layer_sublayer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter );
262
263VikLayer *vik_layer_copy ( VikLayer *vl, gpointer vp );
911400b5
AF
264void vik_layer_marshall ( VikLayer *vl, guint8 **data, gint *len );
265VikLayer *vik_layer_unmarshall ( guint8 *data, gint len, VikViewport *vvp );
266void vik_layer_marshall_params ( VikLayer *vl, guint8 **data, gint *len );
267void vik_layer_unmarshall_params ( VikLayer *vl, guint8 *data, gint len, VikViewport *vvp );
50a14534
EB
268
269const gchar *vik_layer_sublayer_rename_request ( VikLayer *l, const gchar *newname, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter );
270
271gboolean vik_layer_sublayer_toggle_visible ( VikLayer *l, gint subtype, gpointer sublayer );
272
273/* TODO: put in layerspanel */
274GdkPixbuf *vik_layer_load_icon ( gint type );
275
276#endif