Merge lp:~attente/gtk/x-canonical-accel into lp:~ubuntu-desktop/gtk/ubuntugtk3

[William Hua]

* debian/patches/x-canonical-accel.patch:
  - allow setting menu item accelerator text directly (lp: #1208019)

Add a custom GMenuItem attribute called "x-canonical-accel" that allows the accelerator text to be set directly without needing a key code and modifier. We need this because sometimes all we have is the translated accelerator text, and parsing this is difficult considering the user's language may not be English.

[Lars Karlitski (larsu)]

It's unlikely that this will make it upstream. We should try to get apps to fix their menus in the medium term.

review: Approve

=== modified file 'debian/changelog'
--- debian/changelog	2014-03-06 14:09:33 +0000
+++ debian/changelog	2014-03-31 01:03:48 +0000
@@ -1,10 +1,15 @@
 gtk+3.0 (3.10.7-0ubuntu5) UNRELEASED; urgency=medium
 
+  [ Sebastien Bacher ]
   * debian/patches/git_grid_theming.patch:
     - "grid: draw css background and borders", that's needed to be able to
       workraround background color issues with our scrollbars/theme,
       thanks Lars Uebernickel
 
+  [ William Hua ]
+  * debian/patches/x-canonical-accel.patch:
+    - allow setting menu item accelerator text directly (lp: #1208019)
+
  -- Sebastien Bacher <[e-mail]>  Thu, 06 Mar 2014 15:04:42 +0100
 
 gtk+3.0 (3.10.7-0ubuntu4) trusty; urgency=medium

=== modified file 'debian/patches/series'
--- debian/patches/series	2014-03-06 14:09:33 +0000
+++ debian/patches/series	2014-03-31 01:03:48 +0000
@@ -24,3 +24,4 @@
 git_subtitle_typo.patch
 git_popup_menu_shift.patch
 git_grid_theming.patch
+x-canonical-accel.patch

=== added file 'debian/patches/x-canonical-accel.patch'
--- debian/patches/x-canonical-accel.patch	1970-01-01 00:00:00 +0000
+++ debian/patches/x-canonical-accel.patch	2014-03-31 01:03:48 +0000
@@ -0,0 +1,219 @@
+Description: Allow setting menu item accelerator text directly
+ Add a custom GMenuItem attribute called "x-canonical-accel" that
+ allows the accelerator text to be set directly without needing a
+ key code and modifier. We need this because sometimes all we have
+ is the translated accelerator text, and parsing this is difficult
+ considering the user's language may not be English.
+
+Author: William Hua <[e-mail]>
+Bug-Ubuntu: https://bugs.launchpad.net/bugs/1208019
+
+Index: gtk+3.0-3.10.7/gtk/gtkmenutrackeritem.c
+===================================================================
+--- gtk+3.0-3.10.7.orig/gtk/gtkmenutrackeritem.c	2014-03-31 10:57:23.969527294 +1300
++++ gtk+3.0-3.10.7/gtk/gtkmenutrackeritem.c	2014-03-31 11:01:19.941518966 +1300
+@@ -104,6 +104,7 @@
+   PROP_ROLE,
+   PROP_TOGGLED,
+   PROP_ACCEL,
++  PROP_ACCEL_TEXT,
+   PROP_SUBMENU_SHOWN,
+   N_PROPS
+ };
+@@ -174,6 +175,9 @@
+     case PROP_ACCEL:
+       g_value_set_string (value, gtk_menu_tracker_item_get_accel (self));
+       break;
++    case PROP_ACCEL_TEXT:
++      g_value_set_string (value, gtk_menu_tracker_item_get_accel_text (self));
++      break;
+     case PROP_SUBMENU_SHOWN:
+       g_value_set_boolean (value, gtk_menu_tracker_item_get_submenu_shown (self));
+       break;
+@@ -229,6 +233,8 @@
+     g_param_spec_boolean ("toggled", "", "", FALSE, G_PARAM_STATIC_STRINGS | G_PARAM_READABLE);
+   gtk_menu_tracker_item_pspecs[PROP_ACCEL] =
+     g_param_spec_string ("accel", "", "", NULL, G_PARAM_STATIC_STRINGS | G_PARAM_READABLE);
++  gtk_menu_tracker_item_pspecs[PROP_ACCEL_TEXT] =
++    g_param_spec_string ("accel-text", "", "", NULL, G_PARAM_STATIC_STRINGS | G_PARAM_READABLE);
+   gtk_menu_tracker_item_pspecs[PROP_SUBMENU_SHOWN] =
+     g_param_spec_boolean ("submenu-shown", "", "", FALSE, G_PARAM_STATIC_STRINGS | G_PARAM_READABLE);
+ 
+@@ -551,6 +557,16 @@
+   return accel;
+ }
+ 
++const gchar *
++gtk_menu_tracker_item_get_accel_text (GtkMenuTrackerItem *self)
++{
++  const gchar *accel_text = NULL;
++
++  g_menu_item_get_attribute (self->item, "x-canonical-accel", "&s", &accel_text);
++
++  return accel_text;
++}
++
+ GMenuModel *
+ _gtk_menu_tracker_item_get_submenu (GtkMenuTrackerItem *self)
+ {
+Index: gtk+3.0-3.10.7/gtk/gtkmenutrackeritem.h
+===================================================================
+--- gtk+3.0-3.10.7.orig/gtk/gtkmenutrackeritem.h	2014-03-31 10:57:23.969527294 +1300
++++ gtk+3.0-3.10.7/gtk/gtkmenutrackeritem.h	2014-03-31 10:59:10.013523551 +1300
+@@ -68,6 +68,8 @@
+ 
+ const gchar *           gtk_menu_tracker_item_get_accel                 (GtkMenuTrackerItem *self);
+ 
++const gchar *           gtk_menu_tracker_item_get_accel_text            (GtkMenuTrackerItem *self);
++
+ GMenuModel *           _gtk_menu_tracker_item_get_submenu               (GtkMenuTrackerItem *self);
+ 
+ gchar *                _gtk_menu_tracker_item_get_submenu_namespace     (GtkMenuTrackerItem *self);
+Index: gtk+3.0-3.10.7/gtk/gtkmodelmenuitem.c
+===================================================================
+--- gtk+3.0-3.10.7.orig/gtk/gtkmodelmenuitem.c	2014-01-28 11:40:16.000000000 +1300
++++ gtk+3.0-3.10.7/gtk/gtkmodelmenuitem.c	2014-03-31 11:20:07.301479178 +1300
+@@ -43,7 +43,8 @@
+   PROP_ICON,
+   PROP_TEXT,
+   PROP_TOGGLED,
+-  PROP_ACCEL
++  PROP_ACCEL,
++  PROP_ACCEL_TEXT
+ };
+ 
+ static void
+@@ -286,6 +287,44 @@
+     }
+ }
+ 
++void _gtk_accel_label_set_accel_text (GtkAccelLabel *accel_label,
++                                      const gchar   *accel_text);
++
++static void
++gtk_model_menu_item_set_accel_text (GtkModelMenuItem *item,
++                                    const gchar      *accel_text)
++{
++  GtkWidget *child;
++  GList *children;
++
++  child = gtk_bin_get_child (GTK_BIN (item));
++  if (child == NULL)
++    {
++      gtk_menu_item_get_label (GTK_MENU_ITEM (item));
++      child = gtk_bin_get_child (GTK_BIN (item));
++      g_assert (GTK_IS_LABEL (child));
++    }
++
++  if (GTK_IS_LABEL (child))
++    {
++      _gtk_accel_label_set_accel_text (GTK_ACCEL_LABEL (child), accel_text);
++      return;
++    }
++
++  if (!GTK_IS_CONTAINER (child))
++    return;
++
++  children = gtk_container_get_children (GTK_CONTAINER (child));
++
++  while (children)
++    {
++      if (GTK_IS_ACCEL_LABEL (children->data))
++        _gtk_accel_label_set_accel_text (children->data, accel_text);
++
++      children = g_list_delete_link (children, children);
++    }
++}
++
+ void
+ gtk_model_menu_item_set_property (GObject *object, guint prop_id,
+                                   const GValue *value, GParamSpec *pspec)
+@@ -314,6 +353,10 @@
+       gtk_model_menu_item_set_accel (item, g_value_get_string (value));
+       break;
+ 
++    case PROP_ACCEL_TEXT:
++      gtk_model_menu_item_set_accel_text (item, g_value_get_string (value));
++      break;
++
+     default:
+       g_assert_not_reached ();
+     }
+@@ -355,6 +398,9 @@
+   g_object_class_install_property (object_class, PROP_ACCEL,
+                                    g_param_spec_string ("accel", "accel", "accel", NULL,
+                                                         G_PARAM_WRITABLE | G_PARAM_STATIC_STRINGS));
++  g_object_class_install_property (object_class, PROP_ACCEL_TEXT,
++                                   g_param_spec_string ("accel-text", "accel-text", "accel-text", NULL,
++                                                        G_PARAM_WRITABLE | G_PARAM_STATIC_STRINGS));
+ }
+ 
+ GtkWidget *
+Index: gtk+3.0-3.10.7/gtk/gtkmenushell.c
+===================================================================
+--- gtk+3.0-3.10.7.orig/gtk/gtkmenushell.c	2014-03-31 10:57:23.969527294 +1300
++++ gtk+3.0-3.10.7/gtk/gtkmenushell.c	2014-03-31 11:09:20.221502015 +1300
+@@ -2192,6 +2192,7 @@
+       g_object_bind_property (item, "role", widget, "action-role", G_BINDING_SYNC_CREATE);
+       g_object_bind_property (item, "toggled", widget, "toggled", G_BINDING_SYNC_CREATE);
+       g_object_bind_property (item, "accel", widget, "accel", G_BINDING_SYNC_CREATE);
++      g_object_bind_property (item, "accel-text", widget, "accel-text", G_BINDING_SYNC_CREATE);
+ 
+       g_signal_connect (widget, "activate", G_CALLBACK (gtk_menu_shell_item_activate), item);
+     }
+Index: gtk+3.0-3.10.7/gtk/gtkaccellabel.c
+===================================================================
+--- gtk+3.0-3.10.7.orig/gtk/gtkaccellabel.c	2014-01-28 11:40:16.000000000 +1300
++++ gtk+3.0-3.10.7/gtk/gtkaccellabel.c	2014-03-31 11:34:42.961448273 +1300
+@@ -107,6 +107,8 @@
+ 
+   guint           accel_key;         /* manual accel key specification if != 0 */
+   GdkModifierType accel_mods;
++
++  gchar         *accel_text;         /* already-translated accel_string */
+ };
+ 
+ static void         gtk_accel_label_set_property (GObject            *object,
+@@ -259,6 +261,7 @@
+   priv->accel_closure = NULL;
+   priv->accel_group = NULL;
+   priv->accel_string = NULL;
++  priv->accel_text = NULL;
+ }
+ 
+ /**
+@@ -300,6 +303,7 @@
+   GtkAccelLabel *accel_label = GTK_ACCEL_LABEL (object);
+ 
+   g_free (accel_label->priv->accel_string);
++  g_free (accel_label->priv->accel_text);
+ 
+   G_OBJECT_CLASS (gtk_accel_label_parent_class)->finalize (object);
+ }
+@@ -902,6 +906,12 @@
+       accel_label->priv->accel_string = NULL;
+     }
+ 
++  if (accel_label->priv->accel_text)
++    {
++      accel_label->priv->accel_string = g_strdup (accel_label->priv->accel_text);
++      return FALSE;
++    }
++
+   g_object_get (gtk_widget_get_settings (GTK_WIDGET (accel_label)),
+                 "gtk-enable-accels", &enable_accels,
+                 NULL);
+@@ -986,3 +996,13 @@
+ 
+   gtk_accel_label_reset (accel_label);
+ }
++
++void
++_gtk_accel_label_set_accel_text (GtkAccelLabel *accel_label,
++                                 const gchar   *accel_text)
++{
++  g_free (accel_label->priv->accel_text);
++  accel_label->priv->accel_text = g_strdup (accel_text);
++
++  gtk_accel_label_reset (accel_label);
++}