Rename GtkSidebar to GtkStackSidebar

GtkSidebar is too generic and doesn't fully convey what the widget does.

https://bugzilla.gnome.org/show_bug.cgi?id=744094

1 files changed, 0 insertions, 532 deletions

diff --git a/gtk/gtksidebar.c b/gtk/gtksidebar.c
deleted file mode 100644
index 39c332150a..0000000000
--- a/gtk/gtksidebar.c
+++ /dev/null
@@ -1,532 +0,0 @@
-/*
- * Copyright (c) 2014 Intel Corporation
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU Lesser General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or (at your
- * option) any later version.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
- * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
- * License for more details.
- *
- * You should have received a copy of the GNU Lesser General Public License
- * along with this program; if not, write to the Free Software Foundation,
- * Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
- *
- * Author:
- *      Ikey Doherty <michael.i.doherty@intel.com>
- */
-
-#include "config.h"
-
-#include "gtksidebar.h"
-
-#include "gtklabel.h"
-#include "gtklistbox.h"
-#include "gtkscrolledwindow.h"
-#include "gtkseparator.h"
-#include "gtkstylecontext.h"
-#include "gtkprivate.h"
-#include "gtkintl.h"
-
-/**
- * SECTION:gtksidebar
- * @Title: GtkSidebar
- * @Short_description: An automatic sidebar widget
- *
- * A GtkSidebar enables you to quickly and easily provide a consistent
- * "sidebar" object for your user interface.
- *
- * In order to use a GtkSidebar, you simply use a GtkStack to organize
- * your UI flow, and add the sidebar to your sidebar area. You can use
- * gtk_sidebar_set_stack() to connect the #GtkSidebar to the #GtkStack.
- *
- * Since: 3.16
- */
- 
-struct _GtkSidebarPrivate
-{
-  GtkListBox *list;
-  GtkStack *stack;
-  GHashTable *rows;
-  gboolean in_child_changed;
-};
-
-G_DEFINE_TYPE_WITH_PRIVATE (GtkSidebar, gtk_sidebar, GTK_TYPE_BIN)
-
-enum
-{
-  PROP_0,
-  PROP_STACK,
-  N_PROPERTIES
-};
-static GParamSpec *obj_properties[N_PROPERTIES] = { NULL, };
-
-static void
-gtk_sidebar_set_property (GObject    *object,
-                          guint       prop_id,
-                          const       GValue *value,
-                          GParamSpec *pspec)
-{
-  switch (prop_id)
-    {
-    case PROP_STACK:
-      gtk_sidebar_set_stack (GTK_SIDEBAR (object), g_value_get_object (value));
-      break;
-
-    default:
-      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
-      break;
-    }
-}
-
-static void
-gtk_sidebar_get_property (GObject    *object,
-                          guint       prop_id,
-                          GValue     *value,
-                          GParamSpec *pspec)
-{
-  GtkSidebarPrivate *priv = gtk_sidebar_get_instance_private (GTK_SIDEBAR (object));
-
-  switch (prop_id)
-    {
-    case PROP_STACK:
-      g_value_set_object (value, priv->stack);
-      break;
-
-    default:
-      G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
-      break;
-    }
-}
-
-static void
-update_header (GtkListBoxRow *row,
-               GtkListBoxRow *before,
-               gpointer       userdata)
-{
-  GtkWidget *ret = NULL;
-
-  if (before && !gtk_list_box_row_get_header (row))
-    {
-      ret = gtk_separator_new (GTK_ORIENTATION_HORIZONTAL);
-      gtk_list_box_row_set_header (row, ret);
-    }
-}
-
-static gint
-sort_list (GtkListBoxRow *row1,
-           GtkListBoxRow *row2,
-           gpointer       userdata)
-{
-  GtkSidebar *sidebar = GTK_SIDEBAR (userdata);
-  GtkSidebarPrivate *priv = gtk_sidebar_get_instance_private (sidebar);
-  GtkWidget *item;
-  GtkWidget *widget;
-  gint left = 0; gint right = 0;
-
-
-  if (row1)
-    {
-      item = gtk_bin_get_child (GTK_BIN (row1));
-      widget = g_object_get_data (G_OBJECT (item), "stack-child");
-      gtk_container_child_get (GTK_CONTAINER (priv->stack), widget,
-                               "position", &left,
-                               NULL);
-    }
-
-  if (row2)
-    {
-      item = gtk_bin_get_child (GTK_BIN (row2));
-      widget = g_object_get_data (G_OBJECT (item), "stack-child");
-      gtk_container_child_get (GTK_CONTAINER (priv->stack), widget,
-                               "position", &right,
-                               NULL);
-    }
-
-  if (left < right)
-    return  -1;
-
-  if (left == right)
-    return 0;
-
-  return 1;
-}
-
-static void
-gtk_sidebar_row_selected (GtkListBox    *box,
-                          GtkListBoxRow *row,
-                          gpointer       userdata)
-{
-  GtkSidebar *sidebar = GTK_SIDEBAR (userdata);
-  GtkSidebarPrivate *priv = gtk_sidebar_get_instance_private (sidebar);
-  GtkWidget *item;
-  GtkWidget *widget;
-
-  if (priv->in_child_changed)
-    return;
-
-  if (!row)
-    return;
-
-  item = gtk_bin_get_child (GTK_BIN (row));
-  widget = g_object_get_data (G_OBJECT (item), "stack-child");
-  gtk_stack_set_visible_child (priv->stack, widget);
-}
-
-static void
-gtk_sidebar_init (GtkSidebar *sidebar)
-{
-  GtkStyleContext *style;
-  GtkSidebarPrivate *priv;
-  GtkWidget *sw;
-
-  priv = gtk_sidebar_get_instance_private (sidebar);
-
-  sw = gtk_scrolled_window_new (NULL, NULL);
-  gtk_widget_show (sw);
-  gtk_widget_set_no_show_all (sw, TRUE);
-  gtk_scrolled_window_set_policy (GTK_SCROLLED_WINDOW (sw),
-                                  GTK_POLICY_NEVER,
-                                  GTK_POLICY_AUTOMATIC);
-
-  gtk_container_add (GTK_CONTAINER (sidebar), sw);
-
-  priv->list = GTK_LIST_BOX (gtk_list_box_new ());
-  gtk_widget_show (GTK_WIDGET (priv->list));
-
-  gtk_container_add (GTK_CONTAINER (sw), GTK_WIDGET (priv->list));
-
-  gtk_list_box_set_header_func (priv->list, update_header, sidebar, NULL);
-  gtk_list_box_set_sort_func (priv->list, sort_list, sidebar, NULL);
-
-  g_signal_connect (priv->list, "row-selected",
-                    G_CALLBACK (gtk_sidebar_row_selected), sidebar);
-
-  style = gtk_widget_get_style_context (GTK_WIDGET (sidebar));
-  gtk_style_context_add_class (style, "sidebar");
-
-  priv->rows = g_hash_table_new (NULL, NULL);
-}
-
-static void
-update_row (GtkSidebar *sidebar,
-            GtkWidget  *widget,
-            GtkWidget  *row)
-{
-  GtkSidebarPrivate *priv = gtk_sidebar_get_instance_private (sidebar);
-  GtkWidget *item;
-  gchar *title;
-  gboolean needs_attention;
-  GtkStyleContext *context;
-
-  gtk_container_child_get (GTK_CONTAINER (priv->stack), widget,
-                           "title", &title,
-                           "needs-attention", &needs_attention,
-                           NULL);
-
-  item = gtk_bin_get_child (GTK_BIN (row));
-  gtk_label_set_text (GTK_LABEL (item), title);
-
-  gtk_widget_set_visible (row, gtk_widget_get_visible (widget) && title != NULL);
-
-  context = gtk_widget_get_style_context (row);
-  if (needs_attention)
-     gtk_style_context_add_class (context, GTK_STYLE_CLASS_NEEDS_ATTENTION);
-  else
-    gtk_style_context_remove_class (context, GTK_STYLE_CLASS_NEEDS_ATTENTION);
-
-  g_free (title);
-}
-
-static void
-on_position_updated (GtkWidget  *widget,
-                     GParamSpec *pspec,
-                     GtkSidebar *sidebar)
-{
-  GtkSidebarPrivate *priv = gtk_sidebar_get_instance_private (sidebar);
-
-  gtk_list_box_invalidate_sort (priv->list);
-}
-
-static void
-on_child_updated (GtkWidget  *widget,
-                  GParamSpec *pspec,
-                  GtkSidebar *sidebar)
-{
-  GtkSidebarPrivate *priv = gtk_sidebar_get_instance_private (sidebar);
-  GtkWidget *row;
-
-  row = g_hash_table_lookup (priv->rows, widget);
-  update_row (sidebar, widget, row);
-}
-
-static void
-add_child (GtkWidget  *widget,
-           GtkSidebar *sidebar)
-{
-  GtkSidebarPrivate *priv = gtk_sidebar_get_instance_private (sidebar);
-  GtkStyleContext *style;
-  GtkWidget *item;
-  GtkWidget *row;
-
-  /* Check we don't actually already know about this widget */
-  if (g_hash_table_lookup (priv->rows, widget))
-    return;
-
-  /* Make a pretty item when we add kids */
-  item = gtk_label_new ("");
-  gtk_widget_set_halign (item, GTK_ALIGN_START);
-  gtk_widget_set_valign (item, GTK_ALIGN_CENTER);
-  row = gtk_list_box_row_new ();
-  gtk_container_add (GTK_CONTAINER (row), item);
-  gtk_widget_show (item);
-
-  update_row (sidebar, widget, row);
-
-  /* Fix up styling */
-  style = gtk_widget_get_style_context (row);
-  gtk_style_context_add_class (style, "sidebar-item");
-
-  /* Hook up for events */
-  g_signal_connect (widget, "child-notify::title",
-                    G_CALLBACK (on_child_updated), sidebar);
-  g_signal_connect (widget, "child-notify::needs-attention",
-                    G_CALLBACK (on_child_updated), sidebar);
-  g_signal_connect (widget, "notify::visible",
-                    G_CALLBACK (on_child_updated), sidebar);
-  g_signal_connect (widget, "child-notify::position",
-                    G_CALLBACK (on_position_updated), sidebar);
-
-  g_object_set_data (G_OBJECT (item), "stack-child", widget);
-  g_hash_table_insert (priv->rows, widget, row);
-  gtk_container_add (GTK_CONTAINER (priv->list), row);
-}
-
-static void
-remove_child (GtkWidget  *widget,
-              GtkSidebar *sidebar)
-{
-  GtkSidebarPrivate *priv = gtk_sidebar_get_instance_private (sidebar);
-  GtkWidget *row;
-
-  row = g_hash_table_lookup (priv->rows, widget);
-  if (!row)
-    return;
-
-  g_signal_handlers_disconnect_by_func (widget, on_child_updated, sidebar);
-  g_signal_handlers_disconnect_by_func (widget, on_position_updated, sidebar);
-
-  gtk_container_remove (GTK_CONTAINER (priv->list), row);
-  g_hash_table_remove (priv->rows, widget);
-}
-
-static void
-populate_sidebar (GtkSidebar *sidebar)
-{
-  GtkSidebarPrivate *priv = gtk_sidebar_get_instance_private (sidebar);
-  GtkWidget *widget, *row;
-
-  gtk_container_foreach (GTK_CONTAINER (priv->stack), (GtkCallback)add_child, sidebar);
-
-  widget = gtk_stack_get_visible_child (priv->stack);
-  if (widget)
-    {
-      row = g_hash_table_lookup (priv->rows, widget);
-      gtk_list_box_select_row (priv->list, GTK_LIST_BOX_ROW (row));
-    }
-}
-
-static void
-clear_sidebar (GtkSidebar *sidebar)
-{
-  GtkSidebarPrivate *priv = gtk_sidebar_get_instance_private (sidebar);
-
-  gtk_container_foreach (GTK_CONTAINER (priv->stack), (GtkCallback)remove_child, sidebar);
-}
-
-static void
-on_child_changed (GtkWidget  *widget,
-                  GParamSpec *pspec,
-                  GtkSidebar *sidebar)
-{
-  GtkSidebarPrivate *priv = gtk_sidebar_get_instance_private (sidebar);
-  GtkWidget *child;
-  GtkWidget *row;
-
-  child = gtk_stack_get_visible_child (GTK_STACK (widget));
-  row = g_hash_table_lookup (priv->rows, child);
-  if (row != NULL)
-    {
-      priv->in_child_changed = TRUE;
-      gtk_list_box_select_row (priv->list, GTK_LIST_BOX_ROW (row));
-      priv->in_child_changed = FALSE;
-    }
-}
-
-static void
-on_stack_child_added (GtkContainer *container,
-                      GtkWidget    *widget,
-                      GtkSidebar   *sidebar)
-{
-  add_child (widget, sidebar);
-}
-
-static void
-on_stack_child_removed (GtkContainer *container,
-                        GtkWidget    *widget,
-                        GtkSidebar   *sidebar)
-{
-  remove_child (widget, sidebar);
-}
-
-static void
-disconnect_stack_signals (GtkSidebar *sidebar)
-{
-  GtkSidebarPrivate *priv = gtk_sidebar_get_instance_private (sidebar);
-
-  g_signal_handlers_disconnect_by_func (priv->stack, on_stack_child_added, sidebar);
-  g_signal_handlers_disconnect_by_func (priv->stack, on_stack_child_removed, sidebar);
-  g_signal_handlers_disconnect_by_func (priv->stack, on_child_changed, sidebar);
-  g_signal_handlers_disconnect_by_func (priv->stack, disconnect_stack_signals, sidebar);
-}
-
-static void
-connect_stack_signals (GtkSidebar *sidebar)
-{
-  GtkSidebarPrivate *priv = gtk_sidebar_get_instance_private (sidebar);
-
-  g_signal_connect_after (priv->stack, "add",
-                          G_CALLBACK (on_stack_child_added), sidebar);
-  g_signal_connect_after (priv->stack, "remove",
-                          G_CALLBACK (on_stack_child_removed), sidebar);
-  g_signal_connect (priv->stack, "notify::visible-child",
-                    G_CALLBACK (on_child_changed), sidebar);
-  g_signal_connect_swapped (priv->stack, "destroy",
-                            G_CALLBACK (disconnect_stack_signals), sidebar);
-}
-
-static void
-gtk_sidebar_dispose (GObject *object)
-{
-  GtkSidebar *sidebar = GTK_SIDEBAR (object);
-
-  gtk_sidebar_set_stack (sidebar, NULL);
-
-  G_OBJECT_CLASS (gtk_sidebar_parent_class)->dispose (object);
-}
-
-static void
-gtk_sidebar_finalize (GObject *object)
-{
-  GtkSidebar *sidebar = GTK_SIDEBAR (object);
-  GtkSidebarPrivate *priv = gtk_sidebar_get_instance_private (sidebar);
-
-  g_hash_table_destroy (priv->rows);
-
-  G_OBJECT_CLASS (gtk_sidebar_parent_class)->finalize (object);
-}
-
-static void
-gtk_sidebar_class_init (GtkSidebarClass *klass)
-{
-  GObjectClass *object_class = G_OBJECT_CLASS (klass);
-
-  object_class->dispose = gtk_sidebar_dispose;
-  object_class->finalize = gtk_sidebar_finalize;
-  object_class->set_property = gtk_sidebar_set_property;
-  object_class->get_property = gtk_sidebar_get_property;
-
-  obj_properties[PROP_STACK] =
-      g_param_spec_object (I_("stack"), P_("Stack"),
-                           P_("Associated stack for this GtkSidebar"),
-                           GTK_TYPE_STACK,
-                           G_PARAM_READWRITE|G_PARAM_STATIC_STRINGS|G_PARAM_EXPLICIT_NOTIFY);
-
-  g_object_class_install_properties (object_class, N_PROPERTIES, obj_properties);
-}
-
-/**
- * gtk_sidebar_new:
- *
- * Creates a new sidebar.
- *
- * Returns: the new #GtkSidebar
- *
- * Since: 3.16
- */
-GtkWidget *
-gtk_sidebar_new (void)
-{
-  return GTK_WIDGET (g_object_new (GTK_TYPE_SIDEBAR, NULL));
-}
-
-/**
- * gtk_sidebar_set_stack:
- * @sidebar: a #GtkSidebar
- * @stack: a #GtkStack
- *
- * Set the #GtkStack associated with this #GtkSidebar.
- *
- * The sidebar widget will automatically update according to the order
- * (packing) and items within the given #GtkStack.
- *
- * Since: 3.16
- */
-void
-gtk_sidebar_set_stack (GtkSidebar *sidebar,
-                       GtkStack   *stack)
-{
-  GtkSidebarPrivate *priv;
-
-  g_return_if_fail (GTK_IS_SIDEBAR (sidebar));
-  g_return_if_fail (GTK_IS_STACK (stack) || stack == NULL);
-
-  priv = gtk_sidebar_get_instance_private (sidebar);
-
-  if (priv->stack == stack)
-    return;
-
-  if (priv->stack)
-    {
-      disconnect_stack_signals (sidebar);
-      clear_sidebar (sidebar);
-      g_clear_object (&priv->stack);
-    }
-  if (stack)
-    {
-      priv->stack = g_object_ref (stack);
-      populate_sidebar (sidebar);
-      connect_stack_signals (sidebar);
-    }
-
-  gtk_widget_queue_resize (GTK_WIDGET (sidebar));
-
-  g_object_notify (G_OBJECT (sidebar), "stack");
-}
-
-/**
- * gtk_sidebar_get_stack:
- * @sidebar: a #GtkSidebar
- *
- * Retrieves the stack.
- * See gtk_sidebar_set_stack().
- *
- * Returns: (transfer full): the associated #GtkStack or
- *     %NULL if none has been set explicitly
- *
- * Since: 3.16
- */
-GtkStack *
-gtk_sidebar_get_stack (GtkSidebar *sidebar)
-{
-  GtkSidebarPrivate *priv;
-
-  g_return_val_if_fail (GTK_IS_SIDEBAR (sidebar), NULL);
-
-  priv = gtk_sidebar_get_instance_private (sidebar);
-
-  return GTK_STACK (priv->stack);
-}