Convert GailNotebook to GtkNotebookAccessible

1 files changed, 407 insertions, 0 deletions

diff --git a/gtk/a11y/gtknotebookaccessible.c b/gtk/a11y/gtknotebookaccessible.c
new file mode 100644
index 0000000000..ba4040361f
--- /dev/null
+++ b/gtk/a11y/gtknotebookaccessible.c
@@ -0,0 +1,407 @@
+/* GAIL - The GNOME Accessibility Implementation Library
+ * Copyright 2001, 2002, 2003 Sun Microsystems Inc.
+ *
+ * This library 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 library 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 library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+
+#include "config.h"
+
+#include <string.h>
+#include <gtk/gtk.h>
+#include "gtknotebookaccessible.h"
+#include "gailnotebookpage.h"
+
+
+static void atk_selection_interface_init (AtkSelectionIface *iface);
+
+G_DEFINE_TYPE_WITH_CODE (GtkNotebookAccessible, gtk_notebook_accessible, GAIL_TYPE_CONTAINER,
+                         G_IMPLEMENT_INTERFACE (ATK_TYPE_SELECTION, atk_selection_interface_init))
+
+static gboolean
+check_focus_tab (gpointer data)
+{
+  GtkWidget *widget;
+  AtkObject *atk_obj;
+  gint focus_page_num, old_focus_page_num;
+  GtkNotebookAccessible *accessible;
+  GtkNotebook *notebook;
+
+  atk_obj = ATK_OBJECT (data);
+  accessible = GTK_NOTEBOOK_ACCESSIBLE (atk_obj);
+  widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (atk_obj));
+  notebook = GTK_NOTEBOOK (widget);
+
+  accessible->idle_focus_id = 0;
+
+  focus_page_num = gtk_notebook_get_current_page (notebook);
+  if (focus_page_num == -1)
+    return FALSE;
+
+  old_focus_page_num = accessible->focus_tab_page;
+  accessible->focus_tab_page = focus_page_num;
+  if (old_focus_page_num != focus_page_num)
+    {
+      AtkObject *obj;
+
+      obj = atk_object_ref_accessible_child (atk_obj, focus_page_num);
+      atk_focus_tracker_notify (obj);
+      g_object_unref (obj);
+    }
+
+  return FALSE;
+}
+
+static gboolean
+focus_cb (GtkWidget        *widget,
+          GtkDirectionType  type)
+{
+  AtkObject *atk_obj = gtk_widget_get_accessible (widget);
+  GtkNotebookAccessible *accessible = GTK_NOTEBOOK_ACCESSIBLE (atk_obj);
+
+  switch (type)
+    {
+    case GTK_DIR_LEFT:
+    case GTK_DIR_RIGHT:
+      if (accessible->idle_focus_id == 0)
+        accessible->idle_focus_id = gdk_threads_add_idle (check_focus_tab, atk_obj);
+      break;
+    default:
+      break;
+    }
+  return FALSE;
+}
+
+static void
+create_notebook_page_accessible (GtkNotebookAccessible *accessible,
+                                 GtkNotebook           *notebook,
+                                 GtkWidget             *child,
+                                 gint                   page_num)
+{
+  AtkObject *obj;
+
+  obj = gail_notebook_page_new (accessible, child);
+  g_hash_table_insert (accessible->pages, child, obj);
+  atk_object_set_parent (obj, ATK_OBJECT (accessible));
+  g_signal_emit_by_name (accessible, "children_changed::add", page_num, obj, NULL);
+}
+
+static void
+page_added_cb (GtkNotebook *notebook,
+               GtkWidget   *child,
+               guint        page_num,
+               gpointer     data)
+{
+  AtkObject *atk_obj;
+  GtkNotebookAccessible *accessible;
+
+  atk_obj = gtk_widget_get_accessible (GTK_WIDGET (notebook));
+  accessible = GTK_NOTEBOOK_ACCESSIBLE (atk_obj);
+  create_notebook_page_accessible (accessible, notebook, child, page_num);
+}
+
+static void
+page_removed_cb (GtkNotebook *notebook,
+                 GtkWidget   *widget,
+                 guint        page_num,
+                 gpointer     data)
+{
+  GtkNotebookAccessible *accessible;
+  AtkObject *obj;
+
+  accessible = GTK_NOTEBOOK_ACCESSIBLE (gtk_widget_get_accessible (GTK_WIDGET (notebook)));
+
+  obj = g_hash_table_lookup (accessible->pages, widget);
+  g_return_if_fail (obj);
+  g_signal_emit_by_name (accessible, "children_changed::remove",
+                         page_num, obj, NULL);
+  gail_notebook_page_invalidate (GAIL_NOTEBOOK_PAGE (obj));
+  g_hash_table_remove (accessible->pages, widget);
+}
+
+
+static void
+accessible_destroyed (gpointer data)
+{
+  GtkNotebookAccessible *accessible = GTK_NOTEBOOK_ACCESSIBLE (data);
+
+  if (accessible->idle_focus_id)
+    {
+      g_source_remove (accessible->idle_focus_id);
+      accessible->idle_focus_id = 0;
+    }
+}
+static void
+gtk_notebook_accessible_initialize (AtkObject *obj,
+                                    gpointer   data)
+{
+  GtkNotebookAccessible *accessible;
+  GtkNotebook *notebook;
+  gint i;
+
+  ATK_OBJECT_CLASS (gtk_notebook_accessible_parent_class)->initialize (obj, data);
+
+  accessible = GTK_NOTEBOOK_ACCESSIBLE (obj);
+  notebook = GTK_NOTEBOOK (data);
+  for (i = 0; i < gtk_notebook_get_n_pages (notebook); i++)
+    {
+      create_notebook_page_accessible (accessible,
+                                       notebook,
+                                       gtk_notebook_get_nth_page (notebook, i),
+                                       i);
+    }
+  accessible->selected_page = gtk_notebook_get_current_page (notebook);
+
+  g_signal_connect (notebook, "focus",
+                    G_CALLBACK (focus_cb), NULL);
+  g_signal_connect (notebook, "page-added",
+                    G_CALLBACK (page_added_cb), NULL);
+  g_signal_connect (notebook, "page-removed",
+                    G_CALLBACK (page_removed_cb), NULL);
+
+  g_object_weak_ref (G_OBJECT (notebook), (GWeakNotify)accessible_destroyed, obj);
+
+  obj->role = ATK_ROLE_PAGE_TAB_LIST;
+}
+
+static void
+gtk_notebook_accessible_finalize (GObject *object)
+{
+  GtkNotebookAccessible *accessible = GTK_NOTEBOOK_ACCESSIBLE (object);
+
+  g_hash_table_destroy (accessible->pages);
+
+  if (accessible->idle_focus_id)
+    g_source_remove (accessible->idle_focus_id);
+
+  G_OBJECT_CLASS (gtk_notebook_accessible_parent_class)->finalize (object);
+}
+
+static AtkObject *
+gtk_notebook_accessible_ref_child (AtkObject *obj,
+                                   gint       i)
+{
+  AtkObject *child;
+  GtkNotebookAccessible *accessible;
+  GtkNotebook *notebook;
+  GtkWidget *widget;
+ 
+  widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (obj));
+  if (widget == NULL)
+    return NULL;
+
+  accessible = GTK_NOTEBOOK_ACCESSIBLE (obj);
+  notebook = GTK_NOTEBOOK (widget);
+
+  child = g_hash_table_lookup (accessible->pages,
+                               gtk_notebook_get_nth_page (notebook, i));
+  /* can return NULL when i >= n_children */
+
+  if (child)
+    g_object_ref (child);
+
+  return child;
+}
+
+static void
+gtk_notebook_accessible_notify_gtk (GObject    *obj,
+                                    GParamSpec *pspec)
+{
+  GtkWidget *widget;
+  AtkObject* atk_obj;
+
+  widget = GTK_WIDGET (obj);
+  atk_obj = gtk_widget_get_accessible (widget);
+
+  if (strcmp (pspec->name, "page") == 0)
+    {
+      gint page_num, old_page_num;
+      gint focus_page_num = 0;
+      gint old_focus_page_num;
+      GtkNotebookAccessible *accessible;
+      GtkNotebook *notebook;
+
+      accessible = GTK_NOTEBOOK_ACCESSIBLE (atk_obj);
+      notebook = GTK_NOTEBOOK (widget);
+
+      /* Notify SELECTED state change for old and new page */
+      old_page_num = accessible->selected_page;
+      page_num = gtk_notebook_get_current_page (notebook);
+      accessible->selected_page = page_num;
+      accessible->focus_tab_page = page_num;
+      old_focus_page_num = accessible->focus_tab_page;
+
+      if (page_num != old_page_num)
+        {
+          AtkObject *obj;
+
+          if (old_page_num != -1)
+            {
+              obj = gtk_notebook_accessible_ref_child (atk_obj, old_page_num);
+              if (obj)
+                {
+                  atk_object_notify_state_change (obj, ATK_STATE_SELECTED, FALSE);
+                  g_object_unref (obj);
+                }
+            }
+          obj = gtk_notebook_accessible_ref_child (atk_obj, page_num);
+          if (obj)
+            {
+              atk_object_notify_state_change (obj, ATK_STATE_SELECTED, TRUE);
+              g_object_unref (obj);
+              /*
+               * The page which is being displayed has changed but there is
+               * no need to tell the focus tracker as the focus page will also
+               * change or a widget in the page will receive focus if the
+               * Notebook does not have tabs.
+               */
+            }
+          g_signal_emit_by_name (atk_obj, "selection_changed");
+          g_signal_emit_by_name (atk_obj, "visible_data_changed");
+        }
+      if (gtk_notebook_get_show_tabs (notebook) &&
+         (focus_page_num != old_focus_page_num))
+        {
+          if (accessible->idle_focus_id)
+            g_source_remove (accessible->idle_focus_id);
+          accessible->idle_focus_id = gdk_threads_add_idle (check_focus_tab, atk_obj);
+        }
+    }
+  else
+    GAIL_WIDGET_CLASS (gtk_notebook_accessible_parent_class)->notify_gtk (obj, pspec);
+}
+
+/*
+ * GtkNotebook only supports the selection of one page at a time.
+ * Selecting a page unselects any previous selection, so this
+ * changes the current selection instead of adding to it.
+ */
+static gboolean
+gtk_notebook_accessible_add_selection (AtkSelection *selection,
+                                       gint          i)
+{
+  GtkNotebook *notebook;
+  GtkWidget *widget;
+
+  widget =  gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
+  if (widget == NULL)
+    return FALSE;
+
+  notebook = GTK_NOTEBOOK (widget);
+  gtk_notebook_set_current_page (notebook, i);
+  return TRUE;
+}
+
+static void
+gtk_notebook_accessible_class_init (GtkNotebookAccessibleClass *klass)
+{
+  GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
+  AtkObjectClass  *class = ATK_OBJECT_CLASS (klass);
+  GailWidgetClass *widget_class = (GailWidgetClass*)klass;
+
+  gobject_class->finalize = gtk_notebook_accessible_finalize;
+
+  class->ref_child = gtk_notebook_accessible_ref_child;
+  class->initialize = gtk_notebook_accessible_initialize;
+
+  widget_class->notify_gtk = gtk_notebook_accessible_notify_gtk;
+}
+
+static void
+gtk_notebook_accessible_init (GtkNotebookAccessible *notebook)
+{
+  notebook->pages = g_hash_table_new_full (g_direct_hash,
+                                           g_direct_equal,
+                                           NULL,
+                                           g_object_unref);
+  notebook->selected_page = -1;
+  notebook->focus_tab_page = -1;
+  notebook->idle_focus_id = 0;
+}
+
+static AtkObject *
+gtk_notebook_accessible_ref_selection (AtkSelection *selection,
+                                       gint          i)
+{
+  AtkObject *accessible;
+  GtkWidget *widget;
+  GtkNotebook *notebook;
+  gint pagenum;
+
+  if (i != 0)
+    return NULL;
+
+  widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
+  if (widget == NULL)
+    return NULL;
+
+  notebook = GTK_NOTEBOOK (widget);
+  pagenum = gtk_notebook_get_current_page (notebook);
+  if (pagenum == -1)
+    return NULL;
+  accessible = gtk_notebook_accessible_ref_child (ATK_OBJECT (selection), pagenum);
+
+  return accessible;
+}
+
+/* Always return 1 because there can only be one page
+ * selected at any time
+ */
+static gint
+gtk_notebook_accessible_get_selection_count (AtkSelection *selection)
+{
+  GtkWidget *widget;
+  GtkNotebook *notebook;
+
+  widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
+  if (widget == NULL)
+    return 0;
+
+  notebook = GTK_NOTEBOOK (widget);
+  if (notebook == NULL || gtk_notebook_get_current_page (notebook) == -1)
+    return 0;
+
+  return 1;
+}
+
+static gboolean
+gtk_notebook_accessible_is_child_selected (AtkSelection *selection,
+                                           gint          i)
+{
+  GtkWidget *widget;
+  GtkNotebook *notebook;
+  gint pagenumber;
+
+  widget = gtk_accessible_get_widget (GTK_ACCESSIBLE (selection));
+  if (widget == NULL)
+    return FALSE;
+
+  notebook = GTK_NOTEBOOK (widget);
+  pagenumber = gtk_notebook_get_current_page(notebook);
+
+  if (pagenumber == i)
+    return TRUE;
+
+  return FALSE;
+}
+
+static void
+atk_selection_interface_init (AtkSelectionIface *iface)
+{
+  iface->add_selection = gtk_notebook_accessible_add_selection;
+  iface->ref_selection = gtk_notebook_accessible_ref_selection;
+  iface->get_selection_count = gtk_notebook_accessible_get_selection_count;
+  iface->is_child_selected = gtk_notebook_accessible_is_child_selected;
+}