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 /**
 300  * Get visibility of an item considering visibility of all parents
 301  *  i.e. if any parent is off then this item will also be considered off
 302  *   (even though itself may be marked as on.)
 303  */
 304 gboolean vik_treeview_item_get_visible_tree ( VikTreeview *vt, GtkTreeIter *iter )
 305 {
 306   gboolean ans;
 307   TREEVIEW_GET ( vt->model, iter, VISIBLE_COLUMN, &ans );
 308
 309   if ( !ans )
 310     return ans;
 311
 312   GtkTreeIter parent;
 313   GtkTreeIter child = *iter;
 314   while ( gtk_tree_model_iter_parent (vt->model, &parent, &child) ) {
 315     // Visibility of this parent
 316     TREEVIEW_GET ( vt->model, &parent, VISIBLE_COLUMN, &ans );
 317     // If not visible, no need to check further ancestors
 318     if ( !ans )
 319       break;
 320     child = parent;
 321   }
 322   return ans;
 323 }
 324
 325 static void vik_treeview_add_columns ( VikTreeview *vt )
 326 {
 327   gint col_offset;
 328   GtkCellRenderer *renderer;
 329   GtkTreeViewColumn *column;
 330
 331   /* Layer column */
 332   renderer = gtk_cell_renderer_text_new ();
 333   g_signal_connect (renderer, "edited",
 334                     G_CALLBACK (vik_treeview_edited_cb), vt);
 335
 336   g_signal_connect (renderer, "editing-started", G_CALLBACK (vik_treeview_edit_start_cb), vt);
 337   g_signal_connect (renderer, "editing-canceled", G_CALLBACK (vik_treeview_edit_stop_cb), vt);
 338
 339   g_object_set (G_OBJECT (renderer), "xalign", 0.0, "ellipsize", PANGO_ELLIPSIZE_END, NULL);
 340
 341   col_offset = gtk_tree_view_insert_column_with_attributes (GTK_TREE_VIEW (vt),
 342                                                             -1, _("Layer Name"),
 343                                                             renderer, "text",
 344                                                             NAME_COLUMN,
 345                                                             "editable", EDITABLE_COLUMN,
 346                                                             NULL);
 347
 348   /* ATM the minimum overall width (and starting default) of the treeview size is determined
 349      by the buttons added to the bottom of the layerspanel */
 350   column = gtk_tree_view_get_column (GTK_TREE_VIEW (vt), col_offset - 1);
 351   gtk_tree_view_column_set_sizing (GTK_TREE_VIEW_COLUMN (column),
 352                                    GTK_TREE_VIEW_COLUMN_FIXED);
 353   gtk_tree_view_column_set_expand (GTK_TREE_VIEW_COLUMN (column), TRUE);
 354
 355   /* Layer type */
 356   renderer = gtk_cell_renderer_pixbuf_new ();
 357
 358   g_object_set (G_OBJECT (renderer), "xalign", 0.5, NULL);
 359
 360   col_offset = gtk_tree_view_insert_column_with_attributes (GTK_TREE_VIEW (vt),
 361                                                             -1, "",
 362                                                             renderer, "pixbuf",
 363                                                             ICON_COLUMN,
 364                                                             NULL);
 365
 366   column = gtk_tree_view_get_column (GTK_TREE_VIEW (vt), col_offset - 1);
 367   gtk_tree_view_column_set_sizing (GTK_TREE_VIEW_COLUMN (column),
 368                                    GTK_TREE_VIEW_COLUMN_AUTOSIZE);
 369
 370   /* Layer visible */
 371   renderer = gtk_cell_renderer_toggle_new ();
 372   g_object_set (G_OBJECT (renderer), "xalign", 0.5, NULL);
 373
 374   g_signal_connect (renderer, "toggled", G_CALLBACK (vik_treeview_toggled_cb), vt);
 375
 376   col_offset = gtk_tree_view_insert_column_with_attributes (GTK_TREE_VIEW (vt),
 377                                                             -1, "",
 378                                                             renderer,
 379                                                             "active",
 380                                                             VISIBLE_COLUMN,
 381                                                             "visible",
 382                                                             HAS_VISIBLE_COLUMN,
 383                                                             "activatable",
 384                                                             HAS_VISIBLE_COLUMN,
 385                                                             NULL);
 386
 387   column = gtk_tree_view_get_column (GTK_TREE_VIEW (vt), col_offset - 1);
 388   gtk_tree_view_column_set_sizing (GTK_TREE_VIEW_COLUMN (column),
 389                                    GTK_TREE_VIEW_COLUMN_AUTOSIZE);
 390
 391
 392   g_object_set (GTK_TREE_VIEW (vt), "has-tooltip", TRUE, NULL);
 393   g_signal_connect (GTK_TREE_VIEW (vt), "query-tooltip", G_CALLBACK (vik_treeview_tooltip_cb), vt);
 394 }
 395
 396 static void select_cb(GtkTreeSelection *selection, gpointer data)
 397 {
 398   VikTreeview *vt = data;
 399   gint type;
 400   GtkTreeIter iter, parent;
 401   VikLayer *vl;
 402   VikWindow * vw;
 403
 404   gpointer tmp_layer;
 405   VikLayer *tmp_vl = NULL;
 406   gint tmp_subtype = 0;
 407   gint tmp_type = VIK_TREEVIEW_TYPE_LAYER;
 408
 409   if (!gtk_tree_selection_get_selected(selection, NULL, &iter)) return;
 410   type = vik_treeview_item_get_type( vt, &iter);
 411
 412   /* Find the Sublayer type if possible */
 413   tmp_layer = vik_treeview_item_get_pointer ( vt, &iter );
 414   if (tmp_layer) {
 415     if (type == VIK_TREEVIEW_TYPE_SUBLAYER) {
 416       tmp_vl = VIK_LAYER(vik_treeview_item_get_parent(vt, &iter));
 417       tmp_subtype = vik_treeview_item_get_data(vt, &iter);
 418       tmp_type = VIK_TREEVIEW_TYPE_SUBLAYER;
 419     }
 420   }
 421   else {
 422     tmp_subtype = vik_treeview_item_get_data(vt, &iter);
 423     tmp_type = VIK_TREEVIEW_TYPE_SUBLAYER;
 424   }
 425
 426   /* Go up the tree to find the Vik Layer */
 427   while ( type != VIK_TREEVIEW_TYPE_LAYER ) {
 428     if ( ! vik_treeview_item_get_parent_iter ( vt, &iter, &parent ) )
 429       return;
 430     iter = parent;
 431     type = vik_treeview_item_get_type (vt, &iter );
 432   }
 433
 434   vl = VIK_LAYER( vik_treeview_item_get_pointer ( vt, &iter ) );
 435
 436   vw = VIK_WINDOW(VIK_GTK_WINDOW_FROM_LAYER(vl));
 437   vik_window_selected_layer(vw, vl);
 438
 439   if (tmp_vl == NULL)
 440     tmp_vl = vl;
 441   /* Apply settings now we have the all details  */
 442   if ( vik_layer_selected ( tmp_vl,
 443                             tmp_subtype,
 444                             tmp_layer,
 445                             tmp_type,
 446                             vik_window_layers_panel(vw) ) ) {
 447     /* Redraw required */
 448     vik_layers_panel_emit_update ( vik_window_layers_panel(vw) );
 449   }
 450
 451 }
 452
 453 static gboolean vik_treeview_selection_filter(GtkTreeSelection *selection, GtkTreeModel *model, GtkTreePath *path, gboolean path_currently_selected, gpointer data)
 454 {
 455   VikTreeview *vt = data;
 456
 457   if (vt->was_a_toggle) {
 458     vt->was_a_toggle = FALSE;
 459     return FALSE;
 460   }
 461
 462   return TRUE;
 463 }
 464
 465 void vik_treeview_init ( VikTreeview *vt )
 466 {
 467   vt->was_a_toggle = FALSE;
 468   vt->editing = FALSE;
 469
 470   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 ));
 471
 472   /* create tree view */
 473   gtk_tree_selection_set_select_function(gtk_tree_view_get_selection (GTK_TREE_VIEW(vt)), vik_treeview_selection_filter, vt, NULL);
 474
 475   gtk_tree_view_set_model ( GTK_TREE_VIEW(vt), vt->model );
 476   vik_treeview_add_columns ( vt );
 477
 478   // Can not specify 'auto' sort order with a 'GtkTreeSortable' on the name since we want to control the ordering of layers
 479   // Thus need to create special sort to operate on a subsection of treeview (i.e. from a specific child either a layer or sublayer)
 480   // see vik_treeview_sort_children()
 481
 482   g_object_unref (vt->model);
 483
 484   gtk_tree_view_set_rules_hint (GTK_TREE_VIEW (vt), TRUE);
 485   gtk_tree_selection_set_mode (gtk_tree_view_get_selection (GTK_TREE_VIEW (vt)),
 486                                GTK_SELECTION_SINGLE);
 487
 488   /* Override treestore's dnd methods only; this is easier than deriving from GtkTreeStore.
 489    * The downside is that all treestores will have this behavior, so this needs to be
 490    * changed if we add more treeviews in the future.  //Alex
 491    */
 492   if (1) {
 493     GtkTreeDragSourceIface *isrc;
 494     GtkTreeDragDestIface *idest;
 495
 496     isrc = g_type_interface_peek (g_type_class_peek(G_OBJECT_TYPE(vt->model)), GTK_TYPE_TREE_DRAG_SOURCE);
 497     isrc->drag_data_delete = vik_treeview_drag_data_delete;
 498
 499     idest = g_type_interface_peek (g_type_class_peek(G_OBJECT_TYPE(vt->model)), GTK_TYPE_TREE_DRAG_DEST);
 500     idest->drag_data_received = vik_treeview_drag_data_received;
 501   }
 502
 503   VikLayerTypeEnum i;
 504   for ( i = 0; i < VIK_LAYER_NUM_TYPES; i++ )
 505     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. */
 506
 507   gtk_tree_view_set_reorderable (GTK_TREE_VIEW(vt), TRUE);
 508   g_signal_connect(gtk_tree_view_get_selection (GTK_TREE_VIEW (vt)), "changed",
 509       G_CALLBACK(select_cb), vt);
 510
 511 }
 512
 513 gboolean vik_treeview_item_get_parent_iter ( VikTreeview *vt, GtkTreeIter *iter,  GtkTreeIter *parent )
 514 {
 515   return gtk_tree_model_iter_parent ( GTK_TREE_MODEL(vt->model), parent, iter );
 516 }
 517
 518 gboolean vik_treeview_move_item ( VikTreeview *vt, GtkTreeIter *iter, gboolean up )
 519 {
 520   gint t = vik_treeview_item_get_type ( vt, iter );
 521   if ( t == VIK_TREEVIEW_TYPE_LAYER )
 522   {
 523     GtkTreeIter switch_iter;
 524     if (up)
 525     {
 526       /* iter to path to iter */
 527       GtkTreePath *path = gtk_tree_model_get_path ( vt->model, iter );
 528       if ( !gtk_tree_path_prev ( path ) || !gtk_tree_model_get_iter ( vt->model, &switch_iter, path ) )
 529       {
 530         gtk_tree_path_free ( path );
 531         return FALSE;
 532       }
 533       gtk_tree_path_free ( path );
 534     }
 535     else
 536     {
 537       switch_iter = *iter;
 538       if ( !gtk_tree_model_iter_next ( vt->model, &switch_iter ) )
 539         return FALSE;
 540     }
 541     gtk_tree_store_swap ( GTK_TREE_STORE(vt->model), iter, &switch_iter );
 542     return TRUE;
 543     /* now, the easy part. actually switching them, not the GUI */
 544   } /* if item is map */
 545   return FALSE;
 546 }
 547
 548 gboolean vik_treeview_get_iter_at_pos ( VikTreeview *vt, GtkTreeIter *iter, gint x, gint y )
 549 {
 550   GtkTreePath *path;
 551   gtk_tree_view_get_path_at_pos ( GTK_TREE_VIEW(vt), x, y, &path, NULL, NULL, NULL );
 552   if ( ! path )
 553     return FALSE;
 554
 555   gtk_tree_model_get_iter (GTK_TREE_MODEL(vt->model), iter, path);
 556   gtk_tree_path_free ( path );
 557   return TRUE;
 558 }
 559
 560 /* Option to ensure visible */
 561 void vik_treeview_select_iter ( VikTreeview *vt, GtkTreeIter *iter, gboolean view_all )
 562 {
 563   GtkTreeView *tree_view = GTK_TREE_VIEW ( vt );
 564   GtkTreePath *path;
 565
 566   if ( view_all ) {
 567     path = gtk_tree_model_get_path ( gtk_tree_view_get_model (tree_view), iter );
 568     gtk_tree_view_expand_to_path ( tree_view, path );
 569   }
 570
 571   gtk_tree_selection_select_iter ( gtk_tree_view_get_selection ( tree_view ), iter );
 572
 573   if ( view_all ) {
 574     gtk_tree_view_scroll_to_cell  ( tree_view,
 575                                     path,
 576                                     gtk_tree_view_get_expander_column (tree_view),
 577                                     FALSE,
 578                                     0.0, 0.0 );
 579     gtk_tree_path_free ( path );
 580   }
 581 }
 582
 583 gboolean vik_treeview_get_selected_iter ( VikTreeview *vt, GtkTreeIter *iter )
 584 {
 585   return gtk_tree_selection_get_selected ( gtk_tree_view_get_selection ( GTK_TREE_VIEW ( vt ) ), NULL, iter );
 586 }
 587
 588 gboolean vik_treeview_get_editing ( VikTreeview *vt )
 589 {
 590   // Don't know how to get cell for the selected item
 591   //return GPOINTER_TO_INT(g_object_get_data ( G_OBJECT(cell), "editing" ));
 592   // Instead maintain our own value applying to the whole tree
 593   return vt->editing;
 594 }
 595
 596 void vik_treeview_item_delete ( VikTreeview *vt, GtkTreeIter *iter )
 597 {
 598   gtk_tree_store_remove ( GTK_TREE_STORE(vt->model), iter );
 599 }
 600
 601 /* Treeview Reform Project */
 602
 603 void vik_treeview_item_set_icon ( VikTreeview *vt, GtkTreeIter *iter, const GdkPixbuf *icon )
 604 {
 605   g_return_if_fail ( iter != NULL );
 606   gtk_tree_store_set ( GTK_TREE_STORE(vt->model), iter, ICON_COLUMN, icon, -1);
 607 }
 608
 609 void vik_treeview_item_set_name ( VikTreeview *vt, GtkTreeIter *iter, const gchar *to )
 610 {
 611   g_return_if_fail ( iter != NULL && to != NULL );
 612   gtk_tree_store_set ( GTK_TREE_STORE(vt->model), iter, NAME_COLUMN, to, -1);
 613 }
 614
 615 void vik_treeview_item_set_visible ( VikTreeview *vt, GtkTreeIter *iter, gboolean to )
 616 {
 617   g_return_if_fail ( iter != NULL );
 618   gtk_tree_store_set ( GTK_TREE_STORE(vt->model), iter, VISIBLE_COLUMN, to, -1 );
 619 }
 620
 621 void vik_treeview_item_toggle_visible ( VikTreeview *vt, GtkTreeIter *iter )
 622 {
 623   g_return_if_fail ( iter != NULL );
 624   gboolean to;
 625   TREEVIEW_GET ( vt->model, iter, VISIBLE_COLUMN, &to );
 626   to = !to;
 627   gtk_tree_store_set ( GTK_TREE_STORE(vt->model), iter, VISIBLE_COLUMN, to, -1 );
 628 }
 629
 630 void vik_treeview_expand ( VikTreeview *vt, GtkTreeIter *iter )
 631 {
 632   GtkTreePath *path;
 633   path = gtk_tree_model_get_path ( vt->model, iter );
 634   gtk_tree_view_expand_row ( GTK_TREE_VIEW(vt), path, FALSE );
 635   gtk_tree_path_free ( path );
 636 }
 637
 638 void vik_treeview_item_select ( VikTreeview *vt, GtkTreeIter *iter )
 639 {
 640   gtk_tree_selection_select_iter ( gtk_tree_view_get_selection ( GTK_TREE_VIEW ( vt ) ), iter );
 641 }
 642
 643 void vik_treeview_item_unselect ( VikTreeview *vt, GtkTreeIter *iter )
 644 {
 645   gtk_tree_selection_unselect_iter ( gtk_tree_view_get_selection ( GTK_TREE_VIEW ( vt ) ), iter );
 646 }
 647
 648 void vik_treeview_add_layer ( VikTreeview *vt, GtkTreeIter *parent_iter, GtkTreeIter *iter, const gchar *name, gpointer parent, gboolean above,
 649                               gpointer item, gint data, VikLayerTypeEnum layer_type )
 650 {
 651   g_assert ( iter != NULL );
 652   if ( above )
 653     gtk_tree_store_prepend ( GTK_TREE_STORE(vt->model), iter, parent_iter );
 654   else
 655     gtk_tree_store_append ( GTK_TREE_STORE(vt->model), iter, parent_iter );
 656   gtk_tree_store_set ( GTK_TREE_STORE(vt->model), iter, NAME_COLUMN, name, VISIBLE_COLUMN, TRUE,
 657     TYPE_COLUMN, VIK_TREEVIEW_TYPE_LAYER, ITEM_PARENT_COLUMN, parent, ITEM_POINTER_COLUMN, item,
 658     ITEM_DATA_COLUMN, data, HAS_VISIBLE_COLUMN, TRUE, EDITABLE_COLUMN, parent == NULL ? FALSE : TRUE,
 659     ICON_COLUMN, layer_type >= 0 ? vt->layer_type_icons[layer_type] : NULL, -1 );
 660 }
 661
 662 void vik_treeview_insert_layer ( VikTreeview *vt, GtkTreeIter *parent_iter, GtkTreeIter *iter, const gchar *name, gpointer parent, gboolean above,
 663                               gpointer item, gint data, VikLayerTypeEnum layer_type, GtkTreeIter *sibling )
 664 {
 665   g_assert ( iter != NULL );
 666   if (sibling) {
 667     if (above)
 668       gtk_tree_store_insert_before ( GTK_TREE_STORE(vt->model), iter, parent_iter, sibling );
 669     else
 670       gtk_tree_store_insert_after ( GTK_TREE_STORE(vt->model), iter, parent_iter, sibling );
 671   } else {
 672     if (above)
 673       gtk_tree_store_append ( GTK_TREE_STORE(vt->model), iter, parent_iter );
 674     else
 675       gtk_tree_store_prepend ( GTK_TREE_STORE(vt->model), iter, parent_iter );
 676   }
 677
 678   gtk_tree_store_set ( GTK_TREE_STORE(vt->model), iter, NAME_COLUMN, name, VISIBLE_COLUMN, TRUE,
 679     TYPE_COLUMN, VIK_TREEVIEW_TYPE_LAYER, ITEM_PARENT_COLUMN, parent, ITEM_POINTER_COLUMN, item,
 680     ITEM_DATA_COLUMN, data, HAS_VISIBLE_COLUMN, TRUE, EDITABLE_COLUMN, TRUE,
 681     ICON_COLUMN, layer_type >= 0 ? vt->layer_type_icons[layer_type] : NULL, -1 );
 682 }
 683
 684 void vik_treeview_add_sublayer ( VikTreeview *vt, GtkTreeIter *parent_iter, GtkTreeIter *iter, const gchar *name, gpointer parent, gpointer item,
 685                                  gint data, GdkPixbuf *icon, gboolean has_visible, gboolean editable )
 686 {
 687   g_assert ( iter != NULL );
 688
 689   gtk_tree_store_append ( GTK_TREE_STORE(vt->model), iter, parent_iter );
 690   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 );
 691 }
 692
 693 // Inspired by the internals of GtkTreeView sorting itself
 694 typedef struct _SortTuple
 695 {
 696   gint offset;
 697   gchar *name;
 698 } SortTuple;
 699
 700 /**
 701  * If order is true sort ascending, otherwise a descending sort
 702  */
 703 static gint sort_tuple_compare ( gconstpointer a, gconstpointer b, gpointer order )
 704 {
 705   SortTuple *sa = (SortTuple *)a;
 706   SortTuple *sb = (SortTuple *)b;
 707
 708   // Default ascending order
 709   gint answer = g_strcmp0 ( sa->name, sb->name );
 710
 711   if ( !GPOINTER_TO_INT(order) ) {
 712     // Invert sort order for descending order
 713     answer = -answer;
 714   }
 715
 716   return answer;
 717 }
 718
 719 /**
 720  * Note: I don't believe we can sensibility use built in model sort gtk_tree_model_sort_new_with_model() on the name,
 721  * since that would also sort the layers - but that needs to be user controlled for ordering, such as which maps get drawn on top.
 722  *
 723  * vik_treeview_sort_children:
 724  * @vt:     The treeview to operate on
 725  * @parent: The level within the treeview to sort
 726  * @order:  How the items should be sorted
 727  *
 728  * Use the gtk_tree_store_reorder method as it very quick
 729  *
 730  * This ordering can be performed on demand and works for any parent iterator (i.e. both sublayer and layer levels)
 731  *
 732  * It should be called whenever an individual sublayer item is added or renamed (or after a group of sublayer items have been added).
 733  *
 734  * Previously with insertion sort on every sublayer addition: adding 10,000 items would take over 30 seconds!
 735  * Now sorting after simply adding all tracks takes 1 second.
 736  * For a KML file with over 10,000 tracks (3Mb zipped) - See 'UK Hampshire Rights of Way'
 737  * http://www3.hants.gov.uk/row/row-maps.htm
 738  */
 739 void vik_treeview_sort_children ( VikTreeview *vt, GtkTreeIter *parent, vik_layer_sort_order_t order )
 740 {
 741   if ( order == VL_SO_NONE )
 742     // Nothing to do
 743     return;
 744
 745   GtkTreeModel *model = vt->model;
 746   GtkTreeIter child;
 747   if ( !gtk_tree_model_iter_children ( model, &child, parent ) )
 748     return;
 749
 750   guint length = gtk_tree_model_iter_n_children ( model, parent );
 751
 752   // Create an array to store the position offsets
 753   SortTuple *sort_array;
 754   sort_array = g_new ( SortTuple, length );
 755
 756   guint ii = 0;
 757   do {
 758     sort_array[ii].offset = ii;
 759     gtk_tree_model_get ( model, &child, NAME_COLUMN, &(sort_array[ii].name), -1 );
 760     ii++;
 761   } while ( gtk_tree_model_iter_next (model, &child) );
 762
 763   gboolean sort_order = (order == VL_SO_ALPHABETICAL_ASCENDING );
 764
 765   // Sort list...
 766   g_qsort_with_data (sort_array,
 767                      length,
 768                      sizeof (SortTuple),
 769                      sort_tuple_compare,
 770                      GINT_TO_POINTER(sort_order));
 771
 772   // As the sorted list contains the reordered position offsets, extract this and then apply to the treeview
 773   gint *positions = g_malloc ( sizeof(gdouble) * length );
 774   for ( ii = 0; ii < length; ii++ ) {
 775     positions[ii] = sort_array[ii].offset;
 776     g_free ( sort_array[ii].name );
 777   }
 778   g_free ( sort_array );
 779
 780   // This is extremely fast compared to the old alphabetical insertion
 781   gtk_tree_store_reorder ( GTK_TREE_STORE(model), parent, positions );
 782   g_free ( positions );
 783 }
 784
 785 static void vik_treeview_finalize ( GObject *gob )
 786 {
 787   VikTreeview *vt = VIK_TREEVIEW ( gob );
 788   VikLayerTypeEnum i;
 789   for ( i = 0; i < VIK_LAYER_NUM_TYPES; i++ )
 790     if ( vt->layer_type_icons[i] != NULL )
 791       g_object_unref ( G_OBJECT(vt->layer_type_icons[i]) );
 792
 793   G_OBJECT_CLASS(parent_class)->finalize(gob);
 794 }
 795
 796 static gboolean vik_treeview_drag_data_received (GtkTreeDragDest *drag_dest, GtkTreePath *dest, GtkSelectionData *selection_data)
 797 {
 798   GtkTreeModel *tree_model;
 799   GtkTreeModel *src_model = NULL;
 800   GtkTreePath *src_path = NULL, *dest_cp = NULL;
 801   gboolean retval = FALSE;
 802   GtkTreeIter src_iter, root_iter, dest_parent;
 803   VikTreeview *vt;
 804   VikLayer *vl;
 805
 806   g_return_val_if_fail (GTK_IS_TREE_STORE (drag_dest), FALSE);
 807
 808   tree_model = GTK_TREE_MODEL (drag_dest);
 809
 810   if (gtk_tree_get_row_drag_data (selection_data, &src_model, &src_path) && src_model == tree_model) {
 811     /*
 812      * Copy src_path to dest.  There are two subcases here, depending on what
 813      * is being dragged.
 814      *
 815      * 1. src_path is a layer. In this case, interpret the drop
 816      *    as a request to move the layer to a different aggregate layer.
 817      *    If the destination is not an aggregate layer, use the first
 818      *    ancestor that is.
 819      *
 820      * 2. src_path is a sublayer.  In this case, find ancestors of
 821      *    both source and destination nodes who are full layers,
 822      *    and call the move method of that layer type.
 823      *
 824      */
 825     if (!gtk_tree_model_get_iter (src_model, &src_iter, src_path)) {
 826       goto out;
 827     }
 828     if (!gtk_tree_path_compare(src_path, dest)) {
 829       goto out;
 830     }
 831
 832     dest_cp = gtk_tree_path_copy (dest);
 833
 834     gtk_tree_model_get_iter_first(tree_model, &root_iter);
 835     TREEVIEW_GET(tree_model, &root_iter, ITEM_POINTER_COLUMN, &vl);
 836     vt = vl->vt;
 837
 838
 839     if (gtk_tree_path_get_depth(dest_cp)>1) { /* can't be sibling of top layer */
 840       VikLayer *vl_src, *vl_dest;
 841
 842       /* Find the first ancestor that is a full layer, and store in dest_parent. */
 843       do {
 844         gtk_tree_path_up(dest_cp);
 845         gtk_tree_model_get_iter (src_model, &dest_parent, dest_cp);
 846       } while (gtk_tree_path_get_depth(dest_cp)>1 &&
 847                vik_treeview_item_get_type(vt, &dest_parent) != VIK_TREEVIEW_TYPE_LAYER);
 848
 849
 850       g_assert ( vik_treeview_item_get_parent(vt, &src_iter) );
 851       vl_src = vik_treeview_item_get_parent(vt, &src_iter);
 852       vl_dest = vik_treeview_item_get_pointer(vt, &dest_parent);
 853
 854       /* TODO: might want to allow different types, and let the clients handle how they want */
 855       if (vl_src->type == vl_dest->type && vik_layer_get_interface(vl_dest->type)->drag_drop_request) {
 856         //      g_print("moving an item from layer '%s' into layer '%s'\n", vl_src->name, vl_dest->name);
 857         vik_layer_get_interface(vl_dest->type)->drag_drop_request(vl_src, vl_dest, &src_iter, dest);
 858       }
 859     }
 860   }
 861
 862  out:
 863   if (dest_cp)
 864     gtk_tree_path_free(dest_cp);
 865   if (src_path)
 866     gtk_tree_path_free (src_path);
 867
 868   return retval;
 869 }
 870
 871 /*
 872  * This may not be necessary.
 873  */
 874 static gboolean vik_treeview_drag_data_delete ( GtkTreeDragSource *drag_source, GtkTreePath *path )
 875 {
 876   gchar *s_dest = gtk_tree_path_to_string(path);
 877   g_print(_("delete data from %s\n"), s_dest);
 878   g_free(s_dest);
 879   return FALSE;
 880 }