src/viklayer.h

   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 #define VIK_LAYER_TYPE            (vik_layer_get_type ())
  35 #define VIK_LAYER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), VIK_LAYER_TYPE, VikLayer))
  36 #define VIK_LAYER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), VIK_LAYER_TYPE, VikLayerClass))
  37 #define IS_VIK_LAYER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), VIK_LAYER_TYPE))
  38 #define IS_VIK_LAYER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), VIK_LAYER_TYPE))
  39
  40 typedef struct _VikLayer VikLayer;
  41 typedef struct _VikLayerClass VikLayerClass;
  42
  43 struct _VikLayerClass
  44 {
  45   GObjectClass object_class;
  46   void (* update) (VikLayer *vl);
  47 };
  48
  49 GType vik_layer_get_type ();
  50
  51 struct _VikLayer {
  52   GObject obj;
  53   gchar *name;
  54   gboolean visible;
  55
  56   gboolean realized;
  57   VikTreeview *vt; /* simply a reference */
  58   GtkTreeIter iter;
  59
  60   /* for explicit "polymorphism" (function type switching) */
  61   guint16 type;
  62 };
  63
  64
  65
  66 enum {
  67   VIK_LAYER_AGGREGATE = 0,
  68   VIK_LAYER_TRW,
  69   VIK_LAYER_COORD,
  70   VIK_LAYER_GEOREF,
  71   VIK_LAYER_GPS,
  72   VIK_LAYER_MAPS,
  73   VIK_LAYER_DEM,
  74   VIK_LAYER_NUM_TYPES
  75 };
  76
  77 /* I think most of these are ignored,
  78  * returning GRAB_FOCUS grabs the focus for mouse move,
  79  * mouse click, release always grabs focus. Focus allows key presses
  80  * to be handled.
  81  * It used to be that, if ignored, Viking could look for other layers.
  82  * this was useful for clicking a way/trackpoint in any layer,
  83  * if no layer was selected (find way/trackpoint)
  84  */
  85 typedef enum {
  86   VIK_LAYER_TOOL_IGNORED=0,
  87   VIK_LAYER_TOOL_ACK,
  88   VIK_LAYER_TOOL_ACK_REDRAW_ABOVE,
  89   VIK_LAYER_TOOL_ACK_REDRAW_ALL,
  90   VIK_LAYER_TOOL_ACK_REDRAW_IF_VISIBLE,
  91   VIK_LAYER_TOOL_ACK_GRAB_FOCUS, /* only for move */
  92 } VikLayerToolFuncStatus;
  93
  94 /* gpointer is tool-specific state created in the constructor */
  95 typedef gpointer (*VikToolConstructorFunc) (VikWindow *, VikViewport *);
  96 typedef void (*VikToolDestructorFunc) (gpointer);
  97 typedef VikLayerToolFuncStatus (*VikToolMouseFunc) (VikLayer *, GdkEventButton *, gpointer);
  98 typedef VikLayerToolFuncStatus (*VikToolMouseMoveFunc) (VikLayer *, GdkEventMotion *, gpointer);
  99 typedef void (*VikToolActivationFunc) (VikLayer *, gpointer);
 100 typedef gboolean (*VikToolKeyFunc) (VikLayer *, GdkEventKey *, gpointer);
 101
 102 typedef struct _VikToolInterface VikToolInterface;
 103 struct _VikToolInterface {
 104   gchar *name;
 105   VikToolConstructorFunc create;
 106   VikToolDestructorFunc destroy;
 107   VikToolActivationFunc activate;
 108   VikToolActivationFunc deactivate;
 109   VikToolMouseFunc click;
 110   VikToolMouseMoveFunc move;
 111   VikToolMouseFunc release;
 112   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. */
 113   GdkCursorType cursor_type;
 114   const GdkPixdata *cursor_data;
 115   const GdkCursor *cursor;
 116 };
 117
 118 /* Parameters (for I/O and Properties) */
 119 /* --> moved to uibuilder.h */
 120
 121
 122 /* layer interface functions */
 123
 124 /* Create a new layer of a certain type. Should be filled with defaults */
 125 typedef VikLayer *    (*VikLayerFuncCreate)                (VikViewport *);
 126
 127 /* normally only needed for layers with sublayers. This is called when they
 128  * are added to the treeview so they can add sublayers to the treeview. */
 129 typedef void          (*VikLayerFuncRealize)               (VikLayer *,VikTreeview *,GtkTreeIter *);
 130
 131 /* rarely used, this is called after a read operation or properties box is run.
 132  * usually used to create GC's that depend on params,
 133  * but GC's can also be created from create() or set_param() */
 134 typedef void          (*VikLayerFuncPostRead)              (VikLayer *,VikViewport *vp,gboolean from_file);
 135
 136 typedef void          (*VikLayerFuncFree)                  (VikLayer *);
 137
 138 /* do _not_ use this unless absolutely neccesary. Use the dynamic properties (see coordlayer for example)
 139   * returns TRUE if OK was pressed */
 140 typedef gboolean      (*VikLayerFuncProperties)            (VikLayer *,VikViewport *);
 141
 142 typedef void          (*VikLayerFuncDraw)                  (VikLayer *,VikViewport *);
 143 typedef void          (*VikLayerFuncChangeCoordMode)       (VikLayer *,VikCoordMode);
 144
 145 typedef void          (*VikLayerFuncSetMenuItemsSelection)          (VikLayer *,guint16);
 146 typedef guint16          (*VikLayerFuncGetMenuItemsSelection)          (VikLayer *);
 147
 148 typedef void          (*VikLayerFuncAddMenuItems)          (VikLayer *,GtkMenu *,gpointer); /* gpointer is a VikLayersPanel */
 149 typedef gboolean      (*VikLayerFuncSublayerAddMenuItems)  (VikLayer *,GtkMenu *,gpointer, /* first gpointer is a VikLayersPanel */
 150                                                             gint,gpointer,GtkTreeIter *);
 151 typedef const gchar * (*VikLayerFuncSublayerRenameRequest) (VikLayer *,const gchar *,gpointer,
 152                                                             gint,VikViewport *,GtkTreeIter *); /* first gpointer is a VikLayersPanel */
 153 typedef gboolean      (*VikLayerFuncSublayerToggleVisible) (VikLayer *,gint,gpointer);
 154 typedef const gchar * (*VikLayerFuncSublayerTooltip)       (VikLayer *,gint,gpointer);
 155 typedef const gchar * (*VikLayerFuncLayerTooltip)          (VikLayer *);
 156
 157 typedef void          (*VikLayerFuncMarshall)              (VikLayer *, guint8 **, gint *);
 158 typedef VikLayer *    (*VikLayerFuncUnmarshall)            (guint8 *, gint, VikViewport *);
 159
 160 /* returns TRUE if needs to redraw due to changed param */
 161 /* in parameter gboolean denotes if for file I/O, as opposed to display/cut/copy etc... operations */
 162 typedef gboolean      (*VikLayerFuncSetParam)              (VikLayer *, guint16, VikLayerParamData, VikViewport *, gboolean);
 163
 164 /* in parameter gboolean denotes if for file I/O, as opposed to display/cut/copy etc... operations */
 165 typedef VikLayerParamData
 166                       (*VikLayerFuncGetParam)              (VikLayer *, guint16, gboolean);
 167
 168 typedef void          (*VikLayerFuncReadFileData)          (VikLayer *, FILE *);
 169 typedef void          (*VikLayerFuncWriteFileData)         (VikLayer *, FILE *);
 170
 171 /* item manipulation */
 172 typedef void          (*VikLayerFuncDeleteItem)            (VikLayer *, gint, gpointer);
 173                                                          /*      layer, subtype, pointer to sub-item */
 174 typedef void          (*VikLayerFuncCopyItem)              (VikLayer *, gint, gpointer, guint8 **, guint *);
 175                                                          /*      layer, subtype, pointer to sub-item, return pointer, return len */
 176 typedef gboolean      (*VikLayerFuncPasteItem)             (VikLayer *, gint, guint8 *, guint);
 177 typedef void          (*VikLayerFuncFreeCopiedItem)        (gint, gpointer);
 178
 179 /* treeview drag and drop method. called on the destination layer. it is given a source and destination layer,
 180  * and the source and destination iters in the treeview.
 181  */
 182 typedef void          (*VikLayerFuncDragDropRequest)       (VikLayer *, VikLayer *, GtkTreeIter *, GtkTreePath *);
 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 *                     name;
 198   const GdkPixdata *                icon;
 199
 200   VikToolInterface *                tools;
 201   guint16                           tools_count;
 202
 203   /* for I/O reading to and from .vik files -- params like coordline width, color, etc. */
 204   VikLayerParam *                   params;
 205   guint16                           params_count;
 206   gchar **                          params_groups;
 207   guint8                            params_groups_count;
 208
 209   /* menu items to be created */
 210   VikStdLayerMenuItem               menu_items_selection;
 211
 212   VikLayerFuncCreate                create;
 213   VikLayerFuncRealize               realize;
 214   VikLayerFuncPostRead              post_read;
 215   VikLayerFuncFree                  free;
 216
 217   VikLayerFuncProperties            properties;
 218   VikLayerFuncDraw                  draw;
 219   VikLayerFuncChangeCoordMode       change_coord_mode;
 220
 221   VikLayerFuncSetMenuItemsSelection set_menu_selection;
 222   VikLayerFuncGetMenuItemsSelection get_menu_selection;
 223
 224   VikLayerFuncAddMenuItems          add_menu_items;
 225   VikLayerFuncSublayerAddMenuItems  sublayer_add_menu_items;
 226   VikLayerFuncSublayerRenameRequest sublayer_rename_request;
 227   VikLayerFuncSublayerToggleVisible sublayer_toggle_visible;
 228   VikLayerFuncSublayerTooltip       sublayer_tooltip;
 229   VikLayerFuncLayerTooltip          layer_tooltip;
 230
 231   VikLayerFuncMarshall              marshall;
 232   VikLayerFuncUnmarshall            unmarshall;
 233
 234   /* for I/O */
 235   VikLayerFuncSetParam              set_param;
 236   VikLayerFuncGetParam              get_param;
 237
 238   /* for I/O -- extra non-param data like TrwLayer data */
 239   VikLayerFuncReadFileData          read_file_data;
 240   VikLayerFuncWriteFileData         write_file_data;
 241
 242   VikLayerFuncDeleteItem            delete_item;
 243   VikLayerFuncCopyItem              copy_item;
 244   VikLayerFuncPasteItem             paste_item;
 245   VikLayerFuncFreeCopiedItem        free_copied_item;
 246
 247   VikLayerFuncDragDropRequest       drag_drop_request;
 248 };
 249
 250 VikLayerInterface *vik_layer_get_interface ( gint type );
 251
 252
 253 void vik_layer_init ( VikLayer *vl, gint type );
 254 void vik_layer_draw ( VikLayer *l, gpointer data );
 255 void vik_layer_change_coord_mode ( VikLayer *l, VikCoordMode mode );
 256 void vik_layer_rename ( VikLayer *l, const gchar *new_name );
 257 void vik_layer_rename_no_copy ( VikLayer *l, gchar *new_name );
 258 const gchar *vik_layer_get_name ( VikLayer *l );
 259
 260 gboolean vik_layer_set_param (VikLayer *layer, guint16 id, VikLayerParamData data, gpointer vp, gboolean is_file_operation);
 261
 262 void vik_layer_emit_update ( VikLayer *vl );
 263
 264 /* GUI */
 265 void vik_layer_set_menu_items_selection(VikLayer *l, guint16 selection);
 266 guint16 vik_layer_get_menu_items_selection(VikLayer *l);
 267 void vik_layer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp );
 268 VikLayer *vik_layer_create ( gint type, gpointer vp, GtkWindow *w, gboolean interactive );
 269 gboolean vik_layer_properties ( VikLayer *layer, gpointer vp );
 270
 271 void vik_layer_realize ( VikLayer *l, VikTreeview *vt, GtkTreeIter * layer_iter );
 272 void vik_layer_post_read ( VikLayer *layer, VikViewport *vp, gboolean from_file );
 273
 274 gboolean vik_layer_sublayer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter );
 275
 276 VikLayer *vik_layer_copy ( VikLayer *vl, gpointer vp );
 277 void      vik_layer_marshall ( VikLayer *vl, guint8 **data, gint *len );
 278 VikLayer *vik_layer_unmarshall ( guint8 *data, gint len, VikViewport *vvp );
 279 void      vik_layer_marshall_params ( VikLayer *vl, guint8 **data, gint *len );
 280 void      vik_layer_unmarshall_params ( VikLayer *vl, guint8 *data, gint len, VikViewport *vvp );
 281
 282 const gchar *vik_layer_sublayer_rename_request ( VikLayer *l, const gchar *newname, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter );
 283
 284 gboolean vik_layer_sublayer_toggle_visible ( VikLayer *l, gint subtype, gpointer sublayer );
 285
 286 const gchar* vik_layer_sublayer_tooltip ( VikLayer *l, gint subtype, gpointer sublayer );
 287
 288 const gchar* vik_layer_layer_tooltip ( VikLayer *l );
 289
 290 /* TODO: put in layerspanel */
 291 GdkPixbuf *vik_layer_load_icon ( gint type );
 292
 293 VikLayer *vik_layer_get_and_reset_trigger();
 294 void vik_layer_emit_update_secondary ( VikLayer *vl ); /* to be called by aggregate layer only. doesn't set the trigger */
 295 void vik_layer_emit_update_although_invisible ( VikLayer *vl );
 296
 297 #endif