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 #include <stdio.h>
  22 #include "vikwindow.h"
  23
  24 #ifndef _VIKING_LAYER_H
  25 #define _VIKING_LAYER_H
  26
  27 #define VIK_LAYER_TYPE            (vik_layer_get_type ())
  28 #define VIK_LAYER(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), VIK_LAYER_TYPE, VikLayer))
  29 #define VIK_LAYER_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), VIK_LAYER_TYPE, VikLayerClass))
  30 #define IS_VIK_LAYER(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), VIK_LAYER_TYPE))
  31 #define IS_VIK_LAYER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), VIK_LAYER_TYPE))
  32
  33 typedef struct _VikLayer VikLayer;
  34 typedef struct _VikLayerClass VikLayerClass;
  35
  36 struct _VikLayerClass
  37 {
  38   GObjectClass object_class;
  39   void (* update) (VikLayer *vl);
  40 };
  41
  42 GType vik_layer_get_type ();
  43
  44 struct _VikLayer {
  45   GObject obj;
  46   gchar *name;
  47   gboolean visible;
  48
  49   gboolean realized;
  50   VikTreeview *vt; /* simply a refernce */
  51   GtkTreeIter iter;
  52
  53   /* for explicit "polymorphism" (function type switching) */
  54   guint16 type;
  55 };
  56
  57
  58
  59 enum {
  60   VIK_LAYER_AGGREGATE = 0,
  61   VIK_LAYER_TRW,
  62   VIK_LAYER_COORD,
  63   VIK_LAYER_GEOREF,
  64   VIK_LAYER_GPS,
  65   VIK_LAYER_MAPS,
  66   VIK_LAYER_NUM_TYPES
  67 };
  68
  69 typedef enum {
  70   VIK_LAYER_TOOL_IGNORED=0,
  71   VIK_LAYER_TOOL_ACK,
  72   VIK_LAYER_TOOL_ACK_REDRAW_ABOVE,
  73   VIK_LAYER_TOOL_ACK_REDRAW_ALL,
  74   VIK_LAYER_TOOL_ACK_REDRAW_IF_VISIBLE
  75 } VikLayerToolFuncStatus;
  76
  77 /* gpointer is tool-specific state created in the constructor */
  78 typedef gpointer (*VikToolConstructorFunc) (VikWindow *, VikViewport *);
  79 typedef void (*VikToolDestructorFunc) (gpointer);
  80 typedef VikLayerToolFuncStatus (*VikToolMouseFunc) (VikLayer *, GdkEventButton *, gpointer);
  81 typedef void (*VikToolActivationFunc) (VikLayer *, gpointer);
  82
  83 typedef struct _VikToolInterface VikToolInterface;
  84 struct _VikToolInterface {
  85   gchar *name;
  86   VikToolConstructorFunc create;
  87   VikToolDestructorFunc destroy;
  88   VikToolActivationFunc activate;
  89   VikToolActivationFunc deactivate;
  90   VikToolMouseFunc click;
  91   VikToolMouseFunc move;
  92   VikToolMouseFunc release;
  93 };
  94
  95 /* Parameters (for I/O and Properties) */
  96
  97 typedef union {
  98   gdouble d;
  99   guint32 u;
 100   gint32 i;
 101   gboolean b;
 102   const gchar *s;
 103   GdkColor c;
 104 } VikLayerParamData;
 105
 106 typedef struct {
 107   const gchar *name;
 108   guint8 type;
 109   gint16 group;
 110   const gchar *title;
 111   guint8 widget_type;
 112   const gpointer widget_data;
 113   const gpointer extra_widget_data;
 114 } VikLayerParam;
 115
 116 enum {
 117 VIK_LAYER_NOT_IN_PROPERTIES=-2,
 118 VIK_LAYER_GROUP_NONE=-1
 119 };
 120
 121 enum {
 122 VIK_LAYER_WIDGET_CHECKBUTTON=0,
 123 VIK_LAYER_WIDGET_RADIOGROUP,
 124 VIK_LAYER_WIDGET_SPINBUTTON,
 125 VIK_LAYER_WIDGET_ENTRY,
 126 VIK_LAYER_WIDGET_FILEENTRY,
 127 VIK_LAYER_WIDGET_HSCALE,
 128 VIK_LAYER_WIDGET_COLOR,
 129 VIK_LAYER_WIDGET_COMBOBOX,
 130 };
 131
 132 typedef struct {
 133   gdouble min;
 134   gdouble max;
 135   gdouble step;
 136   guint8 digits;
 137 } VikLayerParamScale;
 138
 139 /* id is index */
 140 enum {
 141 VIK_LAYER_PARAM_DOUBLE=1,
 142 VIK_LAYER_PARAM_UINT,
 143 VIK_LAYER_PARAM_INT,
 144 VIK_LAYER_PARAM_STRING,
 145 VIK_LAYER_PARAM_BOOLEAN,
 146 VIK_LAYER_PARAM_COLOR,
 147 };
 148
 149 /* layer interface functions */
 150
 151 /* Create a new layer of a certain type. Should be filled with defaults */
 152 typedef VikLayer *    (*VikLayerFuncCreate)                (VikViewport *);
 153
 154 /* normally only needed for layers with sublayers. This is called when they
 155  * are added to the treeview so they can add sublayers to the treeview. */
 156 typedef void          (*VikLayerFuncRealize)               (VikLayer *,VikTreeview *,GtkTreeIter *);
 157
 158 /* rarely used, this is called after a read operation or properties box is run.
 159  * usually used to create GC's that depend on params,
 160  * but GC's can also be created from create() or set_param() */
 161 typedef void          (*VikLayerFuncPostRead)              (VikLayer *,gpointer vp);
 162
 163 typedef void          (*VikLayerFuncFree)                  (VikLayer *);
 164
 165 /* do _not_ use this unless absolutely neccesary. Use the dynamic properties (see coordlayer for example)
 166   * returns TRUE if OK was pressed */
 167 typedef gboolean      (*VikLayerFuncProperties)            (VikLayer *,VikViewport *); /* gpointer is a VikViewport */
 168
 169 typedef void          (*VikLayerFuncDraw)                  (VikLayer *,VikViewport *);
 170 typedef void          (*VikLayerFuncChangeCoordMode)       (VikLayer *,VikCoordMode);
 171
 172 typedef void          (*VikLayerFuncAddMenuItems)          (VikLayer *,GtkMenu *,gpointer); /* gpointer is a VikLayersPanel */
 173 typedef gboolean      (*VikLayerFuncSublayerAddMenuItems)  (VikLayer *,GtkMenu *,gpointer, /* first gpointer is a VikLayersPanel */
 174                                                             gint,gpointer,GtkTreeIter *);
 175 typedef const gchar * (*VikLayerFuncSublayerRenameRequest) (VikLayer *,const gchar *,gpointer,
 176                                                             gint,VikViewport *,GtkTreeIter *); /* first gpointer is a VikLayersPanel */
 177 typedef gboolean      (*VikLayerFuncSublayerToggleVisible) (VikLayer *,gint,gpointer);
 178
 179 typedef VikLayer *    (*VikLayerFuncCopy)                  (VikLayer *,VikViewport *);
 180 typedef void          (*VikLayerFuncMarshall)              (VikLayer *, guint8 **, gint *);
 181 typedef VikLayer *    (*VikLayerFuncUnmarshall)            (guint8 *, gint, VikViewport *);
 182
 183 /* returns TRUE if needs to redraw due to changed param */
 184 typedef gboolean      (*VikLayerFuncSetParam)              (VikLayer *, guint16, VikLayerParamData, VikViewport *);
 185
 186 typedef VikLayerParamData
 187                       (*VikLayerFuncGetParam)              (VikLayer *, guint16);
 188
 189 typedef void          (*VikLayerFuncReadFileData)          (VikLayer *, FILE *);
 190 typedef void          (*VikLayerFuncWriteFileData)         (VikLayer *, FILE *);
 191
 192 /* item manipulation */
 193 typedef void          (*VikLayerFuncDeleteItem)            (VikLayer *, gint, gpointer);
 194                                                          /*      layer, subtype, pointer to sub-item */
 195 typedef void          (*VikLayerFuncCopyItem)              (VikLayer *, gint, gpointer, guint8 **, guint *);
 196                                                          /*      layer, subtype, pointer to sub-item, return pointer, return len */
 197 typedef gboolean      (*VikLayerFuncPasteItem)             (VikLayer *, gint, guint8 *, guint);
 198 typedef void          (*VikLayerFuncFreeCopiedItem)        (gint, gpointer);
 199
 200 /* treeview drag and drop method. called on the destination layer. it is given a source and destination layer,
 201  * and the source and destination iters in the treeview.
 202  */
 203 typedef void          (*VikLayerFuncDragDropRequest)       (VikLayer *, VikLayer *, GtkTreeIter *, GtkTreePath *);
 204
 205
 206 typedef struct _VikLayerInterface VikLayerInterface;
 207
 208 /* See vik_layer_* for function parameter names */
 209 struct _VikLayerInterface {
 210   const gchar *                     name;
 211   const GdkPixdata *                icon;
 212
 213   VikToolInterface *                tools;
 214   guint16                           tools_count;
 215
 216   /* for I/O reading to and from .vik files -- params like coordline width, color, etc. */
 217   VikLayerParam *                   params;
 218   guint16                           params_count;
 219   gchar **                          params_groups;
 220   guint8                            params_groups_count;
 221
 222   VikLayerFuncCreate                create;
 223   VikLayerFuncRealize               realize;
 224   VikLayerFuncPostRead              post_read;
 225   VikLayerFuncFree                  free;
 226
 227   VikLayerFuncProperties            properties;
 228   VikLayerFuncDraw                  draw;
 229   VikLayerFuncChangeCoordMode       change_coord_mode;
 230
 231   VikLayerFuncAddMenuItems          add_menu_items;
 232   VikLayerFuncSublayerAddMenuItems  sublayer_add_menu_items;
 233   VikLayerFuncSublayerRenameRequest sublayer_rename_request;
 234   VikLayerFuncSublayerToggleVisible sublayer_toggle_visible;
 235
 236   VikLayerFuncCopy                  copy;
 237   VikLayerFuncMarshall              marshall;
 238   VikLayerFuncUnmarshall            unmarshall;
 239
 240   /* for I/O */
 241   VikLayerFuncSetParam              set_param;
 242   VikLayerFuncGetParam              get_param;
 243
 244   /* for I/O -- extra non-param data like TrwLayer data */
 245   VikLayerFuncReadFileData          read_file_data;
 246   VikLayerFuncWriteFileData         write_file_data;
 247
 248   VikLayerFuncDeleteItem            delete_item;
 249   VikLayerFuncCopyItem              copy_item;
 250   VikLayerFuncPasteItem             paste_item;
 251   VikLayerFuncFreeCopiedItem        free_copied_item;
 252
 253   VikLayerFuncDragDropRequest       drag_drop_request;
 254 };
 255
 256 VikLayerInterface *vik_layer_get_interface ( gint type );
 257
 258
 259 void vik_layer_init ( VikLayer *vl, gint type );
 260 void vik_layer_draw ( VikLayer *l, gpointer data );
 261 void vik_layer_change_coord_mode ( VikLayer *l, VikCoordMode mode );
 262 void vik_layer_rename ( VikLayer *l, const gchar *new_name );
 263 void vik_layer_rename_no_copy ( VikLayer *l, gchar *new_name );
 264
 265 gboolean vik_layer_set_param (VikLayer *layer, guint16 id, VikLayerParamData data, gpointer vp);
 266
 267 void vik_layer_emit_update ( VikLayer *vl );
 268
 269 /* GUI */
 270 void vik_layer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp );
 271 VikLayer *vik_layer_create ( gint type, gpointer vp, GtkWindow *w, gboolean interactive );
 272 gboolean vik_layer_properties ( VikLayer *layer, gpointer vp );
 273
 274 void vik_layer_realize ( VikLayer *l, VikTreeview *vt, GtkTreeIter * layer_iter );
 275 void vik_layer_post_read ( VikLayer *layer, gpointer vp );
 276
 277 gboolean vik_layer_sublayer_add_menu_items ( VikLayer *l, GtkMenu *menu, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter );
 278
 279 VikLayer *vik_layer_copy ( VikLayer *vl, gpointer vp );
 280 void      vik_layer_marshall ( VikLayer *vl, guint8 **data, gint *len );
 281 VikLayer *vik_layer_unmarshall ( guint8 *data, gint len, VikViewport *vvp );
 282 void      vik_layer_marshall_params ( VikLayer *vl, guint8 **data, gint *len );
 283 void      vik_layer_unmarshall_params ( VikLayer *vl, guint8 *data, gint len, VikViewport *vvp );
 284
 285 const gchar *vik_layer_sublayer_rename_request ( VikLayer *l, const gchar *newname, gpointer vlp, gint subtype, gpointer sublayer, GtkTreeIter *iter );
 286
 287 gboolean vik_layer_sublayer_toggle_visible ( VikLayer *l, gint subtype, gpointer sublayer );
 288
 289 /* TODO: put in layerspanel */
 290 GdkPixbuf *vik_layer_load_icon ( gint type );
 291
 292 #endif