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