src/viktreeview.c

   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 #ifdef HAVE_CONFIG_H
  23 #include "config.h"
  24 #endif
  25
  26 #include <gtk/gtk.h>
  27 #include <glib/gi18n.h>
  28
  29 #include <string.h>
  30
  31 #include "viking.h"
  32 #include "config.h"
  33
  34 #define TREEVIEW_GET(model,iter,what,dest) gtk_tree_model_get(GTK_TREE_MODEL(model),(iter),(what),(dest),-1)
  35
  36 enum {
  37   VT_ITEM_EDITED_SIGNAL,
  38   VT_ITEM_TOGGLED_SIGNAL,
  39   VT_LAST_SIGNAL
  40 };
  41
  42 static guint treeview_signals[VT_LAST_SIGNAL] = { 0, 0 };
  43
  44 static GObjectClass *parent_class;
  45
  46 enum
  47 {
  48   NAME_COLUMN = 0,
  49   VISIBLE_COLUMN,
  50   ICON_COLUMN,
  51   /* invisible */
  52
  53   TYPE_COLUMN,
  54   ITEM_PARENT_COLUMN,
  55   ITEM_POINTER_COLUMN,
  56   ITEM_DATA_COLUMN,
  57   HAS_VISIBLE_COLUMN,
  58   EDITABLE_COLUMN,
  59   /* properties dialog, delete, rename, etc. */
  60   NUM_COLUMNS
  61 };
  62
  63 struct _VikTreeview {
  64   GtkTreeView treeview;
  65   GtkTreeModel *model;
  66
  67   GdkPixbuf *layer_type_icons[VIK_LAYER_NUM_TYPES];
  68
  69   gboolean was_a_toggle;
  70   gboolean editing;
  71 };
  72
  73 /* TODO: find, make "static" and put up here all non-"a_" functions */
  74 static void vik_treeview_finalize ( GObject *gob );
  75 static void vik_treeview_add_columns ( VikTreeview *vt );
  76
  77 static gboolean vik_treeview_drag_data_received ( GtkTreeDragDest *drag_dest, GtkTreePath *dest, GtkSelectionData *selection_data );
  78 static gboolean vik_treeview_drag_data_delete ( GtkTreeDragSource *drag_source, GtkTreePath *path );
  79
  80 G_DEFINE_TYPE (VikTreeview, vik_treeview, GTK_TYPE_TREE_VIEW)
  81
  82 static void vik_cclosure_marshal_VOID__POINTER_POINTER ( GClosure     *closure,
  83                                                          GValue       *return_value,
  84                                                          guint         n_param_vals,
  85                                                          const GValue *param_values,
  86                                                          gpointer      invocation_hint,
  87                                                          gpointer      marshal_data )
  88 {
  89   typedef gboolean (*VikMarshalFunc_VOID__POINTER_POINTER) ( gpointer      data1,
  90                                                              gconstpointer arg_1,
  91                                                              gconstpointer arg_2,
  92                                                              gpointer      data2 );
  93
  94   register VikMarshalFunc_VOID__POINTER_POINTER callback;
  95   register GCClosure* cc = (GCClosure*) closure;
  96   register gpointer data1, data2;
  97
  98   g_return_if_fail (n_param_vals == 3);
  99
 100   if (G_CCLOSURE_SWAP_DATA(closure)) {
 101     data1 = closure->data;
 102     data2 = g_value_peek_pointer (param_values + 0);
 103   }
 104   else {
 105     data1 = g_value_peek_pointer (param_values + 0);
 106     data2 = closure->data;
 107   }
 108   callback = (VikMarshalFunc_VOID__POINTER_POINTER) (marshal_data ? marshal_data : cc->callback);
 109   callback ( data1,
 110              g_value_get_pointer(param_values + 1),
 111              g_value_get_pointer(param_values + 2),
 112              data2 );
 113 }
 114
 115 static void vik_treeview_class_init ( VikTreeviewClass *klass )
 116 {
 117   /* Destructor */
 118   GObjectClass *object_class;
 119
 120   object_class = G_OBJECT_CLASS (klass);
 121
 122   object_class->finalize = vik_treeview_finalize;
 123
 124   parent_class = g_type_class_peek_parent (klass);
 125
 126   treeview_signals[VT_ITEM_EDITED_SIGNAL] = g_signal_new ( "item_edited", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION, G_STRUCT_OFFSET (VikTreeviewClass, item_edited), NULL, NULL,
 127     vik_cclosure_marshal_VOID__POINTER_POINTER, G_TYPE_NONE, 2, G_TYPE_POINTER, G_TYPE_POINTER);
 128
 129   treeview_signals[VT_ITEM_TOGGLED_SIGNAL] = g_signal_new ( "item_toggled", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_FIRST | G_SIGNAL_ACTION, G_STRUCT_OFFSET (VikTreeviewClass, item_toggled), NULL, NULL,
 130     g_cclosure_marshal_VOID__POINTER, G_TYPE_NONE, 1, G_TYPE_POINTER );
 131 }
 132
 133 static void vik_treeview_edited_cb (GtkCellRendererText *cell, gchar *path_str, const gchar *new_name, VikTreeview *vt)
 134 {
 135   vt->editing = FALSE;
 136   GtkTreeIter iter;
 137
 138   /* get type and data */
 139   vik_treeview_get_iter_from_path_str ( vt, &iter, path_str );
 140
 141   g_signal_emit ( G_OBJECT(vt), treeview_signals[VT_ITEM_EDITED_SIGNAL], 0, &iter, new_name );
 142 }
 143
 144 static void vik_treeview_edit_start_cb (GtkCellRenderer *cell, GtkCellEditable *editable, gchar *path, VikTreeview *vt)
 145 {
 146   vt->editing = TRUE;
 147 }
 148
 149 static void vik_treeview_edit_stop_cb (GtkCellRenderer *cell, VikTreeview *vt)
 150 {
 151   vt->editing = FALSE;
 152 }
 153
 154 static void vik_treeview_toggled_cb (GtkCellRendererToggle *cell, gchar *path_str, VikTreeview *vt)
 155 {
 156   GtkTreeIter iter_toggle;
 157   GtkTreeIter iter_selected;
 158
 159   /* get type and data */
 160   vik_treeview_get_iter_from_path_str ( vt, &iter_toggle, path_str );
 161
 162   GtkTreePath *tp_toggle = gtk_tree_model_get_path ( vt->model, &iter_toggle );
 163
 164   if ( gtk_tree_selection_get_selected ( gtk_tree_view_get_selection ( GTK_TREE_VIEW ( vt ) ), NULL, &iter_selected ) ) {
 165     GtkTreePath *tp_selected = gtk_tree_model_get_path ( vt->model, &iter_selected );
 166     if ( gtk_tree_path_compare ( tp_toggle, tp_selected ) )
 167       // Toggle set on different path
 168       // therefore prevent subsequent auto selection (otherwise no action needed)
 169       vt->was_a_toggle = TRUE;
 170     gtk_tree_path_free ( tp_selected );
 171   }
 172   else
 173     // Toggle set on new path
 174     // therefore prevent subsequent auto selection
 175     vt->was_a_toggle = TRUE;
 176
 177   gtk_tree_path_free ( tp_toggle );
 178
 179   g_signal_emit ( G_OBJECT(vt), treeview_signals[VT_ITEM_TOGGLED_SIGNAL], 0, &iter_toggle );
 180 }
 181
 182 /* Inspired by GTK+ test
 183  * http://git.gnome.org/browse/gtk+/tree/tests/testtooltips.c
 184  */
 185 static gboolean
 186 vik_treeview_tooltip_cb (GtkWidget  *widget,
 187                      gint        x,
 188                      gint        y,
 189                      gboolean    keyboard_tip,
 190                      GtkTooltip *tooltip,
 191                      gpointer    data)
 192 {
 193   GtkTreeIter iter;
 194   GtkTreeView *tree_view = GTK_TREE_VIEW (widget);
 195   GtkTreeModel *model = gtk_tree_view_get_model (tree_view);
 196   GtkTreePath *path = NULL;
 197
 198   char buffer[256];
 199
 200   if (!gtk_tree_view_get_tooltip_context (tree_view, &x, &y,
 201                                           keyboard_tip,
 202                                           &model, &path, &iter))
 203     return FALSE;
 204
 205   /* ATM normally treeview doesn't call into layers - maybe another level of redirection required? */
 206   gint rv;
 207   gtk_tree_model_get (model, &iter, TYPE_COLUMN, &rv, -1);
 208   if ( rv == VIK_TREEVIEW_TYPE_SUBLAYER ) {
 209
 210     gtk_tree_model_get (model, &iter, ITEM_DATA_COLUMN, &rv, -1);
 211
 212     gpointer sublayer;
 213     gtk_tree_model_get (model, &iter, ITEM_POINTER_COLUMN, &sublayer, -1);
 214
 215     gpointer parent;
 216     gtk_tree_model_get (model, &iter, ITEM_PARENT_COLUMN, &parent, -1);
 217
 218     g_snprintf (buffer, sizeof(buffer), "%s", vik_layer_sublayer_tooltip (VIK_LAYER(parent), rv, sublayer));
 219   }
 220   else if ( rv == VIK_TREEVIEW_TYPE_LAYER ) {
 221     gpointer layer;
 222     gtk_tree_model_get (model, &iter, ITEM_POINTER_COLUMN, &layer, -1);
 223     g_snprintf (buffer, sizeof(buffer), "%s", vik_layer_layer_tooltip (VIK_LAYER(layer)));
 224   }
 225   else {
 226     gtk_tree_path_free (path);
 227     return FALSE;
 228   }
 229
 230   // Don't display null strings :)
 231   if ( strncmp (buffer, "(null)", 6) == 0 ) {
 232     gtk_tree_path_free (path);
 233     return FALSE;
 234   }
 235   else {
 236     // No point in using (Pango) markup verson - gtk_tooltip_set_markup()
 237     //  especially as waypoint comments may well contain HTML markup which confuses the pango markup parser
 238     // This plain text is probably faster too.
 239     gtk_tooltip_set_text (tooltip, buffer);
 240   }
 241
 242   gtk_tree_view_set_tooltip_row (tree_view, tooltip, path);
 243
 244   gtk_tree_path_free (path);
 245
 246   return TRUE;
 247 }
 248
 249 VikTreeview *vik_treeview_new ()
 250 {
 251   return VIK_TREEVIEW ( g_object_new ( VIK_TREEVIEW_TYPE, NULL ) );
 252 }
 253
 254 gint vik_treeview_item_get_type ( VikTreeview *vt, GtkTreeIter *iter )
 255 {
 256   gint rv;
 257   TREEVIEW_GET ( vt->model, iter, TYPE_COLUMN, &rv );
 258   return rv;
 259 }
 260
 261 gchar* vik_treeview_item_get_name ( VikTreeview *vt, GtkTreeIter *iter )
 262 {
 263   gchar *rv;
 264   TREEVIEW_GET ( vt->model, iter, NAME_COLUMN, &rv );
 265   return rv;
 266 }
 267
 268 gint vik_treeview_item_get_data ( VikTreeview *vt, GtkTreeIter *iter )
 269 {
 270   gint rv;
 271   TREEVIEW_GET ( vt->model, iter, ITEM_DATA_COLUMN, &rv );
 272   return rv;
 273 }
 274
 275 gpointer vik_treeview_item_get_pointer ( VikTreeview *vt, GtkTreeIter *iter )
 276 {
 277   gpointer rv;
 278   TREEVIEW_GET ( vt->model, iter, ITEM_POINTER_COLUMN, &rv );
 279   return rv;
 280 }
 281
 282 void vik_treeview_item_set_pointer ( VikTreeview *vt, GtkTreeIter *iter, gpointer pointer )
 283 {
 284   gtk_tree_store_set ( GTK_TREE_STORE(vt->model), iter, ITEM_POINTER_COLUMN, pointer, -1 );
 285 }
 286
 287 gpointer vik_treeview_item_get_parent ( VikTreeview *vt, GtkTreeIter *iter )
 288 {
 289   gpointer rv;
 290   TREEVIEW_GET ( vt->model, iter, ITEM_PARENT_COLUMN, &rv );
 291   return rv;
 292 }
 293
 294 gboolean vik_treeview_get_iter_from_path_str ( VikTreeview *vt, GtkTreeIter *iter, const gchar *path_str )
 295 {
 296   return gtk_tree_model_get_iter_from_string ( GTK_TREE_MODEL(vt->model), iter, path_str );
 297 }
 298
 299 static void vik_treeview_add_columns ( VikTreeview *vt )
 300 {
 301   gint col_offset;
 302   GtkCellRenderer *renderer;
 303   GtkTreeViewColumn *column;
 304
 305   /* Layer column */
 306   renderer = gtk_cell_renderer_text_new ();
 307   g_signal_connect (renderer, "edited",
 308                     G_CALLBACK (vik_treeview_edited_cb), vt);
 309
 310   g_signal_connect (renderer, "editing-started", G_CALLBACK (vik_treeview_edit_start_cb), vt);
 311   g_signal_connect (renderer, "editing-canceled", G_CALLBACK (vik_treeview_edit_stop_cb), vt);
 312
 313   g_object_set (G_OBJECT (renderer), "xalign", 0.0, "ellipsize", PANGO_ELLIPSIZE_END, NULL);
 314
 315   col_offset = gtk_tree_view_insert_column_with_attributes (GTK_TREE_VIEW (vt),
 316                                                             -1, _("Layer Name"),
 317                                                             renderer, "text",
 318                                                             NAME_COLUMN,
 319                                                             "editable", EDITABLE_COLUMN,
 320                                                             NULL);
 321
 322   /* ATM the minimum overall width (and starting default) of the treeview size is determined
 323      by the buttons added to the bottom of the layerspanel */
 324   column = gtk_tree_view_get_column (GTK_TREE_VIEW (vt), col_offset - 1);
 325   gtk_tree_view_column_set_sizing (GTK_TREE_VIEW_COLUMN (column),
 326                                    GTK_TREE_VIEW_COLUMN_FIXED);
 327   gtk_tree_view_column_set_expand (GTK_TREE_VIEW_COLUMN (column), TRUE);
 328
 329   /* Layer type */
 330   renderer = gtk_cell_renderer_pixbuf_new ();
 331
 332   g_object_set (G_OBJECT (renderer), "xalign", 0.5, NULL);
 333
 334   col_offset = gtk_tree_view_insert_column_with_attributes (GTK_TREE_VIEW (vt),
 335                                                             -1, "",
 336                                                             renderer, "pixbuf",
 337                                                             ICON_COLUMN,
 338                                                             NULL);
 339
 340   column = gtk_tree_view_get_column (GTK_TREE_VIEW (vt), col_offset - 1);
 341   gtk_tree_view_column_set_sizing (GTK_TREE_VIEW_COLUMN (column),
 342                                    GTK_TREE_VIEW_COLUMN_AUTOSIZE);
 343
 344   /* Layer visible */
 345   renderer = gtk_cell_renderer_toggle_new ();
 346   g_object_set (G_OBJECT (renderer), "xalign", 0.5, NULL);
 347
 348   g_signal_connect (renderer, "toggled", G_CALLBACK (vik_treeview_toggled_cb), vt);
 349
 350   col_offset = gtk_tree_view_insert_column_with_attributes (GTK_TREE_VIEW (vt),
 351                                                             -1, "",
 352                                                             renderer,
 353                                                             "active",
 354                                                             VISIBLE_COLUMN,
 355                                                             "visible",
 356                                                             HAS_VISIBLE_COLUMN,
 357                                                             "activatable",
 358                                                             HAS_VISIBLE_COLUMN,
 359                                                             NULL);
 360
 361   column = gtk_tree_view_get_column (GTK_TREE_VIEW (vt), col_offset - 1);
 362   gtk_tree_view_column_set_sizing (GTK_TREE_VIEW_COLUMN (column),
 363                                    GTK_TREE_VIEW_COLUMN_AUTOSIZE);
 364
 365
 366   g_object_set (GTK_TREE_VIEW (vt), "has-tooltip", TRUE, NULL);
 367   g_signal_connect (GTK_TREE_VIEW (vt), "query-tooltip", G_CALLBACK (vik_treeview_tooltip_cb), vt);
 368 }
 369
 370 static void select_cb(GtkTreeSelection *selection, gpointer data)
 371 {
 372   VikTreeview *vt = data;
 373   gint type;
 374   GtkTreeIter iter, parent;
 375   VikLayer *vl;
 376   VikWindow * vw;
 377
 378   gpointer tmp_layer;
 379   VikLayer *tmp_vl = NULL;
 380   gint tmp_subtype = 0;
 381   gint tmp_type = VIK_TREEVIEW_TYPE_LAYER;
 382
 383   if (!gtk_tree_selection_get_selected(selection, NULL, &iter)) return;
 384   type = vik_treeview_item_get_type( vt, &iter);
 385
 386   /* Find the Sublayer type if possible */
 387   tmp_layer = vik_treeview_item_get_pointer ( vt, &iter );
 388   if (tmp_layer) {
 389     if (type == VIK_TREEVIEW_TYPE_SUBLAYER) {
 390       tmp_vl = VIK_LAYER(vik_treeview_item_get_parent(vt, &iter));
 391       tmp_subtype = vik_treeview_item_get_data(vt, &iter);
 392       tmp_type = VIK_TREEVIEW_TYPE_SUBLAYER;
 393     }
 394   }
 395   else {
 396     tmp_subtype = vik_treeview_item_get_data(vt, &iter);
 397     tmp_type = VIK_TREEVIEW_TYPE_SUBLAYER;
 398   }
 399
 400   /* Go up the tree to find the Vik Layer */
 401   while ( type != VIK_TREEVIEW_TYPE_LAYER ) {
 402     if ( ! vik_treeview_item_get_parent_iter ( vt, &iter, &parent ) )
 403       return;
 404     iter = parent;
 405     type = vik_treeview_item_get_type (vt, &iter );
 406   }
 407
 408   vl = VIK_LAYER( vik_treeview_item_get_pointer ( vt, &iter ) );
 409
 410   vw = VIK_WINDOW(VIK_GTK_WINDOW_FROM_LAYER(vl));
 411   vik_window_selected_layer(vw, vl);
 412
 413   if (tmp_vl == NULL)
 414     tmp_vl = vl;
 415   /* Apply settings now we have the all details  */
 416   if ( vik_layer_selected ( tmp_vl,
 417                             tmp_subtype,
 418                             tmp_layer,
 419                             tmp_type,
 420                             vik_window_layers_panel(vw) ) ) {
 421     /* Redraw required */
 422     vik_layers_panel_emit_update ( vik_window_layers_panel(vw) );
 423   }
 424
 425 }
 426
 427 static gboolean vik_treeview_selection_filter(GtkTreeSelection *selection, GtkTreeModel *model, GtkTreePath *path, gboolean path_currently_selected, gpointer data)
 428 {
 429   VikTreeview *vt = data;
 430
 431   if (vt->was_a_toggle) {
 432     vt->was_a_toggle = FALSE;
 433     return FALSE;
 434   }
 435
 436   return TRUE;
 437 }
 438
 439 void vik_treeview_init ( VikTreeview *vt )
 440 {
 441   vt->was_a_toggle = FALSE;
 442   vt->editing = FALSE;
 443
 444   vt->model = GTK_TREE_MODEL(gtk_tree_store_new ( NUM_COLUMNS, G_TYPE_STRING, G_TYPE_BOOLEAN, GDK_TYPE_PIXBUF, G_TYPE_INT, G_TYPE_POINTER, G_TYPE_POINTER, G_TYPE_INT, G_TYPE_BOOLEAN, G_TYPE_BOOLEAN ));
 445
 446   /* create tree view */
 447   gtk_tree_selection_set_select_function(gtk_tree_view_get_selection (GTK_TREE_VIEW(vt)), vik_treeview_selection_filter, vt, NULL);
 448
 449   gtk_tree_view_set_model ( GTK_TREE_VIEW(vt), vt->model );
 450   vik_treeview_add_columns ( vt );
 451
 452   // Can not specify 'auto' sort order with a 'GtkTreeSortable' on the name since we want to control the ordering of layers
 453   // Thus need to create special sort to operate on a subsection of treeview (i.e. from a specific child either a layer or sublayer)
 454   // see vik_treeview_sort_children()
 455
 456   g_object_unref (vt->model);
 457
 458   gtk_tree_view_set_rules_hint (GTK_TREE_VIEW (vt), TRUE);
 459   gtk_tree_selection_set_mode (gtk_tree_view_get_selection (GTK_TREE_VIEW (vt)),
 460                                GTK_SELECTION_SINGLE);
 461
 462   /* Override treestore's dnd methods only; this is easier than deriving from GtkTreeStore.
 463    * The downside is that all treestores will have this behavior, so this needs to be
 464    * changed if we add more treeviews in the future.  //Alex
 465    */
 466   if (1) {
 467     GtkTreeDragSourceIface *isrc;
 468     GtkTreeDragDestIface *idest;
 469
 470     isrc = g_type_interface_peek (g_type_class_peek(G_OBJECT_TYPE(vt->model)), GTK_TYPE_TREE_DRAG_SOURCE);
 471     isrc->drag_data_delete = vik_treeview_drag_data_delete;
 472
 473     idest = g_type_interface_peek (g_type_class_peek(G_OBJECT_TYPE(vt->model)), GTK_TYPE_TREE_DRAG_DEST);
 474     idest->drag_data_received = vik_treeview_drag_data_received;
 475   }
 476
 477   VikLayerTypeEnum i;
 478   for ( i = 0; i < VIK_LAYER_NUM_TYPES; i++ )
 479     vt->layer_type_icons[i] = vik_layer_load_icon ( i ); /* if icon can't be loaded, it will be null and simply not be shown. */
 480
 481   gtk_tree_view_set_reorderable (GTK_TREE_VIEW(vt), TRUE);
 482   g_signal_connect(gtk_tree_view_get_selection (GTK_TREE_VIEW (vt)), "changed",
 483       G_CALLBACK(select_cb), vt);
 484
 485 }
 486
 487 gboolean vik_treeview_item_get_parent_iter ( VikTreeview *vt, GtkTreeIter *iter,  GtkTreeIter *parent )
 488 {
 489   return gtk_tree_model_iter_parent ( GTK_TREE_MODEL(vt->model), parent, iter );
 490 }
 491
 492 gboolean vik_treeview_move_item ( VikTreeview *vt, GtkTreeIter *iter, gboolean up )
 493 {
 494   gint t = vik_treeview_item_get_type ( vt, iter );
 495   if ( t == VIK_TREEVIEW_TYPE_LAYER )
 496   {
 497     GtkTreeIter switch_iter;
 498     if (up)
 499     {
 500       /* iter to path to iter */
 501       GtkTreePath *path = gtk_tree_model_get_path ( vt->model, iter );
 502       if ( !gtk_tree_path_prev ( path ) || !gtk_tree_model_get_iter ( vt->model, &switch_iter, path ) )
 503       {
 504         gtk_tree_path_free ( path );
 505         return FALSE;
 506       }
 507       gtk_tree_path_free ( path );
 508     }
 509     else
 510     {
 511       switch_iter = *iter;
 512       if ( !gtk_tree_model_iter_next ( vt->model, &switch_iter ) )
 513         return FALSE;
 514     }
 515     gtk_tree_store_swap ( GTK_TREE_STORE(vt->model), iter, &switch_iter );
 516     return TRUE;
 517     /* now, the easy part. actually switching them, not the GUI */
 518   } /* if item is map */
 519   return FALSE;
 520 }
 521
 522 gboolean vik_treeview_get_iter_at_pos ( VikTreeview *vt, GtkTreeIter *iter, gint x, gint y )
 523 {
 524   GtkTreePath *path;
 525   gtk_tree_view_get_path_at_pos ( GTK_TREE_VIEW(vt), x, y, &path, NULL, NULL, NULL );
 526   if ( ! path )
 527     return FALSE;
 528
 529   gtk_tree_model_get_iter (GTK_TREE_MODEL(vt->model), iter, path);
 530   gtk_tree_path_free ( path );
 531   return TRUE;
 532 }
 533
 534 /* Option to ensure visible */
 535 void vik_treeview_select_iter ( VikTreeview *vt, GtkTreeIter *iter, gboolean view_all )
 536 {
 537   GtkTreeView *tree_view = GTK_TREE_VIEW ( vt );
 538   GtkTreePath *path;
 539
 540   if ( view_all ) {
 541     path = gtk_tree_model_get_path ( gtk_tree_view_get_model (tree_view), iter );
 542     gtk_tree_view_expand_to_path ( tree_view, path );
 543   }
 544
 545   gtk_tree_selection_select_iter ( gtk_tree_view_get_selection ( tree_view ), iter );
 546
 547   if ( view_all ) {
 548     gtk_tree_view_scroll_to_cell  ( tree_view,
 549                                     path,
 550                                     gtk_tree_view_get_expander_column (tree_view),
 551                                     FALSE,
 552                                     0.0, 0.0 );
 553     gtk_tree_path_free ( path );
 554   }
 555 }
 556
 557 gboolean vik_treeview_get_selected_iter ( VikTreeview *vt, GtkTreeIter *iter )
 558 {
 559   return gtk_tree_selection_get_selected ( gtk_tree_view_get_selection ( GTK_TREE_VIEW ( vt ) ), NULL, iter );
 560 }
 561
 562 gboolean vik_treeview_get_editing ( VikTreeview *vt )
 563 {
 564   // Don't know how to get cell for the selected item
 565   //return GPOINTER_TO_INT(g_object_get_data ( G_OBJECT(cell), "editing" ));
 566   // Instead maintain our own value applying to the whole tree
 567   return vt->editing;
 568 }
 569
 570 void vik_treeview_item_delete ( VikTreeview *vt, GtkTreeIter *iter )
 571 {
 572   gtk_tree_store_remove ( GTK_TREE_STORE(vt->model), iter );
 573 }
 574
 575 /* Treeview Reform Project */
 576
 577 void vik_treeview_item_set_icon ( VikTreeview *vt, GtkTreeIter *iter, const GdkPixbuf *icon )
 578 {
 579   g_return_if_fail ( iter != NULL );
 580   gtk_tree_store_set ( GTK_TREE_STORE(vt->model), iter, ICON_COLUMN, icon, -1);
 581 }
 582
 583 void vik_treeview_item_set_name ( VikTreeview *vt, GtkTreeIter *iter, const gchar *to )
 584 {
 585   g_return_if_fail ( iter != NULL && to != NULL );
 586   gtk_tree_store_set ( GTK_TREE_STORE(vt->model), iter, NAME_COLUMN, to, -1);
 587 }
 588
 589 void vik_treeview_item_set_visible ( VikTreeview *vt, GtkTreeIter *iter, gboolean to )
 590 {
 591   g_return_if_fail ( iter != NULL );
 592   gtk_tree_store_set ( GTK_TREE_STORE(vt->model), iter, VISIBLE_COLUMN, to, -1 );
 593 }
 594
 595 void vik_treeview_item_toggle_visible ( VikTreeview *vt, GtkTreeIter *iter )
 596 {
 597   g_return_if_fail ( iter != NULL );
 598   gboolean to;
 599   TREEVIEW_GET ( vt->model, iter, VISIBLE_COLUMN, &to );
 600   to = !to;
 601   gtk_tree_store_set ( GTK_TREE_STORE(vt->model), iter, VISIBLE_COLUMN, to, -1 );
 602 }
 603
 604 void vik_treeview_expand ( VikTreeview *vt, GtkTreeIter *iter )
 605 {
 606   GtkTreePath *path;
 607   path = gtk_tree_model_get_path ( vt->model, iter );
 608   gtk_tree_view_expand_row ( GTK_TREE_VIEW(vt), path, FALSE );
 609   gtk_tree_path_free ( path );
 610 }
 611
 612 void vik_treeview_item_select ( VikTreeview *vt, GtkTreeIter *iter )
 613 {
 614   gtk_tree_selection_select_iter ( gtk_tree_view_get_selection ( GTK_TREE_VIEW ( vt ) ), iter );
 615 }
 616
 617 void vik_treeview_item_unselect ( VikTreeview *vt, GtkTreeIter *iter )
 618 {
 619   gtk_tree_selection_unselect_iter ( gtk_tree_view_get_selection ( GTK_TREE_VIEW ( vt ) ), iter );
 620 }
 621
 622 void vik_treeview_add_layer ( VikTreeview *vt, GtkTreeIter *parent_iter, GtkTreeIter *iter, const gchar *name, gpointer parent, gboolean above,
 623                               gpointer item, gint data, VikLayerTypeEnum layer_type )
 624 {
 625   g_assert ( iter != NULL );
 626   if ( above )
 627     gtk_tree_store_prepend ( GTK_TREE_STORE(vt->model), iter, parent_iter );
 628   else
 629     gtk_tree_store_append ( GTK_TREE_STORE(vt->model), iter, parent_iter );
 630   gtk_tree_store_set ( GTK_TREE_STORE(vt->model), iter, NAME_COLUMN, name, VISIBLE_COLUMN, TRUE,
 631     TYPE_COLUMN, VIK_TREEVIEW_TYPE_LAYER, ITEM_PARENT_COLUMN, parent, ITEM_POINTER_COLUMN, item,
 632     ITEM_DATA_COLUMN, data, HAS_VISIBLE_COLUMN, TRUE, EDITABLE_COLUMN, parent == NULL ? FALSE : TRUE,
 633     ICON_COLUMN, layer_type >= 0 ? vt->layer_type_icons[layer_type] : NULL, -1 );
 634 }
 635
 636 void vik_treeview_insert_layer ( VikTreeview *vt, GtkTreeIter *parent_iter, GtkTreeIter *iter, const gchar *name, gpointer parent, gboolean above,
 637                               gpointer item, gint data, VikLayerTypeEnum layer_type, GtkTreeIter *sibling )
 638 {
 639   g_assert ( iter != NULL );
 640   if (sibling) {
 641     if (above)
 642       gtk_tree_store_insert_before ( GTK_TREE_STORE(vt->model), iter, parent_iter, sibling );
 643     else
 644       gtk_tree_store_insert_after ( GTK_TREE_STORE(vt->model), iter, parent_iter, sibling );
 645   } else {
 646     if (above)
 647       gtk_tree_store_append ( GTK_TREE_STORE(vt->model), iter, parent_iter );
 648     else
 649       gtk_tree_store_prepend ( GTK_TREE_STORE(vt->model), iter, parent_iter );
 650   }
 651
 652   gtk_tree_store_set ( GTK_TREE_STORE(vt->model), iter, NAME_COLUMN, name, VISIBLE_COLUMN, TRUE,
 653     TYPE_COLUMN, VIK_TREEVIEW_TYPE_LAYER, ITEM_PARENT_COLUMN, parent, ITEM_POINTER_COLUMN, item,
 654     ITEM_DATA_COLUMN, data, HAS_VISIBLE_COLUMN, TRUE, EDITABLE_COLUMN, TRUE,
 655     ICON_COLUMN, layer_type >= 0 ? vt->layer_type_icons[layer_type] : NULL, -1 );
 656 }
 657
 658 void vik_treeview_add_sublayer ( VikTreeview *vt, GtkTreeIter *parent_iter, GtkTreeIter *iter, const gchar *name, gpointer parent, gpointer item,
 659                                  gint data, GdkPixbuf *icon, gboolean has_visible, gboolean editable )
 660 {
 661   g_assert ( iter != NULL );
 662
 663   gtk_tree_store_append ( GTK_TREE_STORE(vt->model), iter, parent_iter );
 664   gtk_tree_store_set ( GTK_TREE_STORE(vt->model), iter, NAME_COLUMN, name, VISIBLE_COLUMN, TRUE, TYPE_COLUMN, VIK_TREEVIEW_TYPE_SUBLAYER, ITEM_PARENT_COLUMN, parent, ITEM_POINTER_COLUMN, item, ITEM_DATA_COLUMN, data, HAS_VISIBLE_COLUMN, has_visible, EDITABLE_COLUMN, editable, ICON_COLUMN, icon, -1 );
 665 }
 666
 667 // Inspired by the internals of GtkTreeView sorting itself
 668 typedef struct _SortTuple
 669 {
 670   gint offset;
 671   gchar *name;
 672 } SortTuple;
 673
 674 /**
 675  * If order is true sort ascending, otherwise a descending sort
 676  */
 677 static gint sort_tuple_compare ( gconstpointer a, gconstpointer b, gpointer order )
 678 {
 679   SortTuple *sa = (SortTuple *)a;
 680   SortTuple *sb = (SortTuple *)b;
 681
 682   // Default ascending order
 683   gint answer = g_strcmp0 ( sa->name, sb->name );
 684
 685   if ( !GPOINTER_TO_INT(order) ) {
 686     // Invert sort order for descending order
 687     answer = -answer;
 688   }
 689
 690   return answer;
 691 }
 692
 693 /**
 694  * Note: I don't believe we can sensibility use built in model sort gtk_tree_model_sort_new_with_model() on the name,
 695  * since that would also sort the layers - but that needs to be user controlled for ordering, such as which maps get drawn on top.
 696  *
 697  * vik_treeview_sort_children:
 698  * @vt:     The treeview to operate on
 699  * @parent: The level within the treeview to sort
 700  * @order:  How the items should be sorted
 701  *
 702  * Use the gtk_tree_store_reorder method as it very quick
 703  *
 704  * This ordering can be performed on demand and works for any parent iterator (i.e. both sublayer and layer levels)
 705  *
 706  * It should be called whenever an individual sublayer item is added or renamed (or after a group of sublayer items have been added).
 707  *
 708  * Previously with insertion sort on every sublayer addition: adding 10,000 items would take over 30 seconds!
 709  * Now sorting after simply adding all tracks takes 1 second.
 710  * For a KML file with over 10,000 tracks (3Mb zipped) - See 'UK Hampshire Rights of Way'
 711  * http://www3.hants.gov.uk/row/row-maps.htm
 712  */
 713 void vik_treeview_sort_children ( VikTreeview *vt, GtkTreeIter *parent, vik_layer_sort_order_t order )
 714 {
 715   if ( order == VL_SO_NONE )
 716     // Nothing to do
 717     return;
 718
 719   GtkTreeModel *model = vt->model;
 720   GtkTreeIter child;
 721   if ( !gtk_tree_model_iter_children ( model, &child, parent ) )
 722     return;
 723
 724   guint length = gtk_tree_model_iter_n_children ( model, parent );
 725
 726   // Create an array to store the position offsets
 727   SortTuple *sort_array;
 728   sort_array = g_new ( SortTuple, length );
 729
 730   guint ii = 0;
 731   do {
 732     sort_array[ii].offset = ii;
 733     gtk_tree_model_get ( model, &child, NAME_COLUMN, &(sort_array[ii].name), -1 );
 734     ii++;
 735   } while ( gtk_tree_model_iter_next (model, &child) );
 736
 737   gboolean sort_order = (order == VL_SO_ALPHABETICAL_ASCENDING );
 738
 739   // Sort list...
 740   g_qsort_with_data (sort_array,
 741                      length,
 742                      sizeof (SortTuple),
 743                      sort_tuple_compare,
 744                      GINT_TO_POINTER(sort_order));
 745
 746   // As the sorted list contains the reordered position offsets, extract this and then apply to the treeview
 747   gint *positions = g_malloc ( sizeof(gdouble) * length );
 748   for ( ii = 0; ii < length; ii++ ) {
 749     positions[ii] = sort_array[ii].offset;
 750     g_free ( sort_array[ii].name );
 751   }
 752   g_free ( sort_array );
 753
 754   // This is extremely fast compared to the old alphabetical insertion
 755   gtk_tree_store_reorder ( GTK_TREE_STORE(model), parent, positions );
 756   g_free ( positions );
 757 }
 758
 759 static void vik_treeview_finalize ( GObject *gob )
 760 {
 761   VikTreeview *vt = VIK_TREEVIEW ( gob );
 762   VikLayerTypeEnum i;
 763   for ( i = 0; i < VIK_LAYER_NUM_TYPES; i++ )
 764     if ( vt->layer_type_icons[i] != NULL )
 765       g_object_unref ( G_OBJECT(vt->layer_type_icons[i]) );
 766
 767   G_OBJECT_CLASS(parent_class)->finalize(gob);
 768 }
 769
 770 static gboolean vik_treeview_drag_data_received (GtkTreeDragDest *drag_dest, GtkTreePath *dest, GtkSelectionData *selection_data)
 771 {
 772   GtkTreeModel *tree_model;
 773   GtkTreeModel *src_model = NULL;
 774   GtkTreePath *src_path = NULL, *dest_cp = NULL;
 775   gboolean retval = FALSE;
 776   GtkTreeIter src_iter, root_iter, dest_parent;
 777   VikTreeview *vt;
 778   VikLayer *vl;
 779
 780   g_return_val_if_fail (GTK_IS_TREE_STORE (drag_dest), FALSE);
 781
 782   tree_model = GTK_TREE_MODEL (drag_dest);
 783
 784   if (gtk_tree_get_row_drag_data (selection_data, &src_model, &src_path) && src_model == tree_model) {
 785     /*
 786      * Copy src_path to dest.  There are two subcases here, depending on what
 787      * is being dragged.
 788      *
 789      * 1. src_path is a layer. In this case, interpret the drop
 790      *    as a request to move the layer to a different aggregate layer.
 791      *    If the destination is not an aggregate layer, use the first
 792      *    ancestor that is.
 793      *
 794      * 2. src_path is a sublayer.  In this case, find ancestors of
 795      *    both source and destination nodes who are full layers,
 796      *    and call the move method of that layer type.
 797      *
 798      */
 799     if (!gtk_tree_model_get_iter (src_model, &src_iter, src_path)) {
 800       goto out;
 801     }
 802     if (!gtk_tree_path_compare(src_path, dest)) {
 803       goto out;
 804     }
 805
 806     dest_cp = gtk_tree_path_copy (dest);
 807
 808     gtk_tree_model_get_iter_first(tree_model, &root_iter);
 809     TREEVIEW_GET(tree_model, &root_iter, ITEM_POINTER_COLUMN, &vl);
 810     vt = vl->vt;
 811
 812
 813     if (gtk_tree_path_get_depth(dest_cp)>1) { /* can't be sibling of top layer */
 814       VikLayer *vl_src, *vl_dest;
 815
 816       /* Find the first ancestor that is a full layer, and store in dest_parent. */
 817       do {
 818         gtk_tree_path_up(dest_cp);
 819         gtk_tree_model_get_iter (src_model, &dest_parent, dest_cp);
 820       } while (gtk_tree_path_get_depth(dest_cp)>1 &&
 821                vik_treeview_item_get_type(vt, &dest_parent) != VIK_TREEVIEW_TYPE_LAYER);
 822
 823
 824       g_assert ( vik_treeview_item_get_parent(vt, &src_iter) );
 825       vl_src = vik_treeview_item_get_parent(vt, &src_iter);
 826       vl_dest = vik_treeview_item_get_pointer(vt, &dest_parent);
 827
 828       /* TODO: might want to allow different types, and let the clients handle how they want */
 829       if (vl_src->type == vl_dest->type && vik_layer_get_interface(vl_dest->type)->drag_drop_request) {
 830         //      g_print("moving an item from layer '%s' into layer '%s'\n", vl_src->name, vl_dest->name);
 831         vik_layer_get_interface(vl_dest->type)->drag_drop_request(vl_src, vl_dest, &src_iter, dest);
 832       }
 833     }
 834   }
 835
 836  out:
 837   if (dest_cp)
 838     gtk_tree_path_free(dest_cp);
 839   if (src_path)
 840     gtk_tree_path_free (src_path);
 841
 842   return retval;
 843 }
 844
 845 /*
 846  * This may not be necessary.
 847  */
 848 static gboolean vik_treeview_drag_data_delete ( GtkTreeDragSource *drag_source, GtkTreePath *path )
 849 {
 850   gchar *s_dest = gtk_tree_path_to_string(path);
 851   g_print(_("delete data from %s\n"), s_dest);
 852   g_free(s_dest);
 853   return FALSE;
 854 }