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>
29 #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 _VikLayerClass VikLayerClass;
43 GObjectClass object_class;
44 void (* update) (VikLayer *vl);
47 GType vik_layer_get_type ();
55 VikTreeview *vt; /* simply a refernce */
58 /* for explicit "polymorphism" (function type switching) */
65 VIK_LAYER_AGGREGATE = 0,
75 VIK_LAYER_TOOL_IGNORED=0,
77 VIK_LAYER_TOOL_ACK_REDRAW_ABOVE,
78 VIK_LAYER_TOOL_ACK_REDRAW_ALL,
79 VIK_LAYER_TOOL_ACK_REDRAW_IF_VISIBLE
80 } VikLayerToolFuncStatus;
82 /* gpointer is tool-specific state created in the constructor */
83 typedef gpointer (*VikToolConstructorFunc) (VikWindow *, VikViewport *);
84 typedef void (*VikToolDestructorFunc) (gpointer);
85 typedef VikLayerToolFuncStatus (*VikToolMouseFunc) (VikLayer *, GdkEventButton *, gpointer);
86 typedef void (*VikToolActivationFunc) (VikLayer *, gpointer);
88 typedef struct _VikToolInterface VikToolInterface;
89 struct _VikToolInterface {
91 VikToolConstructorFunc create;
92 VikToolDestructorFunc destroy;
93 VikToolActivationFunc activate;
94 VikToolActivationFunc deactivate;
95 VikToolMouseFunc click;
96 VikToolMouseFunc move;
97 VikToolMouseFunc release;
100 /* Parameters (for I/O and Properties) */
117 gpointer widget_data;
118 gpointer extra_widget_data;
122 VIK_LAYER_NOT_IN_PROPERTIES=-2,
123 VIK_LAYER_GROUP_NONE=-1
127 VIK_LAYER_WIDGET_CHECKBUTTON=0,
128 VIK_LAYER_WIDGET_RADIOGROUP,
129 VIK_LAYER_WIDGET_SPINBUTTON,
130 VIK_LAYER_WIDGET_ENTRY,
131 VIK_LAYER_WIDGET_FILEENTRY,
132 VIK_LAYER_WIDGET_HSCALE,
133 VIK_LAYER_WIDGET_COLOR,
134 VIK_LAYER_WIDGET_COMBOBOX,
142 } VikLayerParamScale;
146 VIK_LAYER_PARAM_DOUBLE=1,
147 VIK_LAYER_PARAM_UINT,
149 VIK_LAYER_PARAM_STRING,
150 VIK_LAYER_PARAM_BOOLEAN,
151 VIK_LAYER_PARAM_COLOR,
154 /* layer interface functions */
156 /* Create a new layer of a certain type. Should be filled with defaults */
157 typedef VikLayer * (*VikLayerFuncCreate) (VikViewport *);
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. */
161 typedef void (*VikLayerFuncRealize) (VikLayer *,VikTreeview *,GtkTreeIter *);
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() */
166 typedef void (*VikLayerFuncPostRead) (VikLayer *,gpointer vp);
168 typedef void (*VikLayerFuncFree) (VikLayer *);
170 /* do _not_ use this unless absolutely neccesary. Use the dynamic properties (see coordlayer for example)
171 * returns TRUE if OK was pressed */
172 typedef gboolean (*VikLayerFuncProperties) (VikLayer *,VikViewport *); /* gpointer is a VikViewport */
174 typedef void (*VikLayerFuncDraw) (VikLayer *,VikViewport *);
175 typedef void (*VikLayerFuncChangeCoordMode) (VikLayer *,VikCoordMode);
177 typedef void (*VikLayerFuncSetMenuItemsSelection) (VikLayer *,guint16);
178 typedef guint16 (*VikLayerFuncGetMenuItemsSelection) (VikLayer *);
179 typedef void (*VikLayerFuncAddMenuItems) (VikLayer *,GtkMenu *,gpointer); /* gpointer is a VikLayersPanel */
180 typedef gboolean (*VikLayerFuncSublayerAddMenuItems) (VikLayer *,GtkMenu *,gpointer, /* first gpointer is a VikLayersPanel */
181 gint,gpointer,GtkTreeIter *);
182 typedef const gchar * (*VikLayerFuncSublayerRenameRequest) (VikLayer *,const gchar *,gpointer,
183 gint,VikViewport *,GtkTreeIter *); /* first gpointer is a VikLayersPanel */
184 typedef gboolean (*VikLayerFuncSublayerToggleVisible) (VikLayer *,gint,gpointer);
186 typedef VikLayer * (*VikLayerFuncCopy) (VikLayer *,VikViewport *);
187 typedef void (*VikLayerFuncMarshall) (VikLayer *, guint8 **, gint *);
188 typedef VikLayer * (*VikLayerFuncUnmarshall) (guint8 *, gint, VikViewport *);
190 /* returns TRUE if needs to redraw due to changed param */
191 typedef gboolean (*VikLayerFuncSetParam) (VikLayer *, guint16, VikLayerParamData, VikViewport *);
193 typedef VikLayerParamData
194 (*VikLayerFuncGetParam) (VikLayer *, guint16);
196 typedef void (*VikLayerFuncReadFileData) (VikLayer *, FILE *);
197 typedef void (*VikLayerFuncWriteFileData) (VikLayer *, FILE *);
199 /* item manipulation */
200 typedef void (*VikLayerFuncDeleteItem) (VikLayer *, gint, gpointer);
201 /* layer, subtype, pointer to sub-item */
202 typedef void (*VikLayerFuncCopyItem) (VikLayer *, gint, gpointer, guint8 **, guint *);
203 /* layer, subtype, pointer to sub-item, return pointer, return len */
204 typedef gboolean (*VikLayerFuncPasteItem) (VikLayer *, gint, guint8 *, guint);
205 typedef void (*VikLayerFuncFreeCopiedItem) (gint, gpointer);
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.
210 typedef void (*VikLayerFuncDragDropRequest) (VikLayer *, VikLayer *, GtkTreeIter *, GtkTreePath *);
213 VIK_MENU_ITEM_PROPERTY=1,
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;
221 typedef struct _VikLayerInterface VikLayerInterface;
223 /* See vik_layer_* for function parameter names */
224 struct _VikLayerInterface {
226 const GdkPixdata * icon;
228 VikToolInterface * tools;
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;
237 /* menu items to be created */
238 VikStdLayerMenuItem menu_items_selection;
240 VikLayerFuncCreate create;
241 VikLayerFuncRealize realize;
242 VikLayerFuncPostRead post_read;
243 VikLayerFuncFree free;
245 VikLayerFuncProperties properties;
246 VikLayerFuncDraw draw;
247 VikLayerFuncChangeCoordMode change_coord_mode;
249 VikLayerFuncSetMenuItemsSelection set_menu_selection;
250 VikLayerFuncGetMenuItemsSelection get_menu_selection;
252 VikLayerFuncAddMenuItems add_menu_items;
253 VikLayerFuncSublayerAddMenuItems sublayer_add_menu_items;
254 VikLayerFuncSublayerRenameRequest sublayer_rename_request;
255 VikLayerFuncSublayerToggleVisible sublayer_toggle_visible;
257 VikLayerFuncCopy copy;
258 VikLayerFuncMarshall marshall;
259 VikLayerFuncUnmarshall unmarshall;
262 VikLayerFuncSetParam set_param;
263 VikLayerFuncGetParam get_param;
265 /* for I/O -- extra non-param data like TrwLayer data */
266 VikLayerFuncReadFileData read_file_data;
267 VikLayerFuncWriteFileData write_file_data;
269 VikLayerFuncDeleteItem delete_item;
270 VikLayerFuncCopyItem copy_item;
271 VikLayerFuncPasteItem paste_item;
272 VikLayerFuncFreeCopiedItem free_copied_item;
274 VikLayerFuncDragDropRequest drag_drop_request;
277 VikLayerInterface *vik_layer_get_interface ( gint type );
280 void vik_layer_init ( VikLayer *vl, gint type );
281 void vik_layer_draw ( VikLayer *l, gpointer data );
282 void vik_layer_change_coord_mode ( VikLayer *l, VikCoordMode mode );
283 void vik_layer_rename ( VikLayer *l, const gchar *new_name );
284 void vik_layer_rename_no_copy ( VikLayer *l, gchar *new_name );
286 gboolean vik_layer_set_param (VikLayer *layer, guint16 id, VikLayerParamData data, gpointer vp);
288 void vik_layer_emit_update ( VikLayer *vl );
291 void vik_layer_set_menu_items_selection(VikLayer *l, guint16 selection);
292 guint16 vik_layer_get_menu_items_selection(VikLayer *l);
293 void vik_layer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp );
294 VikLayer *vik_layer_create ( gint type, gpointer vp, GtkWindow *w, gboolean interactive );
295 gboolean vik_layer_properties ( VikLayer *layer, gpointer vp );
297 void vik_layer_realize ( VikLayer *l, VikTreeview *vt, GtkTreeIter * layer_iter );
298 void vik_layer_post_read ( VikLayer *layer, gpointer vp );
300 gboolean vik_layer_sublayer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter );
302 VikLayer *vik_layer_copy ( VikLayer *vl, gpointer vp );
303 void vik_layer_marshall ( VikLayer *vl, guint8 **data, gint *len );
304 VikLayer *vik_layer_unmarshall ( guint8 *data, gint len, VikViewport *vvp );
305 void vik_layer_marshall_params ( VikLayer *vl, guint8 **data, gint *len );
306 void vik_layer_unmarshall_params ( VikLayer *vl, guint8 *data, gint len, VikViewport *vvp );
308 const gchar *vik_layer_sublayer_rename_request ( VikLayer *l, const gchar *newname, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter );
310 gboolean vik_layer_sublayer_toggle_visible ( VikLayer *l, gint subtype, gpointer sublayer );
312 /* TODO: put in layerspanel */
313 GdkPixbuf *vik_layer_load_icon ( gint type );