2 * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
4 * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
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.
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.
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
21 #ifndef _VIKING_LAYER_H
22 #define _VIKING_LAYER_H
27 #include <gdk-pixbuf/gdk-pixdata.h>
28 #include "vikwindow.h"
30 #include "viktreeview.h"
31 #include "vikviewport.h"
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))
39 typedef struct _VikLayer VikLayer;
40 typedef struct _VikLayerClass VikLayerClass;
44 GObjectClass object_class;
45 void (* update) (VikLayer *vl);
48 GType vik_layer_get_type ();
56 VikTreeview *vt; /* simply a refernce */
59 /* for explicit "polymorphism" (function type switching) */
66 VIK_LAYER_AGGREGATE = 0,
76 VIK_LAYER_TOOL_IGNORED=0,
78 VIK_LAYER_TOOL_ACK_REDRAW_ABOVE,
79 VIK_LAYER_TOOL_ACK_REDRAW_ALL,
80 VIK_LAYER_TOOL_ACK_REDRAW_IF_VISIBLE
81 } VikLayerToolFuncStatus;
83 /* gpointer is tool-specific state created in the constructor */
84 typedef gpointer (*VikToolConstructorFunc) (VikWindow *, VikViewport *);
85 typedef void (*VikToolDestructorFunc) (gpointer);
86 typedef VikLayerToolFuncStatus (*VikToolMouseFunc) (VikLayer *, GdkEventButton *, gpointer);
87 typedef void (*VikToolActivationFunc) (VikLayer *, gpointer);
89 typedef struct _VikToolInterface VikToolInterface;
90 struct _VikToolInterface {
92 VikToolConstructorFunc create;
93 VikToolDestructorFunc destroy;
94 VikToolActivationFunc activate;
95 VikToolActivationFunc deactivate;
96 VikToolMouseFunc click;
97 VikToolMouseFunc move;
98 VikToolMouseFunc release;
101 /* Parameters (for I/O and Properties) */
118 const gpointer widget_data;
119 const gpointer extra_widget_data;
123 VIK_LAYER_NOT_IN_PROPERTIES=-2,
124 VIK_LAYER_GROUP_NONE=-1
128 VIK_LAYER_WIDGET_CHECKBUTTON=0,
129 VIK_LAYER_WIDGET_RADIOGROUP,
130 VIK_LAYER_WIDGET_SPINBUTTON,
131 VIK_LAYER_WIDGET_ENTRY,
132 VIK_LAYER_WIDGET_FILEENTRY,
133 VIK_LAYER_WIDGET_HSCALE,
134 VIK_LAYER_WIDGET_COLOR,
135 VIK_LAYER_WIDGET_COMBOBOX,
143 } VikLayerParamScale;
147 VIK_LAYER_PARAM_DOUBLE=1,
148 VIK_LAYER_PARAM_UINT,
150 VIK_LAYER_PARAM_STRING,
151 VIK_LAYER_PARAM_BOOLEAN,
152 VIK_LAYER_PARAM_COLOR,
155 /* layer interface functions */
157 /* Create a new layer of a certain type. Should be filled with defaults */
158 typedef VikLayer * (*VikLayerFuncCreate) (VikViewport *);
160 /* normally only needed for layers with sublayers. This is called when they
161 * are added to the treeview so they can add sublayers to the treeview. */
162 typedef void (*VikLayerFuncRealize) (VikLayer *,VikTreeview *,GtkTreeIter *);
164 /* rarely used, this is called after a read operation or properties box is run.
165 * usually used to create GC's that depend on params,
166 * but GC's can also be created from create() or set_param() */
167 typedef void (*VikLayerFuncPostRead) (VikLayer *,gpointer vp);
169 typedef void (*VikLayerFuncFree) (VikLayer *);
171 /* do _not_ use this unless absolutely neccesary. Use the dynamic properties (see coordlayer for example)
172 * returns TRUE if OK was pressed */
173 typedef gboolean (*VikLayerFuncProperties) (VikLayer *,VikViewport *); /* gpointer is a VikViewport */
175 typedef void (*VikLayerFuncDraw) (VikLayer *,VikViewport *);
176 typedef void (*VikLayerFuncChangeCoordMode) (VikLayer *,VikCoordMode);
178 typedef void (*VikLayerFuncAddMenuItems) (VikLayer *,GtkMenu *,gpointer); /* gpointer is a VikLayersPanel */
179 typedef gboolean (*VikLayerFuncSublayerAddMenuItems) (VikLayer *,GtkMenu *,gpointer, /* first gpointer is a VikLayersPanel */
180 gint,gpointer,GtkTreeIter *);
181 typedef const gchar * (*VikLayerFuncSublayerRenameRequest) (VikLayer *,const gchar *,gpointer,
182 gint,VikViewport *,GtkTreeIter *); /* first gpointer is a VikLayersPanel */
183 typedef gboolean (*VikLayerFuncSublayerToggleVisible) (VikLayer *,gint,gpointer);
185 typedef VikLayer * (*VikLayerFuncCopy) (VikLayer *,VikViewport *);
186 typedef void (*VikLayerFuncMarshall) (VikLayer *, guint8 **, gint *);
187 typedef VikLayer * (*VikLayerFuncUnmarshall) (guint8 *, gint, VikViewport *);
189 /* returns TRUE if needs to redraw due to changed param */
190 typedef gboolean (*VikLayerFuncSetParam) (VikLayer *, guint16, VikLayerParamData, VikViewport *);
192 typedef VikLayerParamData
193 (*VikLayerFuncGetParam) (VikLayer *, guint16);
195 typedef void (*VikLayerFuncReadFileData) (VikLayer *, FILE *);
196 typedef void (*VikLayerFuncWriteFileData) (VikLayer *, FILE *);
198 /* item manipulation */
199 typedef void (*VikLayerFuncDeleteItem) (VikLayer *, gint, gpointer);
200 /* layer, subtype, pointer to sub-item */
201 typedef void (*VikLayerFuncCopyItem) (VikLayer *, gint, gpointer, guint8 **, guint *);
202 /* layer, subtype, pointer to sub-item, return pointer, return len */
203 typedef gboolean (*VikLayerFuncPasteItem) (VikLayer *, gint, guint8 *, guint);
204 typedef void (*VikLayerFuncFreeCopiedItem) (gint, gpointer);
206 /* treeview drag and drop method. called on the destination layer. it is given a source and destination layer,
207 * and the source and destination iters in the treeview.
209 typedef void (*VikLayerFuncDragDropRequest) (VikLayer *, VikLayer *, GtkTreeIter *, GtkTreePath *);
212 typedef struct _VikLayerInterface VikLayerInterface;
214 /* See vik_layer_* for function parameter names */
215 struct _VikLayerInterface {
217 const GdkPixdata * icon;
219 VikToolInterface * tools;
222 /* for I/O reading to and from .vik files -- params like coordline width, color, etc. */
223 VikLayerParam * params;
224 guint16 params_count;
225 gchar ** params_groups;
226 guint8 params_groups_count;
228 VikLayerFuncCreate create;
229 VikLayerFuncRealize realize;
230 VikLayerFuncPostRead post_read;
231 VikLayerFuncFree free;
233 VikLayerFuncProperties properties;
234 VikLayerFuncDraw draw;
235 VikLayerFuncChangeCoordMode change_coord_mode;
237 VikLayerFuncAddMenuItems add_menu_items;
238 VikLayerFuncSublayerAddMenuItems sublayer_add_menu_items;
239 VikLayerFuncSublayerRenameRequest sublayer_rename_request;
240 VikLayerFuncSublayerToggleVisible sublayer_toggle_visible;
242 VikLayerFuncCopy copy;
243 VikLayerFuncMarshall marshall;
244 VikLayerFuncUnmarshall unmarshall;
247 VikLayerFuncSetParam set_param;
248 VikLayerFuncGetParam get_param;
250 /* for I/O -- extra non-param data like TrwLayer data */
251 VikLayerFuncReadFileData read_file_data;
252 VikLayerFuncWriteFileData write_file_data;
254 VikLayerFuncDeleteItem delete_item;
255 VikLayerFuncCopyItem copy_item;
256 VikLayerFuncPasteItem paste_item;
257 VikLayerFuncFreeCopiedItem free_copied_item;
259 VikLayerFuncDragDropRequest drag_drop_request;
262 VikLayerInterface *vik_layer_get_interface ( gint type );
265 void vik_layer_init ( VikLayer *vl, gint type );
266 void vik_layer_draw ( VikLayer *l, gpointer data );
267 void vik_layer_change_coord_mode ( VikLayer *l, VikCoordMode mode );
268 void vik_layer_rename ( VikLayer *l, const gchar *new_name );
269 void vik_layer_rename_no_copy ( VikLayer *l, gchar *new_name );
271 gboolean vik_layer_set_param (VikLayer *layer, guint16 id, VikLayerParamData data, gpointer vp);
273 void vik_layer_emit_update ( VikLayer *vl );
276 void vik_layer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp );
277 VikLayer *vik_layer_create ( gint type, gpointer vp, GtkWindow *w, gboolean interactive );
278 gboolean vik_layer_properties ( VikLayer *layer, gpointer vp );
280 void vik_layer_realize ( VikLayer *l, VikTreeview *vt, GtkTreeIter * layer_iter );
281 void vik_layer_post_read ( VikLayer *layer, gpointer vp );
283 gboolean vik_layer_sublayer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter );
285 VikLayer *vik_layer_copy ( VikLayer *vl, gpointer vp );
286 void vik_layer_marshall ( VikLayer *vl, guint8 **data, gint *len );
287 VikLayer *vik_layer_unmarshall ( guint8 *data, gint len, VikViewport *vvp );
288 void vik_layer_marshall_params ( VikLayer *vl, guint8 **data, gint *len );
289 void vik_layer_unmarshall_params ( VikLayer *vl, guint8 *data, gint len, VikViewport *vvp );
291 const gchar *vik_layer_sublayer_rename_request ( VikLayer *l, const gchar *newname, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter );
293 gboolean vik_layer_sublayer_toggle_visible ( VikLayer *l, gint subtype, gpointer sublayer );
295 /* TODO: put in layerspanel */
296 GdkPixbuf *vik_layer_load_icon ( gint type );