src/viklayer.h

/*
 * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
 *
 * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */
#include <stdio.h>

#ifndef _VIKING_LAYER_H
#define _VIKING_LAYER_H

#define VIK_LAYER_TYPE            (vik_layer_get_type ())
#define VIK_LAYER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), VIK_LAYER_TYPE, VikLayer))
#define VIK_LAYER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), VIK_LAYER_TYPE, VikLayerClass))
#define IS_VIK_LAYER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), VIK_LAYER_TYPE))
#define IS_VIK_LAYER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), VIK_LAYER_TYPE))

typedef struct _VikLayer VikLayer;
typedef struct _VikLayerClass VikLayerClass;

struct _VikLayerClass
{
  GObjectClass object_class;
  void (* update) (VikLayer *vl);
};

GType vik_layer_get_type ();

struct _VikLayer {
  GObject obj;
  gchar *name;
  gboolean visible;

  gboolean realized;
  VikTreeview *vt; /* simply a refernce */
  GtkTreeIter iter;

  /* for explicit "polymorphism" (function type switching) */
  guint16 type;
};


enum {
VIK_LAYER_AGGREGATE = 0,
VIK_LAYER_TRW,
VIK_LAYER_COORD,
VIK_LAYER_GEOREF,
VIK_LAYER_MAPS,
VIK_LAYER_NUM_TYPES
};

typedef enum { VIK_LAYER_TOOL_IGNORED=0,
               VIK_LAYER_TOOL_ACK,
               VIK_LAYER_TOOL_ACK_REDRAW_ABOVE,
               VIK_LAYER_TOOL_ACK_REDRAW_ALL,
               VIK_LAYER_TOOL_ACK_REDRAW_IF_VISIBLE }
        VikLayerToolFuncStatus;
typedef VikLayerToolFuncStatus (*VikToolInterfaceFunc) (VikLayer *,GdkEventButton *,gpointer);

/* gpointer is viewport */

typedef struct _VikToolInterface VikToolInterface;
struct _VikToolInterface {
  gchar *name;
  VikToolInterfaceFunc callback;
  VikToolInterfaceFunc callback_release;
};

/* Parameters (for I/O and Properties) */

typedef union {
  gdouble d;
  guint32 u;
  gint32 i;
  gboolean b;
  const gchar *s;
  GdkColor c;
} VikLayerParamData;

typedef struct {
  const gchar *name;
  guint8 type;
  gint16 group;
  const gchar *title;
  guint8 widget_type;
  const gpointer widget_data;
  const gpointer extra_widget_data;
} VikLayerParam;

enum {
VIK_LAYER_NOT_IN_PROPERTIES=-2,
VIK_LAYER_GROUP_NONE=-1
};

enum {
VIK_LAYER_WIDGET_CHECKBUTTON=0,
VIK_LAYER_WIDGET_RADIOGROUP,
VIK_LAYER_WIDGET_SPINBUTTON,
VIK_LAYER_WIDGET_ENTRY,
VIK_LAYER_WIDGET_FILEENTRY,
VIK_LAYER_WIDGET_HSCALE,
VIK_LAYER_WIDGET_COLOR,
VIK_LAYER_WIDGET_COMBOBOX,
};

typedef struct {
  gdouble min;
  gdouble max;
  gdouble step;
  guint8 digits;
} VikLayerParamScale;

/* id is index */
enum {
VIK_LAYER_PARAM_DOUBLE=1,
VIK_LAYER_PARAM_UINT,
VIK_LAYER_PARAM_INT,
VIK_LAYER_PARAM_STRING,
VIK_LAYER_PARAM_BOOLEAN,
VIK_LAYER_PARAM_COLOR,
};

/* layer interface functions */

/* Create a new layer of a certain type. Should be filled with defaults */
typedef VikLayer *    (*VikLayerFuncCreate)                (VikViewport *);

/* normally only needed for layers with sublayers. This is called when they
 * are added to the treeview so they can add sublayers to the treeview. */
typedef void          (*VikLayerFuncRealize)               (VikLayer *,VikTreeview *,GtkTreeIter *);

/* rarely used, this is called after a read operation or properties box is run.
 * usually used to create GC's that depend on params,
 * but GC's can also be created from create() or set_param() */
typedef void          (*VikLayerFuncPostRead)              (VikLayer *,gpointer vp);

typedef void          (*VikLayerFuncFree)                  (VikLayer *);

/* do _not_ use this unless absolutely neccesary. Use the dynamic properties (see coordlayer for example)
  * returns TRUE if OK was pressed */
typedef gboolean      (*VikLayerFuncProperties)            (VikLayer *,VikViewport *); /* gpointer is a VikViewport */

typedef void          (*VikLayerFuncDraw)                  (VikLayer *,VikViewport *);
typedef void          (*VikLayerFuncChangeCoordMode)       (VikLayer *,VikCoordMode);

typedef void          (*VikLayerFuncAddMenuItems)          (VikLayer *,GtkMenu *,gpointer); /* gpointer is a VikLayersPanel */
typedef gboolean      (*VikLayerFuncSublayerAddMenuItems)  (VikLayer *,GtkMenu *,gpointer, /* first gpointer is a VikLayersPanel */
                                                            gint,gpointer,GtkTreeIter *);
typedef const gchar * (*VikLayerFuncSublayerRenameRequest) (VikLayer *,const gchar *,gpointer,
                                                            gint,VikViewport *,GtkTreeIter *); /* first gpointer is a VikLayersPanel */
typedef gboolean      (*VikLayerFuncSublayerToggleVisible) (VikLayer *,gint,gpointer);

typedef VikLayer *    (*VikLayerFuncCopy)                  (VikLayer *,VikViewport *);

/* returns TRUE if needs to redraw due to changed param */
typedef gboolean      (*VikLayerFuncSetParam)              (VikLayer *, guint16, VikLayerParamData, VikViewport *);

typedef VikLayerParamData
                      (*VikLayerFuncGetParam)              (VikLayer *, guint16);

typedef void          (*VikLayerFuncReadFileData)          (VikLayer *, FILE *);
typedef void          (*VikLayerFuncWriteFileData)         (VikLayer *, FILE *);

typedef gpointer      (*VikLayerFuncCopyItem)              (VikLayer *, gint, gpointer);
typedef gboolean      (*VikLayerFuncPasteItem)             (VikLayer *, gint, gpointer);
typedef void          (*VikLayerFuncFreeCopiedItem)        (gint, gpointer);


typedef struct _VikLayerInterface VikLayerInterface;

/* See vik_layer_* for function parameter names */
struct _VikLayerInterface {
  const gchar *                     name;
  const GdkPixdata *                icon;

  VikToolInterface *                tools;
  guint16                           tools_count;

  /* for I/O reading to and from .vik files -- params like coordline width, color, etc. */
  VikLayerParam *                   params;
  guint16                           params_count;
  gchar **                          params_groups;
  guint8                            params_groups_count;

  VikLayerFuncCreate                create;
  VikLayerFuncRealize               realize;
  VikLayerFuncPostRead              post_read;
  VikLayerFuncFree                  free;

  VikLayerFuncProperties            properties;
  VikLayerFuncDraw                  draw;
  VikLayerFuncChangeCoordMode       change_coord_mode;

  VikLayerFuncAddMenuItems          add_menu_items;
  VikLayerFuncSublayerAddMenuItems  sublayer_add_menu_items;
  VikLayerFuncSublayerRenameRequest sublayer_rename_request;
  VikLayerFuncSublayerToggleVisible sublayer_toggle_visible;

  VikLayerFuncCopy                  copy;

  /* for I/O */
  VikLayerFuncSetParam              set_param;
  VikLayerFuncGetParam              get_param;

  /* for I/O -- extra non-param data like TrwLayer data */
  VikLayerFuncReadFileData          read_file_data;
  VikLayerFuncWriteFileData         write_file_data;

  VikLayerFuncCopyItem              copy_item;
  VikLayerFuncPasteItem             paste_item;
  VikLayerFuncFreeCopiedItem        free_copied_item;
};

VikLayerInterface *vik_layer_get_interface ( gint type );


void vik_layer_init ( VikLayer *vl, gint type );
void vik_layer_draw ( VikLayer *l, gpointer data );
void vik_layer_change_coord_mode ( VikLayer *l, VikCoordMode mode );
void vik_layer_rename ( VikLayer *l, const gchar *new_name );
void vik_layer_rename_no_copy ( VikLayer *l, gchar *new_name );

gboolean vik_layer_set_param (VikLayer *layer, guint16 id, VikLayerParamData data, gpointer vp);

void vik_layer_emit_update ( VikLayer *vl );

/* GUI */
void vik_layer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp );
VikLayer *vik_layer_create ( gint type, gpointer vp, GtkWindow *w, gboolean interactive );
gboolean vik_layer_properties ( VikLayer *layer, gpointer vp );

void vik_layer_realize ( VikLayer *l, VikTreeview *vt, GtkTreeIter * layer_iter );
void vik_layer_post_read ( VikLayer *layer, gpointer vp );

gboolean vik_layer_sublayer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter );

VikLayer *vik_layer_copy ( VikLayer *vl, gpointer vp );

const gchar *vik_layer_sublayer_rename_request ( VikLayer *l, const gchar *newname, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter );

gboolean vik_layer_sublayer_toggle_visible ( VikLayer *l, gint subtype, gpointer sublayer );

/* TODO: put in layerspanel */
GdkPixbuf *vik_layer_load_icon ( gint type );

#endif
Commit	Line	Data
	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	*/
	21	#include <stdio.h>
	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
	32	typedef struct _VikLayer VikLayer;
	33	typedef struct _VikLayerClass VikLayerClass;
	34
	35	struct _VikLayerClass
	36	{
	37	GObjectClass object_class;
	38	void (* update) (VikLayer *vl);
	39	};
	40
	41	GType vik_layer_get_type ();
	42
	43	struct _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
	58	enum {
	59	VIK_LAYER_AGGREGATE = 0,
	60	VIK_LAYER_TRW,
	61	VIK_LAYER_COORD,
	62	VIK_LAYER_GEOREF,
	63	VIK_LAYER_MAPS,
	64	VIK_LAYER_NUM_TYPES
	65	};
	66
	67	typedef 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;
	73	typedef VikLayerToolFuncStatus (VikToolInterfaceFunc) (VikLayer ,GdkEventButton *,gpointer);
	74
	75	/* gpointer is viewport */
	76
	77	typedef struct _VikToolInterface VikToolInterface;
	78	struct _VikToolInterface {
	79	gchar *name;
	80	VikToolInterfaceFunc callback;
	81	VikToolInterfaceFunc callback_release;
	82	};
	83
	84	/* Parameters (for I/O and Properties) */
	85
	86	typedef union {
	87	gdouble d;
	88	guint32 u;
	89	gint32 i;
	90	gboolean b;
	91	const gchar *s;
	92	GdkColor c;
	93	} VikLayerParamData;
	94
	95	typedef 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
	105	enum {
	106	VIK_LAYER_NOT_IN_PROPERTIES=-2,
	107	VIK_LAYER_GROUP_NONE=-1
	108	};
	109
	110	enum {
	111	VIK_LAYER_WIDGET_CHECKBUTTON=0,
	112	VIK_LAYER_WIDGET_RADIOGROUP,
	113	VIK_LAYER_WIDGET_SPINBUTTON,
	114	VIK_LAYER_WIDGET_ENTRY,
	115	VIK_LAYER_WIDGET_FILEENTRY,
	116	VIK_LAYER_WIDGET_HSCALE,
	117	VIK_LAYER_WIDGET_COLOR,
	118	VIK_LAYER_WIDGET_COMBOBOX,
	119	};
	120
	121	typedef struct {
	122	gdouble min;
	123	gdouble max;
	124	gdouble step;
	125	guint8 digits;
	126	} VikLayerParamScale;
	127
	128	/* id is index */
	129	enum {
	130	VIK_LAYER_PARAM_DOUBLE=1,
	131	VIK_LAYER_PARAM_UINT,
	132	VIK_LAYER_PARAM_INT,
	133	VIK_LAYER_PARAM_STRING,
	134	VIK_LAYER_PARAM_BOOLEAN,
	135	VIK_LAYER_PARAM_COLOR,
	136	};
	137
	138	/* layer interface functions */
	139
	140	/* Create a new layer of a certain type. Should be filled with defaults */
	141	typedef 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. */
	145	typedef 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() */
	150	typedef void (VikLayerFuncPostRead) (VikLayer ,gpointer vp);
	151
	152	typedef 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 */
	156	typedef gboolean (VikLayerFuncProperties) (VikLayer ,VikViewport ); / gpointer is a VikViewport */
	157
	158	typedef void (VikLayerFuncDraw) (VikLayer ,VikViewport *);
	159	typedef void (VikLayerFuncChangeCoordMode) (VikLayer ,VikCoordMode);
	160
	161	typedef void (VikLayerFuncAddMenuItems) (VikLayer ,GtkMenu ,gpointer); / gpointer is a VikLayersPanel */
	162	typedef gboolean (VikLayerFuncSublayerAddMenuItems) (VikLayer ,GtkMenu ,gpointer, / first gpointer is a VikLayersPanel */
	163	gint,gpointer,GtkTreeIter *);
	164	typedef const gchar * (VikLayerFuncSublayerRenameRequest) (VikLayer ,const gchar *,gpointer,
	165	gint,VikViewport ,GtkTreeIter ); /* first gpointer is a VikLayersPanel */
	166	typedef gboolean (VikLayerFuncSublayerToggleVisible) (VikLayer ,gint,gpointer);
	167
	168	typedef VikLayer * (VikLayerFuncCopy) (VikLayer ,VikViewport *);
	169
	170	/* returns TRUE if needs to redraw due to changed param */
	171	typedef gboolean (VikLayerFuncSetParam) (VikLayer , guint16, VikLayerParamData, VikViewport *);
	172
	173	typedef VikLayerParamData
	174	(VikLayerFuncGetParam) (VikLayer , guint16);
	175
	176	typedef void (VikLayerFuncReadFileData) (VikLayer , FILE *);
	177	typedef void (VikLayerFuncWriteFileData) (VikLayer , FILE *);
	178
	179	typedef gpointer (VikLayerFuncCopyItem) (VikLayer , gint, gpointer);
	180	typedef gboolean (VikLayerFuncPasteItem) (VikLayer , gint, gpointer);
	181	typedef void (*VikLayerFuncFreeCopiedItem) (gint, gpointer);
	182
	183
	184	typedef struct _VikLayerInterface VikLayerInterface;
	185
	186	/* See vik_layer_* for function parameter names */
	187	struct _VikLayerInterface {
	188	const gchar * name;
	189	const GdkPixdata * icon;
	190
	191	VikToolInterface * tools;
	192	guint16 tools_count;
	193
	194	/* for I/O reading to and from .vik files -- params like coordline width, color, etc. */
	195	VikLayerParam * params;
	196	guint16 params_count;
	197	gchar ** params_groups;
	198	guint8 params_groups_count;
	199
	200	VikLayerFuncCreate create;
	201	VikLayerFuncRealize realize;
	202	VikLayerFuncPostRead post_read;
	203	VikLayerFuncFree free;
	204
	205	VikLayerFuncProperties properties;
	206	VikLayerFuncDraw draw;
	207	VikLayerFuncChangeCoordMode change_coord_mode;
	208
	209	VikLayerFuncAddMenuItems add_menu_items;
	210	VikLayerFuncSublayerAddMenuItems sublayer_add_menu_items;
	211	VikLayerFuncSublayerRenameRequest sublayer_rename_request;
	212	VikLayerFuncSublayerToggleVisible sublayer_toggle_visible;
	213
	214	VikLayerFuncCopy copy;
	215
	216	/* for I/O */
	217	VikLayerFuncSetParam set_param;
	218	VikLayerFuncGetParam get_param;
	219
	220	/* for I/O -- extra non-param data like TrwLayer data */
	221	VikLayerFuncReadFileData read_file_data;
	222	VikLayerFuncWriteFileData write_file_data;
	223
	224	VikLayerFuncCopyItem copy_item;
	225	VikLayerFuncPasteItem paste_item;
	226	VikLayerFuncFreeCopiedItem free_copied_item;
	227	};
	228
	229	VikLayerInterface *vik_layer_get_interface ( gint type );
	230
	231
	232	void vik_layer_init ( VikLayer *vl, gint type );
	233	void vik_layer_draw ( VikLayer *l, gpointer data );
	234	void vik_layer_change_coord_mode ( VikLayer *l, VikCoordMode mode );
	235	void vik_layer_rename ( VikLayer l, const gchar new_name );
	236	void vik_layer_rename_no_copy ( VikLayer l, gchar new_name );
	237
	238	gboolean vik_layer_set_param (VikLayer *layer, guint16 id, VikLayerParamData data, gpointer vp);
	239
	240	void vik_layer_emit_update ( VikLayer *vl );
	241
	242	/* GUI */
	243	void vik_layer_add_menu_items ( VikLayer l, GtkMenu menu, gpointer vlp );
	244	VikLayer vik_layer_create ( gint type, gpointer vp, GtkWindow w, gboolean interactive );
	245	gboolean vik_layer_properties ( VikLayer *layer, gpointer vp );
	246
	247	void vik_layer_realize ( VikLayer l, VikTreeview vt, GtkTreeIter * layer_iter );
	248	void vik_layer_post_read ( VikLayer *layer, gpointer vp );
	249
	250	gboolean vik_layer_sublayer_add_menu_items ( VikLayer l, GtkMenu menu, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter );
	251
	252	VikLayer vik_layer_copy ( VikLayer vl, gpointer vp );
	253
	254	const gchar vik_layer_sublayer_rename_request ( VikLayer l, const gchar newname, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter iter );
	255
	256	gboolean vik_layer_sublayer_toggle_visible ( VikLayer *l, gint subtype, gpointer sublayer );
	257
	258	/* TODO: put in layerspanel */
	259	GdkPixbuf *vik_layer_load_icon ( gint type );
	260
	261	#endif