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
22 #ifndef _VIKING_LAYER_H
23 #define _VIKING_LAYER_H
25 #define VIK_LAYER_TYPE (vik_layer_get_type ())
26 #define VIK_LAYER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), VIK_LAYER_TYPE, VikLayer))
27 #define VIK_LAYER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), VIK_LAYER_TYPE, VikLayerClass))
28 #define IS_VIK_LAYER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), VIK_LAYER_TYPE))
29 #define IS_VIK_LAYER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), VIK_LAYER_TYPE))
31 typedef struct _VikLayer VikLayer;
32 typedef struct _VikLayerClass VikLayerClass;
36 GObjectClass object_class;
37 void (* update) (VikLayer *vl);
40 GType vik_layer_get_type ();
48 VikTreeview *vt; /* simply a refernce */
51 /* for explicit "polymorphism" (function type switching) */
58 VIK_LAYER_AGGREGATE = 0,
66 typedef enum { VIK_LAYER_TOOL_IGNORED=0,
68 VIK_LAYER_TOOL_ACK_REDRAW_ABOVE,
69 VIK_LAYER_TOOL_ACK_REDRAW_ALL,
70 VIK_LAYER_TOOL_ACK_REDRAW_IF_VISIBLE }
71 VikLayerToolFuncStatus;
72 typedef VikLayerToolFuncStatus (*VikToolInterfaceFunc) (VikLayer *,GdkEventButton *,gpointer);
74 /* gpointer is viewport */
76 typedef struct _VikToolInterface VikToolInterface;
77 struct _VikToolInterface {
79 VikToolInterfaceFunc callback;
80 VikToolInterfaceFunc callback_release;
83 /* Parameters (for I/O and Properties) */
100 const gpointer widget_data;
101 const gpointer extra_widget_data;
105 VIK_LAYER_NOT_IN_PROPERTIES=-2,
106 VIK_LAYER_GROUP_NONE=-1
110 VIK_LAYER_WIDGET_CHECKBUTTON=0,
111 VIK_LAYER_WIDGET_RADIOGROUP,
112 VIK_LAYER_WIDGET_SPINBUTTON,
113 VIK_LAYER_WIDGET_ENTRY,
114 VIK_LAYER_WIDGET_FILEENTRY,
115 VIK_LAYER_WIDGET_HSCALE,
116 VIK_LAYER_WIDGET_COLOR,
117 VIK_LAYER_WIDGET_COMBOBOX,
125 } VikLayerParamScale;
129 VIK_LAYER_PARAM_DOUBLE=1,
130 VIK_LAYER_PARAM_UINT,
132 VIK_LAYER_PARAM_STRING,
133 VIK_LAYER_PARAM_BOOLEAN,
134 VIK_LAYER_PARAM_COLOR,
137 /* layer interface functions */
139 /* Create a new layer of a certain type. Should be filled with defaults */
140 typedef VikLayer * (*VikLayerFuncCreate) (VikViewport *);
142 /* normally only needed for layers with sublayers. This is called when they
143 * are added to the treeview so they can add sublayers to the treeview. */
144 typedef void (*VikLayerFuncRealize) (VikLayer *,VikTreeview *,GtkTreeIter *);
146 /* rarely used, this is called after a read operation or properties box is run.
147 * usually used to create GC's that depend on params,
148 * but GC's can also be created from create() or set_param() */
149 typedef void (*VikLayerFuncPostRead) (VikLayer *,gpointer vp);
151 typedef void (*VikLayerFuncFree) (VikLayer *);
153 /* do _not_ use this unless absolutely neccesary. Use the dynamic properties (see coordlayer for example)
154 * returns TRUE if OK was pressed */
155 typedef gboolean (*VikLayerFuncProperties) (VikLayer *,VikViewport *); /* gpointer is a VikViewport */
157 typedef void (*VikLayerFuncDraw) (VikLayer *,VikViewport *);
158 typedef void (*VikLayerFuncChangeCoordMode) (VikLayer *,VikCoordMode);
160 typedef void (*VikLayerFuncAddMenuItems) (VikLayer *,GtkMenu *,gpointer); /* gpointer is a VikLayersPanel */
161 typedef gboolean (*VikLayerFuncSublayerAddMenuItems) (VikLayer *,GtkMenu *,gpointer, /* first gpointer is a VikLayersPanel */
162 gint,gpointer,GtkTreeIter *);
163 typedef const gchar * (*VikLayerFuncSublayerRenameRequest) (VikLayer *,const gchar *,gpointer,
164 gint,VikViewport *,GtkTreeIter *); /* first gpointer is a VikLayersPanel */
165 typedef gboolean (*VikLayerFuncSublayerToggleVisible) (VikLayer *,gint,gpointer);
167 typedef VikLayer * (*VikLayerFuncCopy) (VikLayer *,VikViewport *);
169 /* returns TRUE if needs to redraw due to changed param */
170 typedef gboolean (*VikLayerFuncSetParam) (VikLayer *, guint16, VikLayerParamData, VikViewport *);
172 typedef VikLayerParamData
173 (*VikLayerFuncGetParam) (VikLayer *, guint16);
175 typedef void (*VikLayerFuncReadFileData) (VikLayer *, FILE *);
176 typedef void (*VikLayerFuncWriteFileData) (VikLayer *, FILE *);
178 typedef gpointer (*VikLayerFuncCopyItem) (VikLayer *, gint, gpointer);
179 typedef gboolean (*VikLayerFuncPasteItem) (VikLayer *, gint, gpointer);
180 typedef void (*VikLayerFuncFreeCopiedItem) (gint, gpointer);
183 typedef struct _VikLayerInterface VikLayerInterface;
185 /* See vik_layer_* for function parameter names */
186 struct _VikLayerInterface {
188 const GdkPixdata * icon;
190 VikToolInterface * tools;
193 /* for I/O reading to and from .vik files -- params like coordline width, color, etc. */
194 VikLayerParam * params;
195 guint16 params_count;
196 gchar ** params_groups;
197 guint8 params_groups_count;
199 VikLayerFuncCreate create;
200 VikLayerFuncRealize realize;
201 VikLayerFuncPostRead post_read;
202 VikLayerFuncFree free;
204 VikLayerFuncProperties properties;
205 VikLayerFuncDraw draw;
206 VikLayerFuncChangeCoordMode change_coord_mode;
208 VikLayerFuncAddMenuItems add_menu_items;
209 VikLayerFuncSublayerAddMenuItems sublayer_add_menu_items;
210 VikLayerFuncSublayerRenameRequest sublayer_rename_request;
211 VikLayerFuncSublayerToggleVisible sublayer_toggle_visible;
213 VikLayerFuncCopy copy;
216 VikLayerFuncSetParam set_param;
217 VikLayerFuncGetParam get_param;
219 /* for I/O -- extra non-param data like TrwLayer data */
220 VikLayerFuncReadFileData read_file_data;
221 VikLayerFuncWriteFileData write_file_data;
223 VikLayerFuncCopyItem copy_item;
224 VikLayerFuncPasteItem paste_item;
225 VikLayerFuncFreeCopiedItem free_copied_item;
228 VikLayerInterface *vik_layer_get_interface ( gint type );
231 void vik_layer_init ( VikLayer *vl, gint type );
232 void vik_layer_draw ( VikLayer *l, gpointer data );
233 void vik_layer_change_coord_mode ( VikLayer *l, VikCoordMode mode );
234 void vik_layer_rename ( VikLayer *l, const gchar *new_name );
235 void vik_layer_rename_no_copy ( VikLayer *l, gchar *new_name );
237 gboolean vik_layer_set_param (VikLayer *layer, guint16 id, VikLayerParamData data, gpointer vp);
239 void vik_layer_emit_update ( VikLayer *vl );
242 void vik_layer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp );
243 VikLayer *vik_layer_create ( gint type, gpointer vp, GtkWindow *w, gboolean interactive );
244 gboolean vik_layer_properties ( VikLayer *layer, gpointer vp );
246 void vik_layer_realize ( VikLayer *l, VikTreeview *vt, GtkTreeIter * layer_iter );
247 void vik_layer_post_read ( VikLayer *layer, gpointer vp );
249 gboolean vik_layer_sublayer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter );
251 VikLayer *vik_layer_copy ( VikLayer *vl, gpointer vp );
253 const gchar *vik_layer_sublayer_rename_request ( VikLayer *l, const gchar *newname, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter );
255 gboolean vik_layer_sublayer_toggle_visible ( VikLayer *l, gint subtype, gpointer sublayer );
257 /* TODO: put in layerspanel */
258 GdkPixbuf *vik_layer_load_icon ( gint type );