[DOC] Fix some incorrect docbook markup.

[andy/viking.git] / src / vikaggregatelayer.c

diff --git a/src/vikaggregatelayer.c b/src/vikaggregatelayer.c
index a5e803b57888e16bfe8992d7f1c9a4cabc4b07ab..d86bd0ec9e8143282ecfd68928c86a13bc2215db 100644 (file)
--- a/src/vikaggregatelayer.c
+++ b/src/vikaggregatelayer.c
@@ -23,6 +23,7 @@
 #include "icons/icons.h"
 
 #include <string.h>
 #include "icons/icons.h"
 
 #include <string.h>

+#include <glib/gi18n.h>

 
 #define DISCONNECT_UPDATE_SIGNAL(vl, val) g_signal_handlers_disconnect_matched(vl, G_SIGNAL_MATCH_DATA, 0, 0, 0, 0, val)
 
 
 #define DISCONNECT_UPDATE_SIGNAL(vl, val) g_signal_handlers_disconnect_matched(vl, G_SIGNAL_MATCH_DATA, 0, 0, 0, 0, val)
 


@@ -31,8 +32,12 @@ static VikAggregateLayer *aggregate_layer_unmarshall( guint8 *data, gint len, Vi
 static void aggregate_layer_change_coord_mode ( VikAggregateLayer *val, VikCoordMode mode );
 static void aggregate_layer_drag_drop_request ( VikAggregateLayer *val_src, VikAggregateLayer *val_dest, GtkTreeIter *src_item_iter, GtkTreePath *dest_path );
 
 static void aggregate_layer_change_coord_mode ( VikAggregateLayer *val, VikCoordMode mode );
 static void aggregate_layer_drag_drop_request ( VikAggregateLayer *val_src, VikAggregateLayer *val_dest, GtkTreeIter *src_item_iter, GtkTreePath *dest_path );
 

+static void aggregate_layer_add_menu_items ( VikAggregateLayer *val, GtkMenu *menu, gpointer vlp );
+

 VikLayerInterface vik_aggregate_layer_interface = {
   "Aggregate",
 VikLayerInterface vik_aggregate_layer_interface = {
   "Aggregate",

+  N_("Aggregate"),
+  "<control><shift>A",

   &vikaggregatelayer_pixbuf,
 
   NULL,
   &vikaggregatelayer_pixbuf,
 
   NULL,


@@ -57,7 +62,7 @@ VikLayerInterface vik_aggregate_layer_interface = {
   (VikLayerFuncSetMenuItemsSelection)  NULL,
   (VikLayerFuncGetMenuItemsSelection)  NULL,
 
   (VikLayerFuncSetMenuItemsSelection)  NULL,
   (VikLayerFuncGetMenuItemsSelection)  NULL,
 

-  (VikLayerFuncAddMenuItems)            NULL,
+  (VikLayerFuncAddMenuItems)            aggregate_layer_add_menu_items,

   (VikLayerFuncSublayerAddMenuItems)    NULL,
 
   (VikLayerFuncSublayerRenameRequest)   NULL,
   (VikLayerFuncSublayerAddMenuItems)    NULL,
 
   (VikLayerFuncSublayerRenameRequest)   NULL,


@@ -187,7 +192,7 @@ static VikAggregateLayer *aggregate_layer_unmarshall( guint8 *data, gint len, Vi
 VikAggregateLayer *vik_aggregate_layer_new ()
 {
   VikAggregateLayer *val = VIK_AGGREGATE_LAYER ( g_object_new ( VIK_AGGREGATE_LAYER_TYPE, NULL ) );
 VikAggregateLayer *vik_aggregate_layer_new ()
 {
   VikAggregateLayer *val = VIK_AGGREGATE_LAYER ( g_object_new ( VIK_AGGREGATE_LAYER_TYPE, NULL ) );

-  vik_layer_init ( VIK_LAYER(val), VIK_LAYER_AGGREGATE );
+  vik_layer_set_type ( VIK_LAYER(val), VIK_LAYER_AGGREGATE );

   val->children = NULL;
   return val;
 }
   val->children = NULL;
   return val;
 }


@@ -197,9 +202,16 @@ void vik_aggregate_layer_insert_layer ( VikAggregateLayer *val, VikLayer *l, Gtk
   GtkTreeIter iter;
   VikLayer *vl = VIK_LAYER(val);
 
   GtkTreeIter iter;
   VikLayer *vl = VIK_LAYER(val);
 

+  // By default layers are inserted above the selected layer
+  gboolean put_above = TRUE;
+
+  // These types are 'base' types in that you what other information on top
+  if ( l->type == VIK_LAYER_MAPS || l->type == VIK_LAYER_DEM || l->type == VIK_LAYER_GEOREF )
+    put_above = FALSE;
+

   if ( vl->realized )
   {
   if ( vl->realized )
   {

-    vik_treeview_insert_layer ( vl->vt, &(vl->iter), &iter, l->name, val, l, l->type, l->type, replace_iter );
+    vik_treeview_insert_layer ( vl->vt, &(vl->iter), &iter, l->name, val, put_above, l, l->type, l->type, replace_iter );

     if ( ! l->visible )
       vik_treeview_item_set_visible ( vl->vt, &iter, FALSE );
     vik_layer_realize ( l, vl->vt, &iter );
     if ( ! l->visible )
       vik_treeview_item_set_visible ( vl->vt, &iter, FALSE );
     vik_layer_realize ( l, vl->vt, &iter );


@@ -210,7 +222,11 @@ void vik_aggregate_layer_insert_layer ( VikAggregateLayer *val, VikLayer *l, Gtk
 
   if (replace_iter) {
     GList *theone = g_list_find ( val->children, vik_treeview_item_get_pointer ( vl->vt, replace_iter ) );
 
   if (replace_iter) {
     GList *theone = g_list_find ( val->children, vik_treeview_item_get_pointer ( vl->vt, replace_iter ) );

-    val->children = g_list_insert ( val->children, l, g_list_position(val->children,theone)+1 );
+    if ( put_above )
+      val->children = g_list_insert ( val->children, l, g_list_position(val->children,theone)+1 );
+    else
+      // Thus insert 'here' (so don't add 1)
+      val->children = g_list_insert ( val->children, l, g_list_position(val->children,theone) );

   } else {
     // Effectively insert at 'end' of the list to match how displayed in the treeview
     //  - but since it is drawn from 'bottom first' it is actually the first in the child list
   } else {
     // Effectively insert at 'end' of the list to match how displayed in the treeview
     //  - but since it is drawn from 'bottom first' it is actually the first in the child list


@@ -222,14 +238,28 @@ void vik_aggregate_layer_insert_layer ( VikAggregateLayer *val, VikLayer *l, Gtk
   g_signal_connect_swapped ( G_OBJECT(l), "update", G_CALLBACK(vik_layer_emit_update_secondary), val );
 }
 
   g_signal_connect_swapped ( G_OBJECT(l), "update", G_CALLBACK(vik_layer_emit_update_secondary), val );
 }
 

-void vik_aggregate_layer_add_layer ( VikAggregateLayer *val, VikLayer *l )
+/**
+ * vik_aggregate_layer_add_layer:
+ * @allow_reordering: should be set for GUI interactions,
+ *                    whereas loading from a file needs strict ordering and so should be FALSE
+ */
+void vik_aggregate_layer_add_layer ( VikAggregateLayer *val, VikLayer *l, gboolean allow_reordering )

 {
   GtkTreeIter iter;
   VikLayer *vl = VIK_LAYER(val);
 
 {
   GtkTreeIter iter;
   VikLayer *vl = VIK_LAYER(val);
 

+  // By default layers go to the top
+  gboolean put_above = TRUE;
+
+  if ( allow_reordering ) {
+    // These types are 'base' types in that you what other information on top
+    if ( l->type == VIK_LAYER_MAPS || l->type == VIK_LAYER_DEM || l->type == VIK_LAYER_GEOREF )
+      put_above = FALSE;
+  }
+

   if ( vl->realized )
   {
   if ( vl->realized )
   {

-    vik_treeview_add_layer ( vl->vt, &(vl->iter), &iter, l->name, val, l, l->type, l->type);
+    vik_treeview_add_layer ( vl->vt, &(vl->iter), &iter, l->name, val, put_above, l, l->type, l->type);

     if ( ! l->visible )
       vik_treeview_item_set_visible ( vl->vt, &iter, FALSE );
     vik_layer_realize ( l, vl->vt, &iter );
     if ( ! l->visible )
       vik_treeview_item_set_visible ( vl->vt, &iter, FALSE );
     vik_layer_realize ( l, vl->vt, &iter );


@@ -238,7 +268,11 @@ void vik_aggregate_layer_add_layer ( VikAggregateLayer *val, VikLayer *l )
       vik_treeview_expand ( vl->vt, &(vl->iter) );
   }
 
       vik_treeview_expand ( vl->vt, &(vl->iter) );
   }
 

-  val->children = g_list_append ( val->children, l );
+  if ( put_above )
+    val->children = g_list_append ( val->children, l );
+  else
+    val->children = g_list_prepend ( val->children, l );
+

   g_signal_connect_swapped ( G_OBJECT(l), "update", G_CALLBACK(vik_layer_emit_update_secondary), val );
 }
 
   g_signal_connect_swapped ( G_OBJECT(l), "update", G_CALLBACK(vik_layer_emit_update_secondary), val );
 }
 


@@ -291,24 +325,23 @@ void vik_aggregate_layer_move_layer ( VikAggregateLayer *val, GtkTreeIter *child
  * of the pixmap before drawing the trigger layer so we can use it again
  * later.
  */
  * of the pixmap before drawing the trigger layer so we can use it again
  * later.
  */

-void vik_aggregate_layer_draw ( VikAggregateLayer *val, gpointer data )
+void vik_aggregate_layer_draw ( VikAggregateLayer *val, VikViewport *vp )

 {
   GList *iter = val->children;
   VikLayer *vl;
 {
   GList *iter = val->children;
   VikLayer *vl;

-  VikViewport *viewport = VIK_VIEWPORT(data);
-  VikLayer *trigger = VIK_LAYER(vik_viewport_get_trigger( viewport ));
+  VikLayer *trigger = VIK_LAYER(vik_viewport_get_trigger( vp ));

   while ( iter ) {
     vl = VIK_LAYER(iter->data);
     if ( vl == trigger ) {
   while ( iter ) {
     vl = VIK_LAYER(iter->data);
     if ( vl == trigger ) {

-      if ( vik_viewport_get_half_drawn ( viewport ) ) {
-        vik_viewport_set_half_drawn ( viewport, FALSE );
-        vik_viewport_snapshot_load( viewport );
+      if ( vik_viewport_get_half_drawn ( vp ) ) {
+        vik_viewport_set_half_drawn ( vp, FALSE );
+        vik_viewport_snapshot_load( vp );

       } else {
       } else {

-        vik_viewport_snapshot_save( viewport );
+        vik_viewport_snapshot_save( vp );

       }
     }
       }
     }

-    if ( vl->type == VIK_LAYER_AGGREGATE || vl->type == VIK_LAYER_GPS || ! vik_viewport_get_half_drawn( viewport ) )
-      vik_layer_draw ( vl, data );
+    if ( vl->type == VIK_LAYER_AGGREGATE || vl->type == VIK_LAYER_GPS || ! vik_viewport_get_half_drawn( vp ) )
+      vik_layer_draw ( vl, vp );

     iter = iter->next;
   }
 }
     iter = iter->next;
   }
 }


@@ -323,6 +356,146 @@ static void aggregate_layer_change_coord_mode ( VikAggregateLayer *val, VikCoord
   }
 }
 
   }
 }
 

+static void aggregate_layer_child_visibile_toggle ( gpointer data[2] )
+{
+  // Convert data back to correct types
+  VikAggregateLayer *val = VIK_AGGREGATE_LAYER ( data[0] );
+  VikLayersPanel *vlp = VIK_LAYERS_PANEL ( data[1] );
+  VikLayer *vl;
+
+  // Loop around all (child) layers applying visibility setting
+  // This does not descend the tree if there are aggregates within aggregrate - just the first level of layers held
+  GList *iter = val->children;
+  while ( iter ) {
+    vl = VIK_LAYER ( iter->data );
+    vl->visible = !vl->visible;
+    // Also set checkbox on/off
+    vik_treeview_item_toggle_visible ( vik_layers_panel_get_treeview ( vlp ), &(vl->iter) );
+    iter = iter->next;
+  }
+  // Redraw as view may have changed
+  vik_layer_emit_update ( VIK_LAYER ( val ) );
+}
+
+static void aggregate_layer_child_visibile ( gpointer data[2], gboolean on_off)
+{
+  // Convert data back to correct types
+  VikAggregateLayer *val = VIK_AGGREGATE_LAYER ( data[0] );
+  VikLayersPanel *vlp = VIK_LAYERS_PANEL ( data[1] );
+  VikLayer *vl;
+
+  // Loop around all (child) layers applying visibility setting
+  // This does not descend the tree if there are aggregates within aggregrate - just the first level of layers held
+  GList *iter = val->children;
+  while ( iter ) {
+    vl = VIK_LAYER ( iter->data );
+    vl->visible = on_off;
+    // Also set checkbox on_off
+    vik_treeview_item_set_visible ( vik_layers_panel_get_treeview ( vlp ), &(vl->iter), on_off );
+    iter = iter->next;
+  }
+  // Redraw as view may have changed
+  vik_layer_emit_update ( VIK_LAYER ( val ) );
+}
+
+static void aggregate_layer_child_visibile_on ( gpointer data[2] )
+{
+  aggregate_layer_child_visibile ( data, TRUE );
+}
+
+static void aggregate_layer_child_visibile_off ( gpointer data[2] )
+{
+  aggregate_layer_child_visibile ( data, FALSE );
+}
+
+/**
+ * If order is true sort ascending, otherwise a descending sort
+ */
+static gint sort_layer_compare ( gconstpointer a, gconstpointer b, gpointer order )
+{
+  VikLayer *sa = (VikLayer *)a;
+  VikLayer *sb = (VikLayer *)b;
+
+  // Default ascending order
+  gint answer = g_strcmp0 ( sa->name, sb->name );
+
+  if ( GPOINTER_TO_INT(order) ) {
+    // Invert sort order for ascending order
+    answer = -answer;
+  }
+
+  return answer;
+}
+
+static void aggregate_layer_sort_a2z ( gpointer lav[2] )
+{
+  VikAggregateLayer *val = VIK_AGGREGATE_LAYER(lav[0]);
+  vik_treeview_sort_children ( VIK_LAYER(val)->vt, &(VIK_LAYER(val)->iter), VL_SO_ALPHABETICAL_ASCENDING );
+  val->children = g_list_sort_with_data ( val->children, sort_layer_compare, GINT_TO_POINTER(TRUE) );
+}
+
+static void aggregate_layer_sort_z2a ( gpointer lav[2] )
+{
+  VikAggregateLayer *val = VIK_AGGREGATE_LAYER(lav[0]);
+  vik_treeview_sort_children ( VIK_LAYER(val)->vt, &(VIK_LAYER(val)->iter), VL_SO_ALPHABETICAL_DESCENDING );
+  val->children = g_list_sort_with_data ( val->children, sort_layer_compare, GINT_TO_POINTER(FALSE) );
+}
+
+static void aggregate_layer_add_menu_items ( VikAggregateLayer *val, GtkMenu *menu, gpointer vlp )
+{
+  // Data to pass on in menu functions
+  static gpointer data[2];
+  data[0] = val;
+  data[1] = vlp;
+
+  GtkWidget *item = gtk_menu_item_new();
+  gtk_menu_shell_append ( GTK_MENU_SHELL(menu), item );
+  gtk_widget_show ( item );
+
+  GtkWidget *vis_submenu = gtk_menu_new ();
+  item = gtk_menu_item_new_with_mnemonic ( _("_Visibility") );
+  gtk_menu_shell_append (GTK_MENU_SHELL (menu), item);
+  gtk_widget_show ( item );
+  gtk_menu_item_set_submenu (GTK_MENU_ITEM (item), vis_submenu );
+
+  item = gtk_image_menu_item_new_with_mnemonic ( _("_Show All") );
+  gtk_image_menu_item_set_image ( (GtkImageMenuItem*)item, gtk_image_new_from_stock (GTK_STOCK_APPLY, GTK_ICON_SIZE_MENU) );
+  g_signal_connect_swapped ( G_OBJECT(item), "activate", G_CALLBACK(aggregate_layer_child_visibile_on), data );
+  gtk_menu_shell_append (GTK_MENU_SHELL (vis_submenu), item);
+  gtk_widget_show ( item );
+
+  item = gtk_image_menu_item_new_with_mnemonic ( _("_Hide All") );
+  gtk_image_menu_item_set_image ( (GtkImageMenuItem*)item, gtk_image_new_from_stock (GTK_STOCK_CLEAR, GTK_ICON_SIZE_MENU) );
+  g_signal_connect_swapped ( G_OBJECT(item), "activate", G_CALLBACK(aggregate_layer_child_visibile_off), data );
+  gtk_menu_shell_append (GTK_MENU_SHELL (vis_submenu), item);
+  gtk_widget_show ( item );
+
+  item = gtk_image_menu_item_new_with_mnemonic ( _("_Toggle") );
+  gtk_image_menu_item_set_image ( (GtkImageMenuItem*)item, gtk_image_new_from_stock (GTK_STOCK_REFRESH, GTK_ICON_SIZE_MENU) );
+  g_signal_connect_swapped ( G_OBJECT(item), "activate", G_CALLBACK(aggregate_layer_child_visibile_toggle), data );
+  gtk_menu_shell_append (GTK_MENU_SHELL (vis_submenu), item);
+  gtk_widget_show ( item );
+
+  GtkWidget *submenu_sort = gtk_menu_new ();
+  item = gtk_image_menu_item_new_with_mnemonic ( _("_Sort") );
+  gtk_image_menu_item_set_image ( (GtkImageMenuItem*)item, gtk_image_new_from_stock (GTK_STOCK_REFRESH, GTK_ICON_SIZE_MENU) );
+  gtk_menu_shell_append (GTK_MENU_SHELL (menu), item);
+  gtk_widget_show ( item );
+  gtk_menu_item_set_submenu (GTK_MENU_ITEM (item), submenu_sort );
+
+  item = gtk_image_menu_item_new_with_mnemonic ( _("Name _Ascending") );
+  gtk_image_menu_item_set_image ( (GtkImageMenuItem*)item, gtk_image_new_from_stock (GTK_STOCK_SORT_ASCENDING, GTK_ICON_SIZE_MENU) );
+  g_signal_connect_swapped ( G_OBJECT(item), "activate", G_CALLBACK(aggregate_layer_sort_a2z), data );
+  gtk_menu_shell_append ( GTK_MENU_SHELL(submenu_sort), item );
+  gtk_widget_show ( item );
+
+  item = gtk_image_menu_item_new_with_mnemonic ( _("Name _Descending") );
+  gtk_image_menu_item_set_image ( (GtkImageMenuItem*)item, gtk_image_new_from_stock (GTK_STOCK_SORT_DESCENDING, GTK_ICON_SIZE_MENU) );
+  g_signal_connect_swapped ( G_OBJECT(item), "activate", G_CALLBACK(aggregate_layer_sort_z2a), data );
+  gtk_menu_shell_append ( GTK_MENU_SHELL(submenu_sort), item );
+  gtk_widget_show ( item );
+}
+

 static void disconnect_layer_signal ( VikLayer *vl, VikAggregateLayer *val )
 {
   g_assert(DISCONNECT_UPDATE_SIGNAL(vl,val)==1);
 static void disconnect_layer_signal ( VikLayer *vl, VikAggregateLayer *val )
 {
   g_assert(DISCONNECT_UPDATE_SIGNAL(vl,val)==1);


@@ -365,7 +538,7 @@ gboolean vik_aggregate_layer_delete ( VikAggregateLayer *val, GtkTreeIter *iter
 
 #if 0
 /* returns 0 == we're good, 1 == didn't find any layers, 2 == got rejected */
 
 #if 0
 /* returns 0 == we're good, 1 == didn't find any layers, 2 == got rejected */

-guint vik_aggregate_layer_tool ( VikAggregateLayer *val, guint16 layer_type, VikToolInterfaceFunc tool_func, GdkEventButton *event, VikViewport *vvp )
+guint vik_aggregate_layer_tool ( VikAggregateLayer *val, VikLayerTypeEnum layer_type, VikToolInterfaceFunc tool_func, GdkEventButton *event, VikViewport *vvp )

 {
   GList *iter = val->children;
   gboolean found_rej = FALSE;
 {
   GList *iter = val->children;
   gboolean found_rej = FALSE;


@@ -400,7 +573,7 @@ guint vik_aggregate_layer_tool ( VikAggregateLayer *val, guint16 layer_type, Vik
 }
 #endif 
 
 }
 #endif 
 

-VikLayer *vik_aggregate_layer_get_top_visible_layer_of_type ( VikAggregateLayer *val, gint type )
+VikLayer *vik_aggregate_layer_get_top_visible_layer_of_type ( VikAggregateLayer *val, VikLayerTypeEnum type )

 {
   VikLayer *rv;
   GList *ls = val->children;
 {
   VikLayer *rv;
   GList *ls = val->children;


@@ -425,7 +598,7 @@ VikLayer *vik_aggregate_layer_get_top_visible_layer_of_type ( VikAggregateLayer
   return NULL;
 }
 
   return NULL;
 }
 

-GList *vik_aggregate_layer_get_all_layers_of_type(VikAggregateLayer *val, GList *layers, gint type, gboolean include_invisible)
+GList *vik_aggregate_layer_get_all_layers_of_type(VikAggregateLayer *val, GList *layers, VikLayerTypeEnum type, gboolean include_invisible)

 {
   GList *l = layers;
   GList *children = val->children;
 {
   GList *l = layers;
   GList *children = val->children;


@@ -439,11 +612,11 @@ GList *vik_aggregate_layer_get_all_layers_of_type(VikAggregateLayer *val, GList
     if (vl->type == VIK_LAYER_AGGREGATE ) {
       // Don't even consider invisible aggregrates, unless told to
       if (vl->visible || include_invisible)
     if (vl->type == VIK_LAYER_AGGREGATE ) {
       // Don't even consider invisible aggregrates, unless told to
       if (vl->visible || include_invisible)

-       l = vik_aggregate_layer_get_all_layers_of_type(VIK_AGGREGATE_LAYER(children->data), l, type, include_invisible);
+        l = vik_aggregate_layer_get_all_layers_of_type(VIK_AGGREGATE_LAYER(children->data), l, type, include_invisible);

     }
     else if (vl->type == type) {
       if (vl->visible || include_invisible)
     }
     else if (vl->type == type) {
       if (vl->visible || include_invisible)

-       l = g_list_prepend(l, children->data); /* now in top down order */
+        l = g_list_prepend(l, children->data); /* now in top down order */

     }
     else if (type == VIK_LAYER_TRW) {
       /* GPS layers contain TRW layers. cf with usage in file.c */
     }
     else if (type == VIK_LAYER_TRW) {
       /* GPS layers contain TRW layers. cf with usage in file.c */


@@ -481,7 +654,7 @@ void vik_aggregate_layer_realize ( VikAggregateLayer *val, VikTreeview *vt, GtkT
   while ( i )
   {
     vli = VIK_LAYER(i->data);
   while ( i )
   {
     vli = VIK_LAYER(i->data);

-    vik_treeview_add_layer ( vl->vt, layer_iter, &iter, vli->name, val, 
+    vik_treeview_add_layer ( vl->vt, layer_iter, &iter, vli->name, val, TRUE,

         vli, vli->type, vli->type );
     if ( ! vli->visible )
       vik_treeview_item_set_visible ( vl->vt, &iter, FALSE );
         vli, vli->type, vli->type );
     if ( ! vli->visible )
       vik_treeview_item_set_visible ( vl->vt, &iter, FALSE );