[andy/viking.git] / 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
 *
 */
#ifndef _VIKING_LAYER_H
#define _VIKING_LAYER_H

#include <stdio.h>
#include <glib.h>
#include <gtk/gtk.h>
#include <gdk-pixbuf/gdk-pixdata.h>

#include "vikwindow.h"
#include "viktreeview.h"
#include "vikviewport.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 reference */
  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_GPS,
  VIK_LAYER_MAPS,
  VIK_LAYER_DEM,
  VIK_LAYER_NUM_TYPES
};

/* I think most of these are ignored,
 * returning GRAB_FOCUS grabs the focus for mouse move,
 * mouse click, release always grabs focus. Focus allows key presses
 * to be handled.
 * It used to be that, if ignored, Viking could look for other layers.
 * this was useful for clicking a way/trackpoint in any layer,
 * if no layer was selected (find way/trackpoint)
 */
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,
  VIK_LAYER_TOOL_ACK_GRAB_FOCUS, /* only for move */
} VikLayerToolFuncStatus;

/* gpointer is tool-specific state created in the constructor */
typedef gpointer (*VikToolConstructorFunc) (VikWindow *, VikViewport *);
typedef void (*VikToolDestructorFunc) (gpointer);
typedef VikLayerToolFuncStatus (*VikToolMouseFunc) (VikLayer *, GdkEventButton *, gpointer);
typedef void (*VikToolActivationFunc) (VikLayer *, gpointer);
typedef gboolean (*VikToolKeyFunc) (VikLayer *, GdkEventKey *, gpointer);

typedef struct _VikToolInterface VikToolInterface;
struct _VikToolInterface {
  gchar *name;
  VikToolConstructorFunc create;
  VikToolDestructorFunc destroy;
  VikToolActivationFunc activate;
  VikToolActivationFunc deactivate;
  VikToolMouseFunc click;
  VikToolMouseFunc move;
  VikToolMouseFunc release;
  VikToolKeyFunc key_press; /* return FALSE if we don't use the key press -- should return AFLSE most of the time if we want any shortcuts / UI keybindings to work! use sparingly. */
  const GdkPixdata *cursor;
};

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

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

typedef struct {
  const gchar *name;
  guint8 type;
  gint16 group;
  const gchar *title;
  guint8 widget_type;
  gpointer widget_data;
  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_RADIOGROUP_STATIC,
VIK_LAYER_WIDGET_SPINBUTTON,
VIK_LAYER_WIDGET_ENTRY,
VIK_LAYER_WIDGET_FILEENTRY,
VIK_LAYER_WIDGET_HSCALE,
VIK_LAYER_WIDGET_COLOR,
VIK_LAYER_WIDGET_COMBOBOX,
VIK_LAYER_WIDGET_FILELIST,
};

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,

/* NOTE: string layer works auniquely: data.sl should NOT be free'd when
 * the internals call get_param -- i.e. it should be managed w/in the layer.
 * The value passed by the internals into set_param should also be managed
 * by the layer -- i.e. free'd by the layer.
 */

VIK_LAYER_PARAM_STRING_LIST,
};

/* 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 *,VikViewport *vp,gboolean from_file);

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 *);

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

typedef void          (*VikLayerFuncSetMenuItemsSelection)          (VikLayer *,guint16);
typedef guint16          (*VikLayerFuncGetMenuItemsSelection)          (VikLayer *);
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 void          (*VikLayerFuncMarshall)              (VikLayer *, guint8 **, gint *);
typedef VikLayer *    (*VikLayerFuncUnmarshall)            (guint8 *, gint, 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 *);

/* item manipulation */
typedef void          (*VikLayerFuncDeleteItem)            (VikLayer *, gint, gpointer);
                                                         /*      layer, subtype, pointer to sub-item */
typedef void          (*VikLayerFuncCopyItem)              (VikLayer *, gint, gpointer, guint8 **, guint *);
                                                         /*      layer, subtype, pointer to sub-item, return pointer, return len */
typedef gboolean      (*VikLayerFuncPasteItem)             (VikLayer *, gint, guint8 *, guint);
typedef void          (*VikLayerFuncFreeCopiedItem)        (gint, gpointer);

/* treeview drag and drop method. called on the destination layer. it is given a source and destination layer, 
 * and the source and destination iters in the treeview. 
 */
typedef void 	      (*VikLayerFuncDragDropRequest)       (VikLayer *, VikLayer *, GtkTreeIter *, GtkTreePath *);

typedef enum {
  VIK_MENU_ITEM_PROPERTY=1,
  VIK_MENU_ITEM_CUT=2,
  VIK_MENU_ITEM_COPY=4,
  VIK_MENU_ITEM_PASTE=8,
  VIK_MENU_ITEM_DELETE=16,
  VIK_MENU_ITEM_ALL=0xff
} VikStdLayerMenuItem;

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;

  /* menu items to be created */
  VikStdLayerMenuItem               menu_items_selection;

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

  VikLayerFuncProperties            properties;
  VikLayerFuncDraw                  draw;
  VikLayerFuncChangeCoordMode       change_coord_mode;

  VikLayerFuncSetMenuItemsSelection set_menu_selection;
  VikLayerFuncGetMenuItemsSelection get_menu_selection;

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

  VikLayerFuncMarshall              marshall;
  VikLayerFuncUnmarshall            unmarshall;

  /* 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;

  VikLayerFuncDeleteItem            delete_item;
  VikLayerFuncCopyItem              copy_item;
  VikLayerFuncPasteItem             paste_item;
  VikLayerFuncFreeCopiedItem        free_copied_item;

  VikLayerFuncDragDropRequest       drag_drop_request;
};

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 );
const gchar *vik_layer_get_name ( VikLayer *l );

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

void vik_layer_emit_update ( VikLayer *vl );

/* GUI */
void vik_layer_set_menu_items_selection(VikLayer *l, guint16 selection);
guint16 vik_layer_get_menu_items_selection(VikLayer *l);
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, VikViewport *vp, gboolean from_file );

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 );
void      vik_layer_marshall ( VikLayer *vl, guint8 **data, gint *len );
VikLayer *vik_layer_unmarshall ( guint8 *data, gint len, VikViewport *vvp );
void      vik_layer_marshall_params ( VikLayer *vl, guint8 **data, gint *len );
void      vik_layer_unmarshall_params ( VikLayer *vl, guint8 *data, gint len, VikViewport *vvp );

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 );

VikLayer *vik_layer_get_and_reset_trigger();
void vik_layer_emit_update_secondary ( VikLayer *vl ); /* to be called by aggregate layer only. doesn't set the trigger */
void vik_layer_emit_update_although_invisible ( VikLayer *vl );

GdkCursor *vik_layer_get_tool_cursor ( gint layer_id, gint tool_id );
void vik_layer_cursors_init();
void vik_layer_cursors_uninit();


#endif
Commit	Line	Data
50a14534 EB	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	*/
a25c4c50 GB	21	#ifndef _VIKING_LAYER_H
	22	#define _VIKING_LAYER_H
	23
e4afc73a	24	#include <stdio.h>
a25c4c50 GB	25	#include <glib.h>
	26	#include <gtk/gtk.h>
	27	#include <gdk-pixbuf/gdk-pixdata.h>
50a14534	28
cdcaf41c	29	#include "vikwindow.h"
a25c4c50 GB	30	#include "viktreeview.h"
a25c4c50 GB	31	#include "vikviewport.h"
50a14534 EB	32
	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))
	38
369e959a	39	typedef struct _VikLayer VikLayer;
50a14534 EB	40	typedef struct _VikLayerClass VikLayerClass;
	41
	42	struct _VikLayerClass
	43	{
	44	GObjectClass object_class;
	45	void (* update) (VikLayer *vl);
	46	};
	47
	48	GType vik_layer_get_type ();
	49
	50	struct _VikLayer {
	51	GObject obj;
	52	gchar *name;
	53	gboolean visible;
	54
	55	gboolean realized;
94933cb8	56	VikTreeview vt; / simply a reference */
50a14534 EB	57	GtkTreeIter iter;
	58
	59	/* for explicit "polymorphism" (function type switching) */
	60	guint16 type;
	61	};
	62
	63
	64
	65	enum {
941aa6e9 AF	66	VIK_LAYER_AGGREGATE = 0,
	67	VIK_LAYER_TRW,
	68	VIK_LAYER_COORD,
	69	VIK_LAYER_GEOREF,
b364d6bc	70	VIK_LAYER_GPS,
941aa6e9	71	VIK_LAYER_MAPS,
ad0a8c2d	72	VIK_LAYER_DEM,
941aa6e9	73	VIK_LAYER_NUM_TYPES
50a14534 EB	74	};
50a14534 EB	75
165d30aa EB	76	/* I think most of these are ignored,
	77	* returning GRAB_FOCUS grabs the focus for mouse move,
	78	* mouse click, release always grabs focus. Focus allows key presses
	79	* to be handled.
	80	* It used to be that, if ignored, Viking could look for other layers.
	81	* this was useful for clicking a way/trackpoint in any layer,
	82	* if no layer was selected (find way/trackpoint)
	83	*/
941aa6e9 AF	84	typedef enum {
	85	VIK_LAYER_TOOL_IGNORED=0,
	86	VIK_LAYER_TOOL_ACK,
	87	VIK_LAYER_TOOL_ACK_REDRAW_ABOVE,
	88	VIK_LAYER_TOOL_ACK_REDRAW_ALL,
165d30aa EB	89	VIK_LAYER_TOOL_ACK_REDRAW_IF_VISIBLE,
165d30aa EB	90	VIK_LAYER_TOOL_ACK_GRAB_FOCUS, /* only for move */
941aa6e9	91	} VikLayerToolFuncStatus;
50a14534	92
941aa6e9 AF	93	/* gpointer is tool-specific state created in the constructor */
	94	typedef gpointer (VikToolConstructorFunc) (VikWindow , VikViewport *);
	95	typedef void (*VikToolDestructorFunc) (gpointer);
	96	typedef VikLayerToolFuncStatus (VikToolMouseFunc) (VikLayer , GdkEventButton *, gpointer);
	97	typedef void (VikToolActivationFunc) (VikLayer , gpointer);
777e2d4d	98	typedef gboolean (VikToolKeyFunc) (VikLayer , GdkEventKey *, gpointer);
50a14534 EB	99
	100	typedef struct _VikToolInterface VikToolInterface;
	101	struct _VikToolInterface {
	102	gchar *name;
941aa6e9 AF	103	VikToolConstructorFunc create;
	104	VikToolDestructorFunc destroy;
	105	VikToolActivationFunc activate;
	106	VikToolActivationFunc deactivate;
	107	VikToolMouseFunc click;
	108	VikToolMouseFunc move;
	109	VikToolMouseFunc release;
777e2d4d	110	VikToolKeyFunc key_press; /* return FALSE if we don't use the key press -- should return AFLSE most of the time if we want any shortcuts / UI keybindings to work! use sparingly. */
bce3a7b0	111	const GdkPixdata *cursor;
50a14534 EB	112	};
	113
	114	/* Parameters (for I/O and Properties) */
	115
	116	typedef union {
	117	gdouble d;
	118	guint32 u;
	119	gint32 i;
	120	gboolean b;
	121	const gchar *s;
	122	GdkColor c;
ad0a8c2d	123	GList *sl;
50a14534 EB	124	} VikLayerParamData;
	125
	126	typedef struct {
	127	const gchar *name;
	128	guint8 type;
	129	gint16 group;
	130	const gchar *title;
	131	guint8 widget_type;
cdcaf41c QT	132	gpointer widget_data;
cdcaf41c QT	133	gpointer extra_widget_data;
50a14534 EB	134	} VikLayerParam;
	135
	136	enum {
	137	VIK_LAYER_NOT_IN_PROPERTIES=-2,
	138	VIK_LAYER_GROUP_NONE=-1
	139	};
	140
	141	enum {
	142	VIK_LAYER_WIDGET_CHECKBUTTON=0,
	143	VIK_LAYER_WIDGET_RADIOGROUP,
8c721f83	144	VIK_LAYER_WIDGET_RADIOGROUP_STATIC,
50a14534 EB	145	VIK_LAYER_WIDGET_SPINBUTTON,
	146	VIK_LAYER_WIDGET_ENTRY,
	147	VIK_LAYER_WIDGET_FILEENTRY,
	148	VIK_LAYER_WIDGET_HSCALE,
	149	VIK_LAYER_WIDGET_COLOR,
	150	VIK_LAYER_WIDGET_COMBOBOX,
ad0a8c2d	151	VIK_LAYER_WIDGET_FILELIST,
50a14534 EB	152	};
	153
	154	typedef struct {
	155	gdouble min;
	156	gdouble max;
	157	gdouble step;
	158	guint8 digits;
	159	} VikLayerParamScale;
	160
	161	/* id is index */
	162	enum {
	163	VIK_LAYER_PARAM_DOUBLE=1,
	164	VIK_LAYER_PARAM_UINT,
	165	VIK_LAYER_PARAM_INT,
	166	VIK_LAYER_PARAM_STRING,
	167	VIK_LAYER_PARAM_BOOLEAN,
	168	VIK_LAYER_PARAM_COLOR,
ad0a8c2d EB	169
	170	/* NOTE: string layer works auniquely: data.sl should NOT be free'd when
	171	* the internals call get_param -- i.e. it should be managed w/in the layer.
	172	* The value passed by the internals into set_param should also be managed
	173	* by the layer -- i.e. free'd by the layer.
	174	*/
	175
	176	VIK_LAYER_PARAM_STRING_LIST,
50a14534 EB	177	};
	178
	179	/* layer interface functions */
	180
	181	/* Create a new layer of a certain type. Should be filled with defaults */
	182	typedef VikLayer * (VikLayerFuncCreate) (VikViewport );
	183
	184	/* normally only needed for layers with sublayers. This is called when they
	185	* are added to the treeview so they can add sublayers to the treeview. */
	186	typedef void (VikLayerFuncRealize) (VikLayer ,VikTreeview ,GtkTreeIter );
	187
	188	/* rarely used, this is called after a read operation or properties box is run.
	189	* usually used to create GC's that depend on params,
	190	* but GC's can also be created from create() or set_param() */
07059501	191	typedef void (VikLayerFuncPostRead) (VikLayer ,VikViewport *vp,gboolean from_file);
50a14534 EB	192
	193	typedef void (VikLayerFuncFree) (VikLayer );
	194
	195	/* do _not_ use this unless absolutely neccesary. Use the dynamic properties (see coordlayer for example)
	196	* returns TRUE if OK was pressed */
07059501	197	typedef gboolean (VikLayerFuncProperties) (VikLayer ,VikViewport *);
50a14534 EB	198
	199	typedef void (VikLayerFuncDraw) (VikLayer ,VikViewport *);
	200	typedef void (VikLayerFuncChangeCoordMode) (VikLayer ,VikCoordMode);
	201
20c7a3a0 QT	202	typedef void (VikLayerFuncSetMenuItemsSelection) (VikLayer ,guint16);
20c7a3a0 QT	203	typedef guint16 (VikLayerFuncGetMenuItemsSelection) (VikLayer );
50a14534 EB	204	typedef void (VikLayerFuncAddMenuItems) (VikLayer ,GtkMenu ,gpointer); / gpointer is a VikLayersPanel */
	205	typedef gboolean (VikLayerFuncSublayerAddMenuItems) (VikLayer ,GtkMenu ,gpointer, / first gpointer is a VikLayersPanel */
	206	gint,gpointer,GtkTreeIter *);
	207	typedef const gchar * (VikLayerFuncSublayerRenameRequest) (VikLayer ,const gchar *,gpointer,
	208	gint,VikViewport ,GtkTreeIter ); /* first gpointer is a VikLayersPanel */
	209	typedef gboolean (VikLayerFuncSublayerToggleVisible) (VikLayer ,gint,gpointer);
	210
911400b5 AF	211	typedef void (VikLayerFuncMarshall) (VikLayer , guint8 *, gint );
911400b5 AF	212	typedef VikLayer * (VikLayerFuncUnmarshall) (guint8 , gint, VikViewport *);
50a14534 EB	213
	214	/* returns TRUE if needs to redraw due to changed param */
	215	typedef gboolean (VikLayerFuncSetParam) (VikLayer , guint16, VikLayerParamData, VikViewport *);
	216
	217	typedef VikLayerParamData
	218	(VikLayerFuncGetParam) (VikLayer , guint16);
	219
	220	typedef void (VikLayerFuncReadFileData) (VikLayer , FILE *);
	221	typedef void (VikLayerFuncWriteFileData) (VikLayer , FILE *);
	222
33534cd8 AF	223	/* item manipulation */
	224	typedef void (VikLayerFuncDeleteItem) (VikLayer , gint, gpointer);
	225	/* layer, subtype, pointer to sub-item */
ddc47a46	226	typedef void (VikLayerFuncCopyItem) (VikLayer , gint, gpointer, guint8 *, guint );
33534cd8	227	/* layer, subtype, pointer to sub-item, return pointer, return len */
ddc47a46	228	typedef gboolean (VikLayerFuncPasteItem) (VikLayer , gint, guint8 *, guint);
50a14534 EB	229	typedef void (*VikLayerFuncFreeCopiedItem) (gint, gpointer);
50a14534 EB	230
70a23263 AF	231	/* treeview drag and drop method. called on the destination layer. it is given a source and destination layer,
	232	* and the source and destination iters in the treeview.
	233	*/
	234	typedef void (VikLayerFuncDragDropRequest) (VikLayer , VikLayer , GtkTreeIter , GtkTreePath *);
	235
5a4a28bf QT	236	typedef enum {
	237	VIK_MENU_ITEM_PROPERTY=1,
	238	VIK_MENU_ITEM_CUT=2,
	239	VIK_MENU_ITEM_COPY=4,
	240	VIK_MENU_ITEM_PASTE=8,
	241	VIK_MENU_ITEM_DELETE=16,
	242	VIK_MENU_ITEM_ALL=0xff
	243	} VikStdLayerMenuItem;
50a14534 EB	244
	245	typedef struct _VikLayerInterface VikLayerInterface;
	246
	247	/* See vik_layer_* for function parameter names */
	248	struct _VikLayerInterface {
	249	const gchar * name;
	250	const GdkPixdata * icon;
	251
	252	VikToolInterface * tools;
	253	guint16 tools_count;
	254
	255	/* for I/O reading to and from .vik files -- params like coordline width, color, etc. */
	256	VikLayerParam * params;
	257	guint16 params_count;
	258	gchar ** params_groups;
	259	guint8 params_groups_count;
	260
5a4a28bf QT	261	/* menu items to be created */
	262	VikStdLayerMenuItem menu_items_selection;
	263
50a14534 EB	264	VikLayerFuncCreate create;
	265	VikLayerFuncRealize realize;
	266	VikLayerFuncPostRead post_read;
	267	VikLayerFuncFree free;
	268
	269	VikLayerFuncProperties properties;
	270	VikLayerFuncDraw draw;
	271	VikLayerFuncChangeCoordMode change_coord_mode;
	272
20c7a3a0 QT	273	VikLayerFuncSetMenuItemsSelection set_menu_selection;
	274	VikLayerFuncGetMenuItemsSelection get_menu_selection;
	275
50a14534 EB	276	VikLayerFuncAddMenuItems add_menu_items;
	277	VikLayerFuncSublayerAddMenuItems sublayer_add_menu_items;
	278	VikLayerFuncSublayerRenameRequest sublayer_rename_request;
	279	VikLayerFuncSublayerToggleVisible sublayer_toggle_visible;
	280
911400b5 AF	281	VikLayerFuncMarshall marshall;
911400b5 AF	282	VikLayerFuncUnmarshall unmarshall;
50a14534 EB	283
	284	/* for I/O */
	285	VikLayerFuncSetParam set_param;
	286	VikLayerFuncGetParam get_param;
	287
	288	/* for I/O -- extra non-param data like TrwLayer data */
	289	VikLayerFuncReadFileData read_file_data;
	290	VikLayerFuncWriteFileData write_file_data;
	291
33534cd8	292	VikLayerFuncDeleteItem delete_item;
50a14534 EB	293	VikLayerFuncCopyItem copy_item;
	294	VikLayerFuncPasteItem paste_item;
	295	VikLayerFuncFreeCopiedItem free_copied_item;
70a23263 AF	296
70a23263 AF	297	VikLayerFuncDragDropRequest drag_drop_request;
50a14534 EB	298	};
	299
	300	VikLayerInterface *vik_layer_get_interface ( gint type );
	301
	302
	303	void vik_layer_init ( VikLayer *vl, gint type );
	304	void vik_layer_draw ( VikLayer *l, gpointer data );
	305	void vik_layer_change_coord_mode ( VikLayer *l, VikCoordMode mode );
	306	void vik_layer_rename ( VikLayer l, const gchar new_name );
	307	void vik_layer_rename_no_copy ( VikLayer l, gchar new_name );
92558066	308	const gchar vik_layer_get_name ( VikLayer l );
50a14534 EB	309
	310	gboolean vik_layer_set_param (VikLayer *layer, guint16 id, VikLayerParamData data, gpointer vp);
	311
	312	void vik_layer_emit_update ( VikLayer *vl );
	313
	314	/* GUI */
20c7a3a0 QT	315	void vik_layer_set_menu_items_selection(VikLayer *l, guint16 selection);
20c7a3a0 QT	316	guint16 vik_layer_get_menu_items_selection(VikLayer *l);
50a14534 EB	317	void vik_layer_add_menu_items ( VikLayer l, GtkMenu menu, gpointer vlp );
	318	VikLayer vik_layer_create ( gint type, gpointer vp, GtkWindow w, gboolean interactive );
	319	gboolean vik_layer_properties ( VikLayer *layer, gpointer vp );
	320
	321	void vik_layer_realize ( VikLayer l, VikTreeview vt, GtkTreeIter * layer_iter );
07059501	322	void vik_layer_post_read ( VikLayer layer, VikViewport vp, gboolean from_file );
50a14534 EB	323
	324	gboolean vik_layer_sublayer_add_menu_items ( VikLayer l, GtkMenu menu, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter );
	325
	326	VikLayer vik_layer_copy ( VikLayer vl, gpointer vp );
911400b5 AF	327	void vik_layer_marshall ( VikLayer vl, guint8 data, gint len );
	328	VikLayer vik_layer_unmarshall ( guint8 data, gint len, VikViewport *vvp );
	329	void vik_layer_marshall_params ( VikLayer vl, guint8 data, gint len );
	330	void vik_layer_unmarshall_params ( VikLayer vl, guint8 data, gint len, VikViewport *vvp );
50a14534 EB	331
	332	const gchar vik_layer_sublayer_rename_request ( VikLayer l, const gchar newname, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter iter );
	333
	334	gboolean vik_layer_sublayer_toggle_visible ( VikLayer *l, gint subtype, gpointer sublayer );
	335
	336	/* TODO: put in layerspanel */
	337	GdkPixbuf *vik_layer_load_icon ( gint type );
	338
0df66d57 EB	339	VikLayer *vik_layer_get_and_reset_trigger();
	340	void vik_layer_emit_update_secondary ( VikLayer vl ); / to be called by aggregate layer only. doesn't set the trigger */
	341	void vik_layer_emit_update_although_invisible ( VikLayer *vl );
	342
bce3a7b0 EB	343	GdkCursor *vik_layer_get_tool_cursor ( gint layer_id, gint tool_id );
	344	void vik_layer_cursors_init();
	345	void vik_layer_cursors_uninit();
	346
	347
	348
	349
50a14534	350	#endif