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 _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 reference */
59 /* for explicit "polymorphism" (function type switching) */
66 VIK_LAYER_AGGREGATE = 0,
77 VIK_LAYER_TOOL_IGNORED=0,
79 VIK_LAYER_TOOL_ACK_REDRAW_ABOVE,
80 VIK_LAYER_TOOL_ACK_REDRAW_ALL,
81 VIK_LAYER_TOOL_ACK_REDRAW_IF_VISIBLE
82 } VikLayerToolFuncStatus;
84 /* gpointer is tool-specific state created in the constructor */
85 typedef gpointer (*VikToolConstructorFunc) (VikWindow *, VikViewport *);
86 typedef void (*VikToolDestructorFunc) (gpointer);
87 typedef VikLayerToolFuncStatus (*VikToolMouseFunc) (VikLayer *, GdkEventButton *, gpointer);
88 typedef void (*VikToolActivationFunc) (VikLayer *, gpointer);
90 typedef struct _VikToolInterface VikToolInterface;
91 struct _VikToolInterface {
93 VikToolConstructorFunc create;
94 VikToolDestructorFunc destroy;
95 VikToolActivationFunc activate;
96 VikToolActivationFunc deactivate;
97 VikToolMouseFunc click;
98 VikToolMouseFunc move;
99 VikToolMouseFunc release;
102 /* Parameters (for I/O and Properties) */
120 gpointer widget_data;
121 gpointer extra_widget_data;
125 VIK_LAYER_NOT_IN_PROPERTIES=-2,
126 VIK_LAYER_GROUP_NONE=-1
130 VIK_LAYER_WIDGET_CHECKBUTTON=0,
131 VIK_LAYER_WIDGET_RADIOGROUP,
132 VIK_LAYER_WIDGET_RADIOGROUP_STATIC,
133 VIK_LAYER_WIDGET_SPINBUTTON,
134 VIK_LAYER_WIDGET_ENTRY,
135 VIK_LAYER_WIDGET_FILEENTRY,
136 VIK_LAYER_WIDGET_HSCALE,
137 VIK_LAYER_WIDGET_COLOR,
138 VIK_LAYER_WIDGET_COMBOBOX,
139 VIK_LAYER_WIDGET_FILELIST,
147 } VikLayerParamScale;
151 VIK_LAYER_PARAM_DOUBLE=1,
152 VIK_LAYER_PARAM_UINT,
154 VIK_LAYER_PARAM_STRING,
155 VIK_LAYER_PARAM_BOOLEAN,
156 VIK_LAYER_PARAM_COLOR,
158 /* NOTE: string layer works auniquely: data.sl should NOT be free'd when
159 * the internals call get_param -- i.e. it should be managed w/in the layer.
160 * The value passed by the internals into set_param should also be managed
161 * by the layer -- i.e. free'd by the layer.
164 VIK_LAYER_PARAM_STRING_LIST,
167 /* layer interface functions */
169 /* Create a new layer of a certain type. Should be filled with defaults */
170 typedef VikLayer * (*VikLayerFuncCreate) (VikViewport *);
172 /* normally only needed for layers with sublayers. This is called when they
173 * are added to the treeview so they can add sublayers to the treeview. */
174 typedef void (*VikLayerFuncRealize) (VikLayer *,VikTreeview *,GtkTreeIter *);
176 /* rarely used, this is called after a read operation or properties box is run.
177 * usually used to create GC's that depend on params,
178 * but GC's can also be created from create() or set_param() */
179 typedef void (*VikLayerFuncPostRead) (VikLayer *,VikViewport *vp,gboolean from_file);
181 typedef void (*VikLayerFuncFree) (VikLayer *);
183 /* do _not_ use this unless absolutely neccesary. Use the dynamic properties (see coordlayer for example)
184 * returns TRUE if OK was pressed */
185 typedef gboolean (*VikLayerFuncProperties) (VikLayer *,VikViewport *);
187 typedef void (*VikLayerFuncDraw) (VikLayer *,VikViewport *);
188 typedef void (*VikLayerFuncChangeCoordMode) (VikLayer *,VikCoordMode);
190 typedef void (*VikLayerFuncSetMenuItemsSelection) (VikLayer *,guint16);
191 typedef guint16 (*VikLayerFuncGetMenuItemsSelection) (VikLayer *);
192 typedef void (*VikLayerFuncAddMenuItems) (VikLayer *,GtkMenu *,gpointer); /* gpointer is a VikLayersPanel */
193 typedef gboolean (*VikLayerFuncSublayerAddMenuItems) (VikLayer *,GtkMenu *,gpointer, /* first gpointer is a VikLayersPanel */
194 gint,gpointer,GtkTreeIter *);
195 typedef const gchar * (*VikLayerFuncSublayerRenameRequest) (VikLayer *,const gchar *,gpointer,
196 gint,VikViewport *,GtkTreeIter *); /* first gpointer is a VikLayersPanel */
197 typedef gboolean (*VikLayerFuncSublayerToggleVisible) (VikLayer *,gint,gpointer);
199 typedef void (*VikLayerFuncMarshall) (VikLayer *, guint8 **, gint *);
200 typedef VikLayer * (*VikLayerFuncUnmarshall) (guint8 *, gint, VikViewport *);
202 /* returns TRUE if needs to redraw due to changed param */
203 typedef gboolean (*VikLayerFuncSetParam) (VikLayer *, guint16, VikLayerParamData, VikViewport *);
205 typedef VikLayerParamData
206 (*VikLayerFuncGetParam) (VikLayer *, guint16);
208 typedef void (*VikLayerFuncReadFileData) (VikLayer *, FILE *);
209 typedef void (*VikLayerFuncWriteFileData) (VikLayer *, FILE *);
211 /* item manipulation */
212 typedef void (*VikLayerFuncDeleteItem) (VikLayer *, gint, gpointer);
213 /* layer, subtype, pointer to sub-item */
214 typedef void (*VikLayerFuncCopyItem) (VikLayer *, gint, gpointer, guint8 **, guint *);
215 /* layer, subtype, pointer to sub-item, return pointer, return len */
216 typedef gboolean (*VikLayerFuncPasteItem) (VikLayer *, gint, guint8 *, guint);
217 typedef void (*VikLayerFuncFreeCopiedItem) (gint, gpointer);
219 /* treeview drag and drop method. called on the destination layer. it is given a source and destination layer,
220 * and the source and destination iters in the treeview.
222 typedef void (*VikLayerFuncDragDropRequest) (VikLayer *, VikLayer *, GtkTreeIter *, GtkTreePath *);
225 VIK_MENU_ITEM_PROPERTY=1,
227 VIK_MENU_ITEM_COPY=4,
228 VIK_MENU_ITEM_PASTE=8,
229 VIK_MENU_ITEM_DELETE=16,
230 VIK_MENU_ITEM_ALL=0xff
231 } VikStdLayerMenuItem;
233 typedef struct _VikLayerInterface VikLayerInterface;
235 /* See vik_layer_* for function parameter names */
236 struct _VikLayerInterface {
238 const GdkPixdata * icon;
240 VikToolInterface * tools;
243 /* for I/O reading to and from .vik files -- params like coordline width, color, etc. */
244 VikLayerParam * params;
245 guint16 params_count;
246 gchar ** params_groups;
247 guint8 params_groups_count;
249 /* menu items to be created */
250 VikStdLayerMenuItem menu_items_selection;
252 VikLayerFuncCreate create;
253 VikLayerFuncRealize realize;
254 VikLayerFuncPostRead post_read;
255 VikLayerFuncFree free;
257 VikLayerFuncProperties properties;
258 VikLayerFuncDraw draw;
259 VikLayerFuncChangeCoordMode change_coord_mode;
261 VikLayerFuncSetMenuItemsSelection set_menu_selection;
262 VikLayerFuncGetMenuItemsSelection get_menu_selection;
264 VikLayerFuncAddMenuItems add_menu_items;
265 VikLayerFuncSublayerAddMenuItems sublayer_add_menu_items;
266 VikLayerFuncSublayerRenameRequest sublayer_rename_request;
267 VikLayerFuncSublayerToggleVisible sublayer_toggle_visible;
269 VikLayerFuncMarshall marshall;
270 VikLayerFuncUnmarshall unmarshall;
273 VikLayerFuncSetParam set_param;
274 VikLayerFuncGetParam get_param;
276 /* for I/O -- extra non-param data like TrwLayer data */
277 VikLayerFuncReadFileData read_file_data;
278 VikLayerFuncWriteFileData write_file_data;
280 VikLayerFuncDeleteItem delete_item;
281 VikLayerFuncCopyItem copy_item;
282 VikLayerFuncPasteItem paste_item;
283 VikLayerFuncFreeCopiedItem free_copied_item;
285 VikLayerFuncDragDropRequest drag_drop_request;
288 VikLayerInterface *vik_layer_get_interface ( gint type );
291 void vik_layer_init ( VikLayer *vl, gint type );
292 void vik_layer_draw ( VikLayer *l, gpointer data );
293 void vik_layer_change_coord_mode ( VikLayer *l, VikCoordMode mode );
294 void vik_layer_rename ( VikLayer *l, const gchar *new_name );
295 void vik_layer_rename_no_copy ( VikLayer *l, gchar *new_name );
296 const gchar *vik_layer_get_name ( VikLayer *l );
298 gboolean vik_layer_set_param (VikLayer *layer, guint16 id, VikLayerParamData data, gpointer vp);
300 void vik_layer_emit_update ( VikLayer *vl );
303 void vik_layer_set_menu_items_selection(VikLayer *l, guint16 selection);
304 guint16 vik_layer_get_menu_items_selection(VikLayer *l);
305 void vik_layer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp );
306 VikLayer *vik_layer_create ( gint type, gpointer vp, GtkWindow *w, gboolean interactive );
307 gboolean vik_layer_properties ( VikLayer *layer, gpointer vp );
309 void vik_layer_realize ( VikLayer *l, VikTreeview *vt, GtkTreeIter * layer_iter );
310 void vik_layer_post_read ( VikLayer *layer, VikViewport *vp, gboolean from_file );
312 gboolean vik_layer_sublayer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter );
314 VikLayer *vik_layer_copy ( VikLayer *vl, gpointer vp );
315 void vik_layer_marshall ( VikLayer *vl, guint8 **data, gint *len );
316 VikLayer *vik_layer_unmarshall ( guint8 *data, gint len, VikViewport *vvp );
317 void vik_layer_marshall_params ( VikLayer *vl, guint8 **data, gint *len );
318 void vik_layer_unmarshall_params ( VikLayer *vl, guint8 *data, gint len, VikViewport *vvp );
320 const gchar *vik_layer_sublayer_rename_request ( VikLayer *l, const gchar *newname, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter );
322 gboolean vik_layer_sublayer_toggle_visible ( VikLayer *l, gint subtype, gpointer sublayer );
324 /* TODO: put in layerspanel */
325 GdkPixbuf *vik_layer_load_icon ( gint type );