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 "uibuilder.h"
#include "vikwindow.h"
#include "viktreeview.h"
#include "vikviewport.h"

G_BEGIN_DECLS

#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;
  VikViewport *vvp;/* simply a reference */
  VikTreeview *vt; /* simply a reference */
  GtkTreeIter iter;

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

/* 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 VikLayerToolFuncStatus (*VikToolMouseMoveFunc) (VikLayer *, GdkEventMotion *, gpointer);
typedef void (*VikToolActivationFunc) (VikLayer *, gpointer);
typedef gboolean (*VikToolKeyFunc) (VikLayer *, GdkEventKey *, gpointer);

typedef struct _VikToolInterface VikToolInterface;
struct _VikToolInterface {
  GtkRadioActionEntry radioActionEntry;
  VikToolConstructorFunc create;
  VikToolDestructorFunc destroy;
  VikToolActivationFunc activate;
  VikToolActivationFunc deactivate;
  VikToolMouseFunc click;
  VikToolMouseMoveFunc move;
  VikToolMouseFunc release;
  VikToolKeyFunc key_press; /* return FALSE if we don't use the key press -- should return FALSE most of the time if we want any shortcuts / UI keybindings to work! use sparingly. */
  gboolean pan_handler; // Call click & release funtions even when 'Pan Mode' is on
  GdkCursorType cursor_type;
  const GdkPixdata *cursor_data;
  const GdkCursor *cursor;
};

/* Parameters (for I/O and Properties) */
/* --> moved to uibuilder.h */


/* 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 *,VikViewport *);
typedef const gchar * (*VikLayerFuncSublayerRenameRequest) (VikLayer *,const gchar *,gpointer,
                                                            gint,VikViewport *,GtkTreeIter *); /* first gpointer is a VikLayersPanel */
typedef gboolean      (*VikLayerFuncSublayerToggleVisible) (VikLayer *,gint,gpointer);
typedef const gchar * (*VikLayerFuncSublayerTooltip)       (VikLayer *,gint,gpointer);
typedef const gchar * (*VikLayerFuncLayerTooltip)          (VikLayer *);
typedef gboolean      (*VikLayerFuncLayerSelected)         (VikLayer *,gint,gpointer,gint,gpointer); /* 2nd gpointer is a VikLayersPanel */

typedef void          (*VikLayerFuncMarshall)              (VikLayer *, guint8 **, gint *);
typedef VikLayer *    (*VikLayerFuncUnmarshall)            (guint8 *, gint, VikViewport *);

/* returns TRUE if needs to redraw due to changed param */
/* in parameter gboolean denotes if for file I/O, as opposed to display/cut/copy etc... operations */
typedef gboolean      (*VikLayerFuncSetParam)              (VikLayer *, guint16, VikLayerParamData, VikViewport *, gboolean);

/* in parameter gboolean denotes if for file I/O, as opposed to display/cut/copy etc... operations */
typedef VikLayerParamData
                      (*VikLayerFuncGetParam)              (VikLayer *, guint16, gboolean);

typedef void          (*VikLayerFuncChangeParam)           (GtkWidget *, ui_change_values );

typedef gboolean      (*VikLayerFuncReadFileData)          (VikLayer *, FILE *, const gchar *); // gchar* is the directory path. Function should report success or failure
typedef void          (*VikLayerFuncWriteFileData)         (VikLayer *, FILE *);

/* item manipulation */
typedef void          (*VikLayerFuncDeleteItem)            (VikLayer *, gint, gpointer);
                                                         /*      layer, subtype, pointer to sub-item */
typedef void          (*VikLayerFuncCutItem)               (VikLayer *, gint, gpointer);
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 gboolean      (*VikLayerFuncSelectClick)           (VikLayer *, GdkEventButton *, VikViewport *, tool_ed_t*);
typedef gboolean      (*VikLayerFuncSelectMove)            (VikLayer *, GdkEventMotion *, VikViewport *, tool_ed_t*);
typedef gboolean      (*VikLayerFuncSelectRelease)         (VikLayer *, GdkEventButton *, VikViewport *, tool_ed_t*);
typedef gboolean      (*VikLayerFuncSelectedViewportMenu)  (VikLayer *, GdkEventButton *, VikViewport *);

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 *                     fixed_layer_name; // Used in .vik files - this should never change to maintain file compatibility
  const gchar *                     name;             // Translate-able name used for display purposes
  const gchar *                     accelerator;
  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;
  VikLayerFuncSublayerTooltip       sublayer_tooltip;
  VikLayerFuncLayerTooltip          layer_tooltip;
  VikLayerFuncLayerSelected         layer_selected;

  VikLayerFuncMarshall              marshall;
  VikLayerFuncUnmarshall            unmarshall;

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

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

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

  VikLayerFuncDragDropRequest       drag_drop_request;

  VikLayerFuncSelectClick           select_click;
  VikLayerFuncSelectMove            select_move;
  VikLayerFuncSelectRelease         select_release;
  VikLayerFuncSelectedViewportMenu  show_viewport_menu;
};

VikLayerInterface *vik_layer_get_interface ( VikLayerTypeEnum type );


void vik_layer_set_type ( VikLayer *vl, VikLayerTypeEnum type );
void vik_layer_draw ( VikLayer *l, VikViewport *vp );
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, gboolean is_file_operation);

void vik_layer_set_defaults ( VikLayer *vl, VikViewport *vvp );

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 ( VikLayerTypeEnum type, VikViewport *vp, gboolean interactive );
gboolean vik_layer_properties ( VikLayer *layer, VikViewport *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, VikViewport *vvp );

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

const gchar* vik_layer_sublayer_tooltip ( VikLayer *l, gint subtype, gpointer sublayer );

const gchar* vik_layer_layer_tooltip ( VikLayer *l );

gboolean vik_layer_selected ( VikLayer *l, gint subtype, gpointer sublayer, gint type, gpointer vlp );

/* TODO: put in layerspanel */
GdkPixbuf *vik_layer_load_icon ( VikLayerTypeEnum 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 );

VikLayerTypeEnum vik_layer_type_from_string ( const gchar *str );

typedef struct {
  VikLayerParamData data;
  VikLayerParamType type;
} VikLayerTypedParamData;

void vik_layer_typed_param_data_free ( gpointer gp );
VikLayerTypedParamData *vik_layer_typed_param_data_copy_from_data ( VikLayerParamType type, VikLayerParamData val );
VikLayerTypedParamData *vik_layer_data_typed_param_copy_from_string ( VikLayerParamType type, const gchar *str );

G_END_DECLS

#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	#ifndef _VIKING_LAYER_H
	22	#define _VIKING_LAYER_H
	23
	24	#include <stdio.h>
	25	#include <glib.h>
	26	#include <gtk/gtk.h>
	27	#include <gdk-pixbuf/gdk-pixdata.h>
	28
	29	#include "uibuilder.h"
	30	#include "vikwindow.h"
	31	#include "viktreeview.h"
	32	#include "vikviewport.h"
	33
	34	G_BEGIN_DECLS
	35
	36	#define VIK_LAYER_TYPE (vik_layer_get_type ())
	37	#define VIK_LAYER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), VIK_LAYER_TYPE, VikLayer))
	38	#define VIK_LAYER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), VIK_LAYER_TYPE, VikLayerClass))
	39	#define IS_VIK_LAYER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), VIK_LAYER_TYPE))
	40	#define IS_VIK_LAYER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), VIK_LAYER_TYPE))
	41
	42	typedef struct _VikLayer VikLayer;
	43	typedef struct _VikLayerClass VikLayerClass;
	44
	45	struct _VikLayerClass
	46	{
	47	GObjectClass object_class;
	48	void (* update) (VikLayer *vl);
	49	};
	50
	51	GType vik_layer_get_type ();
	52
	53	struct _VikLayer {
	54	GObject obj;
	55	gchar *name;
	56	gboolean visible;
	57
	58	gboolean realized;
	59	VikViewport vvp;/ simply a reference */
	60	VikTreeview vt; / simply a reference */
	61	GtkTreeIter iter;
	62
	63	/* for explicit "polymorphism" (function type switching) */
	64	VikLayerTypeEnum type;
	65	};
	66
	67	/* I think most of these are ignored,
	68	* returning GRAB_FOCUS grabs the focus for mouse move,
	69	* mouse click, release always grabs focus. Focus allows key presses
	70	* to be handled.
	71	* It used to be that, if ignored, Viking could look for other layers.
	72	* this was useful for clicking a way/trackpoint in any layer,
	73	* if no layer was selected (find way/trackpoint)
	74	*/
	75	typedef enum {
	76	VIK_LAYER_TOOL_IGNORED=0,
	77	VIK_LAYER_TOOL_ACK,
	78	VIK_LAYER_TOOL_ACK_REDRAW_ABOVE,
	79	VIK_LAYER_TOOL_ACK_REDRAW_ALL,
	80	VIK_LAYER_TOOL_ACK_REDRAW_IF_VISIBLE,
	81	VIK_LAYER_TOOL_ACK_GRAB_FOCUS, /* only for move */
	82	} VikLayerToolFuncStatus;
	83
	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 VikLayerToolFuncStatus (VikToolMouseMoveFunc) (VikLayer , GdkEventMotion *, gpointer);
	89	typedef void (VikToolActivationFunc) (VikLayer , gpointer);
	90	typedef gboolean (VikToolKeyFunc) (VikLayer , GdkEventKey *, gpointer);
	91
	92	typedef struct _VikToolInterface VikToolInterface;
	93	struct _VikToolInterface {
	94	GtkRadioActionEntry radioActionEntry;
	95	VikToolConstructorFunc create;
	96	VikToolDestructorFunc destroy;
	97	VikToolActivationFunc activate;
	98	VikToolActivationFunc deactivate;
	99	VikToolMouseFunc click;
	100	VikToolMouseMoveFunc move;
	101	VikToolMouseFunc release;
	102	VikToolKeyFunc key_press; /* return FALSE if we don't use the key press -- should return FALSE most of the time if we want any shortcuts / UI keybindings to work! use sparingly. */
	103	gboolean pan_handler; // Call click & release funtions even when 'Pan Mode' is on
	104	GdkCursorType cursor_type;
	105	const GdkPixdata *cursor_data;
	106	const GdkCursor *cursor;
	107	};
	108
	109	/* Parameters (for I/O and Properties) */
	110	/* --> moved to uibuilder.h */
	111
	112
	113	/* layer interface functions */
	114
	115	/* Create a new layer of a certain type. Should be filled with defaults */
	116	typedef VikLayer * (VikLayerFuncCreate) (VikViewport );
	117
	118	/* normally only needed for layers with sublayers. This is called when they
	119	* are added to the treeview so they can add sublayers to the treeview. */
	120	typedef void (VikLayerFuncRealize) (VikLayer ,VikTreeview ,GtkTreeIter );
	121
	122	/* rarely used, this is called after a read operation or properties box is run.
	123	* usually used to create GC's that depend on params,
	124	* but GC's can also be created from create() or set_param() */
	125	typedef void (VikLayerFuncPostRead) (VikLayer ,VikViewport *vp,gboolean from_file);
	126
	127	typedef void (VikLayerFuncFree) (VikLayer );
	128
	129	/* do _not_ use this unless absolutely neccesary. Use the dynamic properties (see coordlayer for example)
	130	* returns TRUE if OK was pressed */
	131	typedef gboolean (VikLayerFuncProperties) (VikLayer ,VikViewport *);
	132
	133	typedef void (VikLayerFuncDraw) (VikLayer ,VikViewport *);
	134	typedef void (VikLayerFuncChangeCoordMode) (VikLayer ,VikCoordMode);
	135
	136	typedef void (VikLayerFuncSetMenuItemsSelection) (VikLayer ,guint16);
	137	typedef guint16 (VikLayerFuncGetMenuItemsSelection) (VikLayer );
	138
	139	typedef void (VikLayerFuncAddMenuItems) (VikLayer ,GtkMenu ,gpointer); / gpointer is a VikLayersPanel */
	140	typedef gboolean (VikLayerFuncSublayerAddMenuItems) (VikLayer ,GtkMenu ,gpointer, / first gpointer is a VikLayersPanel */
	141	gint,gpointer,GtkTreeIter ,VikViewport );
	142	typedef const gchar * (VikLayerFuncSublayerRenameRequest) (VikLayer ,const gchar *,gpointer,
	143	gint,VikViewport ,GtkTreeIter ); /* first gpointer is a VikLayersPanel */
	144	typedef gboolean (VikLayerFuncSublayerToggleVisible) (VikLayer ,gint,gpointer);
	145	typedef const gchar * (VikLayerFuncSublayerTooltip) (VikLayer ,gint,gpointer);
	146	typedef const gchar * (VikLayerFuncLayerTooltip) (VikLayer );
	147	typedef gboolean (VikLayerFuncLayerSelected) (VikLayer ,gint,gpointer,gint,gpointer); /* 2nd gpointer is a VikLayersPanel */
	148
	149	typedef void (VikLayerFuncMarshall) (VikLayer , guint8 *, gint );
	150	typedef VikLayer * (VikLayerFuncUnmarshall) (guint8 , gint, VikViewport *);
	151
	152	/* returns TRUE if needs to redraw due to changed param */
	153	/* in parameter gboolean denotes if for file I/O, as opposed to display/cut/copy etc... operations */
	154	typedef gboolean (VikLayerFuncSetParam) (VikLayer , guint16, VikLayerParamData, VikViewport *, gboolean);
	155
	156	/* in parameter gboolean denotes if for file I/O, as opposed to display/cut/copy etc... operations */
	157	typedef VikLayerParamData
	158	(VikLayerFuncGetParam) (VikLayer , guint16, gboolean);
	159
	160	typedef void (VikLayerFuncChangeParam) (GtkWidget , ui_change_values );
	161
	162	typedef gboolean (VikLayerFuncReadFileData) (VikLayer , FILE , const gchar ); // gchar* is the directory path. Function should report success or failure
	163	typedef void (VikLayerFuncWriteFileData) (VikLayer , FILE *);
	164
	165	/* item manipulation */
	166	typedef void (VikLayerFuncDeleteItem) (VikLayer , gint, gpointer);
	167	/* layer, subtype, pointer to sub-item */
	168	typedef void (VikLayerFuncCutItem) (VikLayer , gint, gpointer);
	169	typedef void (VikLayerFuncCopyItem) (VikLayer , gint, gpointer, guint8 *, guint );
	170	/* layer, subtype, pointer to sub-item, return pointer, return len */
	171	typedef gboolean (VikLayerFuncPasteItem) (VikLayer , gint, guint8 *, guint);
	172	typedef void (*VikLayerFuncFreeCopiedItem) (gint, gpointer);
	173
	174	/* treeview drag and drop method. called on the destination layer. it is given a source and destination layer,
	175	* and the source and destination iters in the treeview.
	176	*/
	177	typedef void (VikLayerFuncDragDropRequest) (VikLayer , VikLayer , GtkTreeIter , GtkTreePath *);
	178
	179	typedef gboolean (VikLayerFuncSelectClick) (VikLayer , GdkEventButton , VikViewport , tool_ed_t*);
	180	typedef gboolean (VikLayerFuncSelectMove) (VikLayer , GdkEventMotion , VikViewport , tool_ed_t*);
	181	typedef gboolean (VikLayerFuncSelectRelease) (VikLayer , GdkEventButton , VikViewport , tool_ed_t*);
	182	typedef gboolean (VikLayerFuncSelectedViewportMenu) (VikLayer , GdkEventButton , VikViewport );
	183
	184	typedef enum {
	185	VIK_MENU_ITEM_PROPERTY=1,
	186	VIK_MENU_ITEM_CUT=2,
	187	VIK_MENU_ITEM_COPY=4,
	188	VIK_MENU_ITEM_PASTE=8,
	189	VIK_MENU_ITEM_DELETE=16,
	190	VIK_MENU_ITEM_ALL=0xff
	191	} VikStdLayerMenuItem;
	192
	193	typedef struct _VikLayerInterface VikLayerInterface;
	194
	195	/* See vik_layer_* for function parameter names */
	196	struct _VikLayerInterface {
	197	const gchar * fixed_layer_name; // Used in .vik files - this should never change to maintain file compatibility
	198	const gchar * name; // Translate-able name used for display purposes
	199	const gchar * accelerator;
	200	const GdkPixdata * icon;
	201
	202	VikToolInterface * tools;
	203	guint16 tools_count;
	204
	205	/* for I/O reading to and from .vik files -- params like coordline width, color, etc. */
	206	VikLayerParam * params;
	207	guint16 params_count;
	208	gchar ** params_groups;
	209	guint8 params_groups_count;
	210
	211	/* menu items to be created */
	212	VikStdLayerMenuItem menu_items_selection;
	213
	214	VikLayerFuncCreate create;
	215	VikLayerFuncRealize realize;
	216	VikLayerFuncPostRead post_read;
	217	VikLayerFuncFree free;
	218
	219	VikLayerFuncProperties properties;
	220	VikLayerFuncDraw draw;
	221	VikLayerFuncChangeCoordMode change_coord_mode;
	222
	223	VikLayerFuncSetMenuItemsSelection set_menu_selection;
	224	VikLayerFuncGetMenuItemsSelection get_menu_selection;
	225
	226	VikLayerFuncAddMenuItems add_menu_items;
	227	VikLayerFuncSublayerAddMenuItems sublayer_add_menu_items;
	228	VikLayerFuncSublayerRenameRequest sublayer_rename_request;
	229	VikLayerFuncSublayerToggleVisible sublayer_toggle_visible;
	230	VikLayerFuncSublayerTooltip sublayer_tooltip;
	231	VikLayerFuncLayerTooltip layer_tooltip;
	232	VikLayerFuncLayerSelected layer_selected;
	233
	234	VikLayerFuncMarshall marshall;
	235	VikLayerFuncUnmarshall unmarshall;
	236
	237	/* for I/O */
	238	VikLayerFuncSetParam set_param;
	239	VikLayerFuncGetParam get_param;
	240	VikLayerFuncChangeParam change_param;
	241
	242	/* for I/O -- extra non-param data like TrwLayer data */
	243	VikLayerFuncReadFileData read_file_data;
	244	VikLayerFuncWriteFileData write_file_data;
	245
	246	VikLayerFuncDeleteItem delete_item;
	247	VikLayerFuncCutItem cut_item;
	248	VikLayerFuncCopyItem copy_item;
	249	VikLayerFuncPasteItem paste_item;
	250	VikLayerFuncFreeCopiedItem free_copied_item;
	251
	252	VikLayerFuncDragDropRequest drag_drop_request;
	253
	254	VikLayerFuncSelectClick select_click;
	255	VikLayerFuncSelectMove select_move;
	256	VikLayerFuncSelectRelease select_release;
	257	VikLayerFuncSelectedViewportMenu show_viewport_menu;
	258	};
	259
	260	VikLayerInterface *vik_layer_get_interface ( VikLayerTypeEnum type );
	261
	262
	263	void vik_layer_set_type ( VikLayer *vl, VikLayerTypeEnum type );
	264	void vik_layer_draw ( VikLayer l, VikViewport vp );
	265	void vik_layer_change_coord_mode ( VikLayer *l, VikCoordMode mode );
	266	void vik_layer_rename ( VikLayer l, const gchar new_name );
	267	void vik_layer_rename_no_copy ( VikLayer l, gchar new_name );
	268	const gchar vik_layer_get_name ( VikLayer l );
	269
	270	gboolean vik_layer_set_param (VikLayer *layer, guint16 id, VikLayerParamData data, gpointer vp, gboolean is_file_operation);
	271
	272	void vik_layer_set_defaults ( VikLayer vl, VikViewport vvp );
	273
	274	void vik_layer_emit_update ( VikLayer *vl );
	275
	276	/* GUI */
	277	void vik_layer_set_menu_items_selection(VikLayer *l, guint16 selection);
	278	guint16 vik_layer_get_menu_items_selection(VikLayer *l);
	279	void vik_layer_add_menu_items ( VikLayer l, GtkMenu menu, gpointer vlp );
	280	VikLayer vik_layer_create ( VikLayerTypeEnum type, VikViewport vp, gboolean interactive );
	281	gboolean vik_layer_properties ( VikLayer layer, VikViewport vp );
	282
	283	void vik_layer_realize ( VikLayer l, VikTreeview vt, GtkTreeIter * layer_iter );
	284	void vik_layer_post_read ( VikLayer layer, VikViewport vp, gboolean from_file );
	285
	286	gboolean vik_layer_sublayer_add_menu_items ( VikLayer l, GtkMenu menu, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter iter, VikViewport vvp );
	287
	288	VikLayer vik_layer_copy ( VikLayer vl, gpointer vp );
	289	void vik_layer_marshall ( VikLayer vl, guint8 data, gint len );
	290	VikLayer vik_layer_unmarshall ( guint8 data, gint len, VikViewport *vvp );
	291	void vik_layer_marshall_params ( VikLayer vl, guint8 data, gint len );
	292	void vik_layer_unmarshall_params ( VikLayer vl, guint8 data, gint len, VikViewport *vvp );
	293
	294	const gchar vik_layer_sublayer_rename_request ( VikLayer l, const gchar newname, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter iter );
	295
	296	gboolean vik_layer_sublayer_toggle_visible ( VikLayer *l, gint subtype, gpointer sublayer );
	297
	298	const gchar* vik_layer_sublayer_tooltip ( VikLayer *l, gint subtype, gpointer sublayer );
	299
	300	const gchar* vik_layer_layer_tooltip ( VikLayer *l );
	301
	302	gboolean vik_layer_selected ( VikLayer *l, gint subtype, gpointer sublayer, gint type, gpointer vlp );
	303
	304	/* TODO: put in layerspanel */
	305	GdkPixbuf *vik_layer_load_icon ( VikLayerTypeEnum type );
	306
	307	VikLayer *vik_layer_get_and_reset_trigger();
	308	void vik_layer_emit_update_secondary ( VikLayer vl ); / to be called by aggregate layer only. doesn't set the trigger */
	309	void vik_layer_emit_update_although_invisible ( VikLayer *vl );
	310
	311	VikLayerTypeEnum vik_layer_type_from_string ( const gchar *str );
	312
	313	typedef struct {
	314	VikLayerParamData data;
	315	VikLayerParamType type;
	316	} VikLayerTypedParamData;
	317
	318	void vik_layer_typed_param_data_free ( gpointer gp );
	319	VikLayerTypedParamData *vik_layer_typed_param_data_copy_from_data ( VikLayerParamType type, VikLayerParamData val );
	320	VikLayerTypedParamData vik_layer_data_typed_param_copy_from_string ( VikLayerParamType type, const gchar str );
	321
	322	G_END_DECLS
	323
	324	#endif