Merge lp:~themuso/libdbusmenu/add-accessible-desc-property into lp:libdbusmenu/0.6

[Luke Yelavich]

THe code in this branch builds and does work at a technical level, but the desired alternative labels for menu items won't be properly read with orca unless either GTK3 version 3.2.2-2ubuntu4 or GTK2 version 2.24.8-0ubuntu5 are installed, as I had to extend the accessible objects in GTK to allow dbusmenu to set a different accessible name.

I hope to get the GTK code changes upstream ASAP, hopefully for GTK 3.4, but if not, then future GTK releases.

[Luke Yelavich (themuso)]

Ok, turns out that this does not need any changes in GTK, GTK supports this natively.

[Ted Gould (ted)]

There were a couple of typos in the function names. But I've cleaned them up. No worries.

review: Approve

=== modified file 'configure.ac'
--- configure.ac	2011-10-13 16:12:03 +0000
+++ configure.ac	2011-12-13 00:11:23 +0000
@@ -73,6 +73,7 @@
 AS_IF([test "x$enable_gtk" != "xno"],[
 AS_IF([test "x$with_gtk" = x3],
         [PKG_CHECK_MODULES(DBUSMENUGTK,  gtk+-3.0 >= $GTK3_REQUIRED_VERSION
+                                         atk
                                          glib-2.0 >= $GLIB_REQUIRED_VERSION,
                                          [have_gtk=yes]
 )
@@ -80,6 +81,7 @@
         ],
       [test "x$with_gtk" = x2],
         [PKG_CHECK_MODULES(DBUSMENUGTK,  gtk+-2.0 >= $GTK_REQUIRED_VERSION
+                                         atk
                                          glib-2.0 >= $GLIB_REQUIRED_VERSION,
                                          [have_gtk=yes]
 )
 
=== modified file 'libdbusmenu-glib/client.c'
--- libdbusmenu-glib/client.c	2011-09-30 14:21:15 +0000
+++ libdbusmenu-glib/client.c	2011-12-13 00:11:23 +0000
@@ -331,7 +331,7 @@
 	return;
 }
 
-#define LAYOUT_PROPS_COUNT  5
+#define LAYOUT_PROPS_COUNT  6
 
 static void
 dbusmenu_client_init (DbusmenuClient *self)
@@ -359,6 +359,7 @@
 	layout_props[2] = DBUSMENU_MENUITEM_PROP_VISIBLE;
 	layout_props[3] = DBUSMENU_MENUITEM_PROP_ENABLED;
 	layout_props[4] = DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY;
+	layout_props[5] = DBUSMENU_MENUITEM_PROP_ACCESSIBLE_DESC;
 	layout_props[LAYOUT_PROPS_COUNT] = NULL;
 	priv->layout_props = g_variant_new_strv((const gchar * const *)layout_props, LAYOUT_PROPS_COUNT);
 	g_variant_ref_sink(priv->layout_props);
 
=== modified file 'libdbusmenu-glib/defaults.c'
--- libdbusmenu-glib/defaults.c	2011-08-22 16:30:06 +0000
+++ libdbusmenu-glib/defaults.c	2011-12-13 00:11:23 +0000
@@ -88,6 +88,7 @@
 	dbusmenu_defaults_default_set(self,   DBUSMENU_CLIENT_TYPES_DEFAULT,    DBUSMENU_MENUITEM_PROP_SHORTCUT,       G_VARIANT_TYPE("aas"),    NULL); 
 	dbusmenu_defaults_default_set(self,   DBUSMENU_CLIENT_TYPES_DEFAULT,    DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY,  G_VARIANT_TYPE_STRING,    NULL); 
 	dbusmenu_defaults_default_set(self,   DBUSMENU_CLIENT_TYPES_DEFAULT,    DBUSMENU_MENUITEM_PROP_DISPOSITION,    G_VARIANT_TYPE_STRING,    g_variant_new_string(DBUSMENU_MENUITEM_DISPOSITION_NORMAL)); 
+	dbusmenu_defaults_default_set(self,   DBUSMENU_CLIENT_TYPES_DEFAULT,    DBUSMENU_MENUITEM_PROP_ACCESSIBLE_DESC,G_VARIANT_TYPE_STRING,    NULL);
 
 	/* Separator defaults */
 	dbusmenu_defaults_default_set(self,   DBUSMENU_CLIENT_TYPES_SEPARATOR,  DBUSMENU_MENUITEM_PROP_VISIBLE,        G_VARIANT_TYPE_BOOLEAN,   g_variant_new_boolean(TRUE)); 
 
=== modified file 'libdbusmenu-glib/menuitem.h'
--- libdbusmenu-glib/menuitem.h	2011-08-22 16:39:13 +0000
+++ libdbusmenu-glib/menuitem.h	2011-12-13 00:11:23 +0000
@@ -154,6 +154,18 @@
  */
 #define DBUSMENU_MENUITEM_PROP_ICON_DATA             "icon-data"
 /**
+ * DBUSMENU_MENUITEM_PROP_ACCESSIBLE_DESC:
+ *
+ * #DbusmenuMenuitem property used to provide a textual description of any
+ * information that the icon may convey. The contents of this property are
+ * passed through to assistive technologies such as the Orca screen reader.
+ * The contents of this property will not be visible in the menu item. If
+ * this property is set, Orca will use this property instead of the label 
+ * property.
+ * Type: #G_VARIANT_TYPE_STRING
+ */
+#define DBUSMENU_MENUITEM_PROP_ACCESSIBLE_DESC       "accessible-desc"
+/**
  * DBUSMENU_MENUITEM_PROP_TOGGLE_TYPE:
  *
  * #DbusmenuMenuitem property that says what type of toggle entry should
 
=== modified file 'libdbusmenu-gtk/client.c'
--- libdbusmenu-gtk/client.c	2011-11-10 22:49:27 +0000
+++ libdbusmenu-gtk/client.c	2011-12-13 00:11:23 +0000
@@ -32,6 +32,7 @@
 
 #include <gtk/gtk.h>
 #include <glib.h>
+#include <atk/atk.h>
 
 #include "client.h"
 #include "menuitem.h"
@@ -745,6 +746,9 @@
 		process_submenu(mi, gmi, variant, gtkclient);
 	} else if (!g_strcmp0(prop, DBUSMENU_MENUITEM_PROP_DISPOSITION)) {
 		process_disposition(mi, gmi, variant, gtkclient);
+	} else if (!g_strcmp0(prop, DBUSMENU_MENUITEM_PROP_ACCESSIBLE_DESC)) {
+		atk_object_set_name(gtk_widget_get_accessible(GTK_WIDGET(gmi)), variant == NULL ? NULL :
+		                    g_variant_get_string(variant, NULL));
 	}
 
 	return;
@@ -890,6 +894,8 @@
 	process_toggle_state(item, gmi, dbusmenu_menuitem_property_get_variant(item, DBUSMENU_MENUITEM_PROP_TOGGLE_STATE));
 	process_submenu(item, gmi, dbusmenu_menuitem_property_get_variant(item, DBUSMENU_MENUITEM_PROP_CHILD_DISPLAY), client);
 	process_disposition(item, gmi, dbusmenu_menuitem_property_get_variant(item, DBUSMENU_MENUITEM_PROP_DISPOSITION), client);
+	atk_object_set_name(gtk_widget_Get_accessible(GTK_WIDGET)gmi)),
+			    g_variant_get_string(dbusmenu_menuitem_property_get_variant(item, DBUSMENU_MENUITEM_PROP_ACCESSIBLE_DESC)));
 	refresh_shortcut(client, item);
 
 	/* Oh, we're a child, let's deal with that */