Merge lp:~themuso/unity/improve-shutdown-dialog-a11y into lp:unity

[Luke Yelavich]

Implement accessibility for the optino buttons in the shutdown dialog.

Also improve the parent-child relationship between objects such that the shutdown message can be read with Orca flat review.

Implement accessibility for the optino buttons in the shutdown dialog.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:3670
http://jenkins.qa.ubuntu.com/job/unity-ci/685/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-trusty-amd64-ci/221
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-trusty-armhf-ci/217
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-trusty-i386-ci/219

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-ci/685/rebuild

review: Approve (continuous-integration)

[Marco Trevisan (Treviño) (3v1n0)]

412 + highlight_change.emit();

424 + sigc::signal<void> highlight_change;

You don't need that, I'm using a nux::Property for highlighted, and it already supports signaling.

Just connect to highlighted.changed signal ;)

review: Needs Fixing

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:3672
http://jenkins.qa.ubuntu.com/job/unity-ci/707/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-trusty-amd64-ci/243
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-trusty-armhf-ci/239
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-trusty-i386-ci/241

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-ci/707/rebuild

review: Approve (continuous-integration)

[Marco Trevisan (Treviño) (3v1n0)]

376 + if (object->Type().IsDerivedFromType(Button::StaticObjectType))
377 + return unity_session_button_accessible_new(object);

It shuold work anyway, but I think it's better to use IsDerivedFromType(session::Button::StaticObjectType), to avoid future conflicts.

Anyway this looks good now, thanks

review: Approve

=== modified file 'plugins/unityshell/src/nux-layout-accessible.cpp'
--- plugins/unityshell/src/nux-layout-accessible.cpp	2012-08-15 14:05:18 +0000
+++ plugins/unityshell/src/nux-layout-accessible.cpp	2014-02-25 01:48:00 +0000
@@ -137,6 +137,7 @@
   std::list<nux::Area*> element_list;
   gint num = 0;
   std::list<nux::Area*>::iterator it;
+  AtkObject* parent = NULL;
 
   g_return_val_if_fail(NUX_IS_LAYOUT_ACCESSIBLE(obj), 0);
   num = atk_object_get_n_accessible_children(obj);
@@ -156,6 +157,10 @@
   child = dynamic_cast<nux::Object*>(*it);
   child_accessible = unity_a11y_get_accessible(child);
 
+  parent = atk_object_get_parent(child_accessible);
+  if (parent != obj)
+    atk_object_set_parent(child_accessible, obj);
+
   g_object_ref(child_accessible);
 
   return child_accessible;

=== added file 'plugins/unityshell/src/unity-session-button-accessible.cpp'
--- plugins/unityshell/src/unity-session-button-accessible.cpp	1970-01-01 00:00:00 +0000
+++ plugins/unityshell/src/unity-session-button-accessible.cpp	2014-02-25 01:48:00 +0000
@@ -0,0 +1,260 @@
+/*
+ * Copyright (C) 2011 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Luke Yelavich <[e-mail]>
+ */
+
+/**
+ * SECTION:unity-session_button_accessible
+ * @Title: UnitySessionButtonAccessible
+ * @short_description: Implementation of the ATK interfaces for #unity::session::Button
+ *
+ * #UnitySessionButtonAccessible implements the required ATK interfaces of
+ * unity::Button, exposing the common elements on each basic individual
+ * element (position, extents, etc)
+ *
+ */
+
+#include "unity-session-button-accessible.h"
+#include "SessionButton.h"
+
+#include "unitya11y.h"
+
+using namespace unity::session;
+
+/* GObject */
+static void unity_session_button_accessible_class_init(UnitySessionButtonAccessibleClass* klass);
+static void unity_session_button_accessible_init(UnitySessionButtonAccessible* session_button_accessible);
+static void unity_session_button_accessible_dispose(GObject* object);
+static void unity_session_button_accessible_finalize(GObject* object);
+
+
+/* AtkObject.h */
+static void          unity_session_button_accessible_initialize(AtkObject* accessible,
+                                                               gpointer   data);
+static AtkStateSet*  unity_session_button_accessible_ref_state_set(AtkObject* obj);
+static const gchar* unity_session_button_accessible_get_name(AtkObject* obj);
+
+
+/* AtkAction */
+static void         atk_action_interface_init(AtkActionIface *iface);
+static gboolean     unity_session_button_accessible_do_action(AtkAction *action,
+                                                              gint i);
+static gint         unity_session_button_accessible_get_n_actions(AtkAction *action);
+static const gchar* unity_session_button_accessible_get_name(AtkAction *action,
+                                                            gint i);
+
+/* private/utility methods*/
+static void on_focus_change_cb(bool const& value, UnitySessionButtonAccessible* accessible);
+
+G_DEFINE_TYPE_WITH_CODE(UnitySessionButtonAccessible,
+                        unity_session_button_accessible,
+                        NUX_TYPE_OBJECT_ACCESSIBLE,
+                        G_IMPLEMENT_INTERFACE(ATK_TYPE_ACTION,
+                                              atk_action_interface_init))
+
+static void
+unity_session_button_accessible_class_init(UnitySessionButtonAccessibleClass* klass)
+{
+  GObjectClass* gobject_class = G_OBJECT_CLASS(klass);
+  AtkObjectClass* atk_class = ATK_OBJECT_CLASS(klass);
+
+  gobject_class->dispose = unity_session_button_accessible_dispose;
+  gobject_class->finalize = unity_session_button_accessible_finalize;
+
+  /* AtkObject */
+  atk_class->initialize = unity_session_button_accessible_initialize;
+  atk_class->get_name = unity_session_button_accessible_get_name;
+  atk_class->ref_state_set = unity_session_button_accessible_ref_state_set;
+}
+
+static void
+unity_session_button_accessible_init(UnitySessionButtonAccessible* session_button_accessible)
+{
+}
+
+static void
+unity_session_button_accessible_dispose(GObject* object)
+{
+  G_OBJECT_CLASS(unity_session_button_accessible_parent_class)->dispose(object);
+}
+
+static void
+unity_session_button_accessible_finalize(GObject* object)
+{
+  G_OBJECT_CLASS(unity_session_button_accessible_parent_class)->finalize(object);
+}
+
+AtkObject*
+unity_session_button_accessible_new(nux::Object* object)
+{
+  AtkObject* accessible = NULL;
+
+  g_return_val_if_fail(dynamic_cast<Button*>(object), NULL);
+
+  accessible = ATK_OBJECT(g_object_new(UNITY_TYPE_SESSION_BUTTON_ACCESSIBLE, NULL));
+
+  atk_object_initialize(accessible, object);
+
+  return accessible;
+}
+
+/* AtkObject.h */
+static void
+unity_session_button_accessible_initialize(AtkObject* accessible,
+                                          gpointer data)
+{
+  UnitySessionButtonAccessible* self = NULL;
+  nux::Object* nux_object = NULL;
+  Button* button = NULL;
+
+  ATK_OBJECT_CLASS(unity_session_button_accessible_parent_class)->initialize(accessible, data);
+  self = UNITY_SESSION_BUTTON_ACCESSIBLE(accessible);
+
+  accessible->role = ATK_ROLE_PUSH_BUTTON;
+
+  nux_object = nux_object_accessible_get_object(NUX_OBJECT_ACCESSIBLE(accessible));
+
+  if (nux_object == NULL) /* defunct */
+    return;
+
+  button = dynamic_cast<Button*>(nux_object);
+
+  button->highlighted.changed.connect(sigc::bind(sigc::ptr_fun(on_focus_change_cb),
+                                                 UNITY_SESSION_BUTTON_ACCESSIBLE(self)));
+}
+
+static const gchar*
+unity_session_button_accessible_get_name(AtkObject* obj)
+{
+  const gchar* name;
+
+  g_return_val_if_fail(UNITY_IS_SESSION_BUTTON_ACCESSIBLE(obj), NULL);
+
+  name = ATK_OBJECT_CLASS(unity_session_button_accessible_parent_class)->get_name(obj);
+  if (name == NULL)
+  {
+    Button* button = NULL;
+
+    button = dynamic_cast<Button*>(nux_object_accessible_get_object(NUX_OBJECT_ACCESSIBLE(obj)));
+
+    if (button == NULL) /* State is defunct */
+      name = NULL;
+    else
+      name = button->label().c_str();
+  }
+
+  return name;
+}
+
+static AtkStateSet*
+unity_session_button_accessible_ref_state_set(AtkObject* obj)
+{
+  AtkStateSet* state_set = NULL;
+  nux::Object* nux_object = NULL;
+  Button* button = NULL;
+
+  g_return_val_if_fail(UNITY_IS_SESSION_BUTTON_ACCESSIBLE(obj), NULL);
+
+  state_set = ATK_OBJECT_CLASS(unity_session_button_accessible_parent_class)->ref_state_set(obj);
+
+  nux_object = nux_object_accessible_get_object(NUX_OBJECT_ACCESSIBLE(obj));
+
+  if (nux_object == NULL) /* defunct */
+    return state_set;
+
+  button = dynamic_cast<Button*>(nux_object);
+
+  atk_state_set_add_state(state_set, ATK_STATE_FOCUSABLE);
+  atk_state_set_add_state(state_set, ATK_STATE_ENABLED);
+  atk_state_set_add_state(state_set, ATK_STATE_SENSITIVE);
+  atk_state_set_add_state(state_set, ATK_STATE_VISIBLE);
+  atk_state_set_add_state(state_set, ATK_STATE_SHOWING);
+
+  if (button->highlighted)
+  {
+    atk_state_set_add_state(state_set, ATK_STATE_FOCUSED);
+    atk_state_set_add_state(state_set, ATK_STATE_SELECTED);
+    atk_state_set_add_state(state_set, ATK_STATE_ACTIVE);
+  }
+
+  return state_set;
+}
+
+/* private methods */
+static void
+on_focus_change_cb(bool const& value, UnitySessionButtonAccessible* accessible)
+{
+  nux::Object* nux_object = NULL;
+  Button* button = NULL;
+
+  nux_object = nux_object_accessible_get_object(NUX_OBJECT_ACCESSIBLE(accessible));
+
+  if (nux_object == NULL) /* defunct */
+    return;
+
+  button = dynamic_cast<Button*>(nux_object);
+
+  atk_object_notify_state_change(ATK_OBJECT(accessible), ATK_STATE_FOCUSED, button->highlighted);
+  atk_object_notify_state_change(ATK_OBJECT(accessible), ATK_STATE_SELECTED, button->highlighted);
+  atk_object_notify_state_change(ATK_OBJECT(accessible), ATK_STATE_ACTIVE, button->highlighted);
+}
+
+/* AtkAction */
+static void
+atk_action_interface_init(AtkActionIface *iface)
+{
+  iface->do_action = unity_session_button_accessible_do_action;
+  iface->get_n_actions = unity_session_button_accessible_get_n_actions;
+  iface->get_name = unity_session_button_accessible_get_name;
+}
+
+static gboolean
+unity_session_button_accessible_do_action(AtkAction *action,
+                                         gint i)
+{
+  Button* button = NULL;
+  nux::Object* nux_object = NULL;
+
+  g_return_val_if_fail(UNITY_IS_SESSION_BUTTON_ACCESSIBLE(action), FALSE);
+
+  nux_object = nux_object_accessible_get_object(NUX_OBJECT_ACCESSIBLE(action));
+  if (nux_object == NULL)
+    return FALSE;
+
+  button = dynamic_cast<Button*>(nux_object);
+
+  button->activated.emit();
+
+  return TRUE;
+}
+
+static gint
+unity_session_button_accessible_get_n_actions(AtkAction *action)
+{
+  g_return_val_if_fail(UNITY_IS_SESSION_BUTTON_ACCESSIBLE(action), 0);
+
+  return 1;
+}
+
+static const gchar*
+unity_session_button_accessible_get_name(AtkAction *action,
+                                        gint i)
+{
+  g_return_val_if_fail(UNITY_IS_SESSION_BUTTON_ACCESSIBLE(action), NULL);
+  g_return_val_if_fail(i == 0, NULL);
+
+  return "activate";
+}

=== added file 'plugins/unityshell/src/unity-session-button-accessible.h'
--- plugins/unityshell/src/unity-session-button-accessible.h	1970-01-01 00:00:00 +0000
+++ plugins/unityshell/src/unity-session-button-accessible.h	2014-02-25 01:48:00 +0000
@@ -0,0 +1,53 @@
+/*
+ * Copyright (C) 2011 Canonical Ltd
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3 as
+ * published by the Free Software Foundation.
+ *
+ * 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 General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ *
+ * Authored by: Alejandro Piñeiro Iglesias <[e-mail]>
+ */
+
+#ifndef UNITY_SESSION_BUTTON_ACCESSIBLE_H
+#define UNITY_SESSION_BUTTON_ACCESSIBLE_H
+
+#include <atk/atk.h>
+
+#include "nux-object-accessible.h"
+
+G_BEGIN_DECLS
+
+#define UNITY_TYPE_SESSION_BUTTON_ACCESSIBLE            (unity_session_button_accessible_get_type ())
+#define UNITY_SESSION_BUTTON_ACCESSIBLE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), UNITY_TYPE_SESSION_BUTTON_ACCESSIBLE, UnitySessionButtonAccessible))
+#define UNITY_SESSION_BUTTON_ACCESSIBLE_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), UNITY_TYPE_SESSION_BUTTON_ACCESSIBLE, UnitySessionButtonAccessibleClass))
+#define UNITY_IS_SESSION_BUTTON_ACCESSIBLE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), UNITY_TYPE_SESSION_BUTTON_ACCESSIBLE))
+#define UNITY_IS_SESSION_BUTTON_ACCESSIBLE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), UNITY_TYPE_SESSION_BUTTON_ACCESSIBLE))
+#define UNITY_SESSION_BUTTON_ACCESSIBLE_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), UNITY_TYPE_SESSION_BUTTON_ACCESSIBLE, UnitySessionButtonAccessibleClass))
+
+typedef struct _UnitySessionButtonAccessible        UnitySessionButtonAccessible;
+typedef struct _UnitySessionButtonAccessibleClass   UnitySessionButtonAccessibleClass;
+
+struct _UnitySessionButtonAccessible
+{
+  NuxObjectAccessible parent;
+};
+
+struct _UnitySessionButtonAccessibleClass
+{
+  NuxObjectAccessibleClass parent_class;
+};
+
+GType      unity_session_button_accessible_get_type(void);
+AtkObject* unity_session_button_accessible_new(nux::Object* object);
+
+G_END_DECLS
+
+#endif /* __UNITY_SESSION_BUTTON_ACCESSIBLE_H__ */

=== modified file 'plugins/unityshell/src/unitya11y.cpp'
--- plugins/unityshell/src/unitya11y.cpp	2014-01-25 13:39:49 +0000
+++ plugins/unityshell/src/unitya11y.cpp	2014-02-25 01:48:00 +0000
@@ -42,6 +42,7 @@
 #include "QuicklistView.h"
 #include "QuicklistMenuItem.h"
 #include "SwitcherView.h"
+#include "SessionButton.h"
 #include "unity-launcher-accessible.h"
 #include "unity-launcher-icon-accessible.h"
 #include "unity-panel-view-accessible.h"
@@ -53,11 +54,13 @@
 #include "unity-quicklist-accessible.h"
 #include "unity-quicklist-menu-item-accessible.h"
 #include "unity-switcher-accessible.h"
+#include "unity-session-button-accessible.h"
 
 using namespace unity;
 using namespace unity::dash;
 using namespace unity::launcher;
 using namespace unity::panel;
+using namespace unity::session;
 
 static GHashTable* accessible_table = NULL;
 /* FIXME: remove accessible objects when not required anymore */
@@ -187,6 +190,9 @@
   if (object->Type().IsDerivedFromType(unity::switcher::SwitcherView::StaticObjectType))
     return unity_switcher_accessible_new(object);
 
+  if (object->Type().IsDerivedFromType(Button::StaticObjectType))
+    return unity_session_button_accessible_new(object);
+
   /* NUX classes  */
   if (object->Type().IsDerivedFromType(nux::TextEntry::StaticObjectType))
     return nux_text_entry_accessible_new(object);