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