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