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