X-Git-Url: http://pileus.org/git/?a=blobdiff_plain;f=gtk%2Fgtkaccellabel.c;h=d8bb7e96fa4069247059cc3183863c7fdc3af6ec;hb=fd51c8f5e9d6fb68c8e81b9b1e2ab80931f963f0;hp=37c793dd3a695fe1d73b29a7b4666bb7f33dfdaa;hpb=c7cd3421f72783cd47fb616faad5018aa360b0da;p=~andy%2Fgtk
diff --git a/gtk/gtkaccellabel.c b/gtk/gtkaccellabel.c
index 37c793dd3..d8bb7e96f 100644
--- a/gtk/gtkaccellabel.c
+++ b/gtk/gtkaccellabel.c
@@ -15,9 +15,7 @@
* 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.
+ * License along with this library. If not, see .
*/
/*
@@ -26,14 +24,71 @@
* files for a list of changes. These files are distributed with
* GTK+ at ftp://ftp.gtk.org/pub/gtk/.
*/
+
+#include "config.h"
+#include
+
#include "gtkaccellabel.h"
#include "gtkaccelmap.h"
#include "gtkmain.h"
-#include "gtksignal.h"
+#include "gtksizerequest.h"
+#include "gtkprivate.h"
#include "gtkintl.h"
-#include
-#include
+/**
+ * SECTION:gtkaccellabel
+ * @Short_description: A label which displays an accelerator key on the right of the text
+ * @Title: GtkAccelLabel
+ * @See_also: #GtkAccelGroup
+ *
+ * The #GtkAccelLabel widget is a subclass of #GtkLabel that also displays an
+ * accelerator key on the right of the label text, e.g. 'Ctl+S'.
+ * It is commonly used in menus to show the keyboard short-cuts for commands.
+ *
+ * The accelerator key to display is not set explicitly.
+ * Instead, the #GtkAccelLabel displays the accelerators which have been added to
+ * a particular widget. This widget is set by calling
+ * gtk_accel_label_set_accel_widget().
+ *
+ * For example, a #GtkMenuItem widget may have an accelerator added to emit the
+ * "activate" signal when the 'Ctl+S' key combination is pressed.
+ * A #GtkAccelLabel is created and added to the #GtkMenuItem, and
+ * gtk_accel_label_set_accel_widget() is called with the #GtkMenuItem as the
+ * second argument. The #GtkAccelLabel will now display 'Ctl+S' after its label.
+ *
+ * Note that creating a #GtkMenuItem with gtk_menu_item_new_with_label() (or
+ * one of the similar functions for #GtkCheckMenuItem and #GtkRadioMenuItem)
+ * automatically adds a #GtkAccelLabel to the #GtkMenuItem and calls
+ * gtk_accel_label_set_accel_widget() to set it up for you.
+ *
+ * A #GtkAccelLabel will only display accelerators which have %GTK_ACCEL_VISIBLE
+ * set (see #GtkAccelFlags).
+ * A #GtkAccelLabel can display multiple accelerators and even signal names,
+ * though it is almost always used to display just one accelerator key.
+ *
+ * Creating a simple menu item with an accelerator key.
+ *
+ * GtkWidget *save_item;
+ * GtkAccelGroup *accel_group;
+ *
+ * /* Create a GtkAccelGroup and add it to the window. */
+ * accel_group = gtk_accel_group_new ();
+ * gtk_window_add_accel_group (GTK_WINDOW (window), accel_group);
+ *
+ * /* Create the menu item using the convenience function. */
+ * save_item = gtk_menu_item_new_with_label ("Save");
+ * gtk_widget_show (save_item);
+ * gtk_container_add (GTK_CONTAINER (menu), save_item);
+ *
+ * /* Now add the accelerator to the GtkMenuItem. Note that since we called
+ * gtk_menu_item_new_with_label() to create the GtkMenuItem the
+ * GtkAccelLabel is automatically set up to display the GtkMenuItem
+ * accelerators. We just need to make sure we use GTK_ACCEL_VISIBLE here. */
+ * gtk_widget_add_accelerator (save_item, "activate", accel_group,
+ * GDK_KEY_s, GDK_CONTROL_MASK, GTK_ACCEL_VISIBLE);
+ *
+ *
+ */
enum {
PROP_0,
@@ -41,95 +96,108 @@ enum {
PROP_ACCEL_WIDGET
};
-static void gtk_accel_label_class_init (GtkAccelLabelClass *klass);
-static void gtk_accel_label_init (GtkAccelLabel *accel_label);
-static void gtk_accel_label_set_property (GObject *object,
- guint prop_id,
- const GValue *value,
- GParamSpec *pspec);
-static void gtk_accel_label_get_property (GObject *object,
- guint prop_id,
- GValue *value,
- GParamSpec *pspec);
-static void gtk_accel_label_destroy (GtkObject *object);
-static void gtk_accel_label_finalize (GObject *object);
-static void gtk_accel_label_size_request (GtkWidget *widget,
- GtkRequisition *requisition);
-static gboolean gtk_accel_label_expose_event (GtkWidget *widget,
- GdkEventExpose *event);
-static gboolean gtk_accel_label_refetch_idle (GtkAccelLabel *accel_label);
-
-static GtkAccelLabelClass *accel_label_class = NULL;
-static GtkLabelClass *parent_class = NULL;
-
-
-GtkType
-gtk_accel_label_get_type (void)
+struct _GtkAccelLabelPrivate
{
- static GtkType accel_label_type = 0;
-
- if (!accel_label_type)
- {
- static const GtkTypeInfo accel_label_info =
- {
- "GtkAccelLabel",
- sizeof (GtkAccelLabel),
- sizeof (GtkAccelLabelClass),
- (GtkClassInitFunc) gtk_accel_label_class_init,
- (GtkObjectInitFunc) gtk_accel_label_init,
- /* reserved_1 */ NULL,
- /* reserved_2 */ NULL,
- (GtkClassInitFunc) NULL,
- };
-
- accel_label_type = gtk_type_unique (GTK_TYPE_LABEL, &accel_label_info);
- }
-
- return accel_label_type;
-}
+ GtkWidget *accel_widget; /* done */
+ GClosure *accel_closure; /* has set function */
+ GtkAccelGroup *accel_group; /* set by set_accel_closure() */
+ gchar *accel_string; /* has set function */
+ guint accel_padding; /* should be style property? */
+ guint16 accel_string_width; /* seems to be private */
+
+ guint accel_key; /* manual accel key specification if != 0 */
+ GdkModifierType accel_mods;
+};
+
+static void gtk_accel_label_set_property (GObject *object,
+ guint prop_id,
+ const GValue *value,
+ GParamSpec *pspec);
+static void gtk_accel_label_get_property (GObject *object,
+ guint prop_id,
+ GValue *value,
+ GParamSpec *pspec);
+static void gtk_accel_label_destroy (GtkWidget *widget);
+static void gtk_accel_label_finalize (GObject *object);
+static gboolean gtk_accel_label_draw (GtkWidget *widget,
+ cairo_t *cr);
+static const gchar *gtk_accel_label_get_string (GtkAccelLabel *accel_label);
+
+
+static void gtk_accel_label_get_preferred_width (GtkWidget *widget,
+ gint *min_width,
+ gint *nat_width);
+
+
+G_DEFINE_TYPE (GtkAccelLabel, gtk_accel_label, GTK_TYPE_LABEL)
static void
gtk_accel_label_class_init (GtkAccelLabelClass *class)
{
GObjectClass *gobject_class = G_OBJECT_CLASS (class);
- GtkObjectClass *object_class = GTK_OBJECT_CLASS (class);
GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
- accel_label_class = class;
- parent_class = g_type_class_peek_parent (class);
-
gobject_class->finalize = gtk_accel_label_finalize;
gobject_class->set_property = gtk_accel_label_set_property;
gobject_class->get_property = gtk_accel_label_get_property;
-
- object_class->destroy = gtk_accel_label_destroy;
-
- widget_class->size_request = gtk_accel_label_size_request;
- widget_class->expose_event = gtk_accel_label_expose_event;
+
+ widget_class->draw = gtk_accel_label_draw;
+ widget_class->get_preferred_width = gtk_accel_label_get_preferred_width;
+ widget_class->destroy = gtk_accel_label_destroy;
+
+ gtk_widget_class_set_accessible_role (widget_class, ATK_ROLE_ACCEL_LABEL);
class->signal_quote1 = g_strdup ("<:");
class->signal_quote2 = g_strdup (":>");
- class->mod_name_shift = g_strdup ("Shift");
- class->mod_name_control = g_strdup ("Ctrl");
- class->mod_name_alt = g_strdup ("Alt");
+
+#ifndef GDK_WINDOWING_QUARTZ
+ /* This is the text that should appear next to menu accelerators
+ * that use the shift key. If the text on this key isn't typically
+ * translated on keyboards used for your language, don't translate
+ * this.
+ */
+ class->mod_name_shift = g_strdup (C_("keyboard label", "Shift"));
+ /* This is the text that should appear next to menu accelerators
+ * that use the control key. If the text on this key isn't typically
+ * translated on keyboards used for your language, don't translate
+ * this.
+ */
+ class->mod_name_control = g_strdup (C_("keyboard label", "Ctrl"));
+ /* This is the text that should appear next to menu accelerators
+ * that use the alt key. If the text on this key isn't typically
+ * translated on keyboards used for your language, don't translate
+ * this.
+ */
+ class->mod_name_alt = g_strdup (C_("keyboard label", "Alt"));
class->mod_separator = g_strdup ("+");
- class->accel_seperator = g_strdup (" / ");
- class->latin1_to_char = TRUE;
-
- g_object_class_install_property (G_OBJECT_CLASS (object_class),
+#else /* GDK_WINDOWING_QUARTZ */
+
+ /* U+21E7 UPWARDS WHITE ARROW */
+ class->mod_name_shift = g_strdup ("\xe2\x87\xa7");
+ /* U+2303 UP ARROWHEAD */
+ class->mod_name_control = g_strdup ("\xe2\x8c\x83");
+ /* U+2325 OPTION KEY */
+ class->mod_name_alt = g_strdup ("\xe2\x8c\xa5");
+ class->mod_separator = g_strdup ("");
+
+#endif /* GDK_WINDOWING_QUARTZ */
+
+ g_object_class_install_property (gobject_class,
PROP_ACCEL_CLOSURE,
- g_param_spec_boxed ("accel_closure",
- _("Accelerator Closure"),
- _("The closure to be monitored for accelerator changes"),
+ g_param_spec_boxed ("accel-closure",
+ P_("Accelerator Closure"),
+ P_("The closure to be monitored for accelerator changes"),
G_TYPE_CLOSURE,
- G_PARAM_READABLE | G_PARAM_WRITABLE));
- g_object_class_install_property (G_OBJECT_CLASS (object_class),
+ GTK_PARAM_READWRITE));
+ g_object_class_install_property (gobject_class,
PROP_ACCEL_WIDGET,
- g_param_spec_object ("accel_widget",
- _("Accelerator Widget"),
- _("The widget to be monitored for accelerator changes"),
+ g_param_spec_object ("accel-widget",
+ P_("Accelerator Widget"),
+ P_("The widget to be monitored for accelerator changes"),
GTK_TYPE_WIDGET,
- G_PARAM_READABLE | G_PARAM_WRITABLE));
+ GTK_PARAM_READWRITE));
+
+ g_type_class_add_private (gobject_class, sizeof (GtkAccelLabelPrivate));
}
static void
@@ -169,10 +237,10 @@ gtk_accel_label_get_property (GObject *object,
switch (prop_id)
{
case PROP_ACCEL_CLOSURE:
- g_value_set_boxed (value, accel_label->accel_closure);
+ g_value_set_boxed (value, accel_label->priv->accel_closure);
break;
case PROP_ACCEL_WIDGET:
- g_value_set_object (value, accel_label->accel_widget);
+ g_value_set_object (value, accel_label->priv->accel_widget);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
@@ -183,16 +251,28 @@ gtk_accel_label_get_property (GObject *object,
static void
gtk_accel_label_init (GtkAccelLabel *accel_label)
{
- accel_label->queue_id = 0;
- accel_label->accel_padding = 3;
- accel_label->accel_widget = NULL;
- accel_label->accel_closure = NULL;
- accel_label->accel_group = NULL;
- accel_label->accel_string = NULL;
-
- gtk_accel_label_refetch (accel_label);
+ GtkAccelLabelPrivate *priv;
+
+ accel_label->priv = G_TYPE_INSTANCE_GET_PRIVATE (accel_label,
+ GTK_TYPE_ACCEL_LABEL,
+ GtkAccelLabelPrivate);
+ priv = accel_label->priv;
+
+ priv->accel_padding = 3;
+ priv->accel_widget = NULL;
+ priv->accel_closure = NULL;
+ priv->accel_group = NULL;
+ priv->accel_string = NULL;
}
+/**
+ * gtk_accel_label_new:
+ * @string: the label string. Must be non-%NULL.
+ *
+ * Creates a new #GtkAccelLabel.
+ *
+ * Returns: a new #GtkAccelLabel.
+ */
GtkWidget*
gtk_accel_label_new (const gchar *string)
{
@@ -200,7 +280,7 @@ gtk_accel_label_new (const gchar *string)
g_return_val_if_fail (string != NULL, NULL);
- accel_label = gtk_type_new (GTK_TYPE_ACCEL_LABEL);
+ accel_label = g_object_new (GTK_TYPE_ACCEL_LABEL, NULL);
gtk_label_set_text (GTK_LABEL (accel_label), string);
@@ -208,18 +288,14 @@ gtk_accel_label_new (const gchar *string)
}
static void
-gtk_accel_label_destroy (GtkObject *object)
+gtk_accel_label_destroy (GtkWidget *widget)
{
- GtkAccelLabel *accel_label;
-
- g_return_if_fail (GTK_IS_ACCEL_LABEL (object));
-
- accel_label = GTK_ACCEL_LABEL (object);
+ GtkAccelLabel *accel_label = GTK_ACCEL_LABEL (widget);
gtk_accel_label_set_accel_widget (accel_label, NULL);
gtk_accel_label_set_accel_closure (accel_label, NULL);
-
- GTK_OBJECT_CLASS (parent_class)->destroy (object);
+
+ GTK_WIDGET_CLASS (gtk_accel_label_parent_class)->destroy (widget);
}
static void
@@ -227,14 +303,9 @@ gtk_accel_label_finalize (GObject *object)
{
GtkAccelLabel *accel_label = GTK_ACCEL_LABEL (object);
- if (accel_label->queue_id)
- {
- gtk_idle_remove (accel_label->queue_id);
- accel_label->queue_id = 0;
- }
- g_free (accel_label->accel_string);
-
- G_OBJECT_CLASS (parent_class)->finalize (object);
+ g_free (accel_label->priv->accel_string);
+
+ G_OBJECT_CLASS (gtk_accel_label_parent_class)->finalize (object);
}
/**
@@ -244,105 +315,147 @@ gtk_accel_label_finalize (GObject *object)
* Fetches the widget monitored by this accelerator label. See
* gtk_accel_label_set_accel_widget().
*
- * Return value: the object monitored by the accelerator label,
- * or %NULL.
+ * Returns: (transfer none): the object monitored by the accelerator label, or %NULL.
**/
GtkWidget*
gtk_accel_label_get_accel_widget (GtkAccelLabel *accel_label)
{
g_return_val_if_fail (GTK_IS_ACCEL_LABEL (accel_label), NULL);
- return accel_label->accel_widget;
+ return accel_label->priv->accel_widget;
}
+/**
+ * gtk_accel_label_get_accel_width:
+ * @accel_label: a #GtkAccelLabel.
+ *
+ * Returns the width needed to display the accelerator key(s).
+ * This is used by menus to align all of the #GtkMenuItem widgets, and shouldn't
+ * be needed by applications.
+ *
+ * Returns: the width needed to display the accelerator key(s).
+ */
guint
gtk_accel_label_get_accel_width (GtkAccelLabel *accel_label)
{
g_return_val_if_fail (GTK_IS_ACCEL_LABEL (accel_label), 0);
-
- return (accel_label->accel_string_width +
- (accel_label->accel_string_width ? accel_label->accel_padding : 0));
+
+ return (accel_label->priv->accel_string_width +
+ (accel_label->priv->accel_string_width ? accel_label->priv->accel_padding : 0));
}
static void
-gtk_accel_label_size_request (GtkWidget *widget,
- GtkRequisition *requisition)
+gtk_accel_label_get_preferred_width (GtkWidget *widget,
+ gint *min_width,
+ gint *nat_width)
{
- GtkAccelLabel *accel_label;
- PangoLayout *layout;
- gint width;
-
- g_return_if_fail (GTK_IS_ACCEL_LABEL (widget));
- g_return_if_fail (requisition != NULL);
-
- accel_label = GTK_ACCEL_LABEL (widget);
-
- if (GTK_WIDGET_CLASS (parent_class)->size_request)
- GTK_WIDGET_CLASS (parent_class)->size_request (widget, requisition);
+ GtkAccelLabel *accel_label = GTK_ACCEL_LABEL (widget);
+ PangoLayout *layout;
+ gint width;
+
+ GTK_WIDGET_CLASS (gtk_accel_label_parent_class)->get_preferred_width (widget, min_width, nat_width);
- layout = gtk_widget_create_pango_layout (widget, accel_label->accel_string);
+ layout = gtk_widget_create_pango_layout (GTK_WIDGET (widget),
+ gtk_accel_label_get_string (accel_label));
pango_layout_get_pixel_size (layout, &width, NULL);
- accel_label->accel_string_width = width;
-
- g_object_unref (G_OBJECT (layout));
+ accel_label->priv->accel_string_width = width;
+
+ g_object_unref (layout);
+}
+
+static gint
+get_first_baseline (PangoLayout *layout)
+{
+ PangoLayoutIter *iter;
+ gint result;
+
+ iter = pango_layout_get_iter (layout);
+ result = pango_layout_iter_get_baseline (iter);
+ pango_layout_iter_free (iter);
+
+ return PANGO_PIXELS (result);
}
static gboolean
-gtk_accel_label_expose_event (GtkWidget *widget,
- GdkEventExpose *event)
+gtk_accel_label_draw (GtkWidget *widget,
+ cairo_t *cr)
{
- GtkMisc *misc;
- GtkAccelLabel *accel_label;
- PangoLayout *layout;
-
- g_return_val_if_fail (GTK_IS_ACCEL_LABEL (widget), FALSE);
- g_return_val_if_fail (event != NULL, FALSE);
-
- accel_label = GTK_ACCEL_LABEL (widget);
- misc = GTK_MISC (accel_label);
-
- if (GTK_WIDGET_DRAWABLE (accel_label))
+ GtkAccelLabel *accel_label = GTK_ACCEL_LABEL (widget);
+ GtkMisc *misc = GTK_MISC (accel_label);
+ GtkTextDirection direction;
+ guint ac_width;
+ GtkAllocation allocation;
+ GtkRequisition requisition;
+
+ direction = gtk_widget_get_direction (widget);
+ ac_width = gtk_accel_label_get_accel_width (accel_label);
+ gtk_widget_get_allocation (widget, &allocation);
+ gtk_widget_get_preferred_size (widget, NULL, &requisition);
+
+ if (allocation.width >= requisition.width + ac_width)
{
- guint ac_width;
+ GtkStyleContext *context;
+ PangoLayout *label_layout;
+ PangoLayout *accel_layout;
+ GtkLabel *label = GTK_LABEL (widget);
+
+ gint x;
+ gint y;
+ gint xpad;
+
+ context = gtk_widget_get_style_context (widget);
+ label_layout = gtk_label_get_layout (GTK_LABEL (accel_label));
+
+ cairo_save (cr);
+
+ /* XXX: Mad hack: We modify the label's width so it renders
+ * properly in its draw function that we chain to. */
+ if (direction == GTK_TEXT_DIR_RTL)
+ cairo_translate (cr, ac_width, 0);
+ if (gtk_label_get_ellipsize (label))
+ pango_layout_set_width (label_layout,
+ pango_layout_get_width (label_layout)
+ - ac_width * PANGO_SCALE);
- ac_width = gtk_accel_label_get_accel_width (accel_label);
-
- if (widget->allocation.width >= widget->requisition.width + ac_width)
- {
- guint x;
- guint y;
-
- widget->allocation.width -= ac_width;
- if (GTK_WIDGET_CLASS (parent_class)->expose_event)
- GTK_WIDGET_CLASS (parent_class)->expose_event (widget, event);
- widget->allocation.width += ac_width;
-
- x = widget->allocation.x + widget->allocation.width - misc->xpad - ac_width;
-
- y = (widget->allocation.y * (1.0 - misc->yalign) +
- (widget->allocation.y + widget->allocation.height -
- (widget->requisition.height - misc->ypad * 2)) *
- misc->yalign) + 1.5;
-
- layout = gtk_widget_create_pango_layout (widget, accel_label->accel_string);
-
- gtk_paint_layout (widget->style,
- widget->window,
- GTK_WIDGET_STATE (widget),
- FALSE,
- &event->area,
- widget,
- "accellabel",
- x, y,
- layout);
-
- g_object_unref (G_OBJECT (layout));
- }
+ allocation.width -= ac_width;
+ gtk_widget_set_allocation (widget, &allocation);
+ if (GTK_WIDGET_CLASS (gtk_accel_label_parent_class)->draw)
+ GTK_WIDGET_CLASS (gtk_accel_label_parent_class)->draw (widget,
+ cr);
+ allocation.width += ac_width;
+ gtk_widget_set_allocation (widget, &allocation);
+ if (gtk_label_get_ellipsize (label))
+ pango_layout_set_width (label_layout,
+ pango_layout_get_width (label_layout)
+ + ac_width * PANGO_SCALE);
+
+ cairo_restore (cr);
+
+ gtk_misc_get_padding (misc, &xpad, NULL);
+
+ if (direction == GTK_TEXT_DIR_RTL)
+ x = xpad;
else
- {
- if (GTK_WIDGET_CLASS (parent_class)->expose_event)
- GTK_WIDGET_CLASS (parent_class)->expose_event (widget, event);
- }
+ x = gtk_widget_get_allocated_width (widget) - xpad - ac_width;
+
+ gtk_label_get_layout_offsets (GTK_LABEL (accel_label), NULL, &y);
+
+ accel_layout = gtk_widget_create_pango_layout (widget, gtk_accel_label_get_string (accel_label));
+
+ y += get_first_baseline (label_layout) - get_first_baseline (accel_layout) - allocation.y;
+
+ gtk_style_context_save (context);
+ gtk_style_context_add_class (context, GTK_STYLE_CLASS_ACCELERATOR);
+
+ gtk_render_layout (context, cr, x, y, accel_layout);
+ gtk_style_context_restore (context);
+
+ g_object_unref (accel_layout);
+ }
+ else
+ {
+ if (GTK_WIDGET_CLASS (gtk_accel_label_parent_class)->draw)
+ GTK_WIDGET_CLASS (gtk_accel_label_parent_class)->draw (widget, cr);
}
return FALSE;
@@ -355,9 +468,9 @@ refetch_widget_accel_closure (GtkAccelLabel *accel_label)
GList *clist, *list;
g_return_if_fail (GTK_IS_ACCEL_LABEL (accel_label));
- g_return_if_fail (GTK_IS_WIDGET (accel_label->accel_widget));
+ g_return_if_fail (GTK_IS_WIDGET (accel_label->priv->accel_widget));
- clist = gtk_widget_list_accel_closures (accel_label->accel_widget);
+ clist = gtk_widget_list_accel_closures (accel_label->priv->accel_widget);
for (list = clist; list; list = list->next)
{
/* we just take the first closure used */
@@ -368,46 +481,70 @@ refetch_widget_accel_closure (GtkAccelLabel *accel_label)
gtk_accel_label_set_accel_closure (accel_label, closure);
}
+static void
+accel_widget_weak_ref_cb (GtkAccelLabel *accel_label,
+ GtkWidget *old_accel_widget)
+{
+ g_return_if_fail (GTK_IS_ACCEL_LABEL (accel_label));
+ g_return_if_fail (GTK_IS_WIDGET (accel_label->priv->accel_widget));
+
+ g_signal_handlers_disconnect_by_func (accel_label->priv->accel_widget,
+ refetch_widget_accel_closure,
+ accel_label);
+ accel_label->priv->accel_widget = NULL;
+ g_object_notify (G_OBJECT (accel_label), "accel-widget");
+}
+
+/**
+ * gtk_accel_label_set_accel_widget:
+ * @accel_label: a #GtkAccelLabel
+ * @accel_widget: the widget to be monitored.
+ *
+ * Sets the widget to be monitored by this accelerator label.
+ */
void
gtk_accel_label_set_accel_widget (GtkAccelLabel *accel_label,
- GtkWidget *accel_widget)
+ GtkWidget *accel_widget)
{
g_return_if_fail (GTK_IS_ACCEL_LABEL (accel_label));
if (accel_widget)
g_return_if_fail (GTK_IS_WIDGET (accel_widget));
-
- if (accel_widget != accel_label->accel_widget)
+
+ if (accel_widget != accel_label->priv->accel_widget)
{
- if (accel_label->accel_widget)
- {
- gtk_accel_label_set_accel_closure (accel_label, NULL);
- g_signal_handlers_disconnect_by_func (accel_label->accel_widget,
- G_CALLBACK (refetch_widget_accel_closure),
- accel_label);
- g_object_unref (accel_label->accel_widget);
- }
- accel_label->accel_widget = accel_widget;
- if (accel_label->accel_widget)
- {
- g_object_ref (accel_label->accel_widget);
- g_signal_connect_object (accel_label->accel_widget, "accel_closures_changed",
- G_CALLBACK (refetch_widget_accel_closure),
- accel_label, G_CONNECT_SWAPPED);
- refetch_widget_accel_closure (accel_label);
- }
- g_object_notify (G_OBJECT (accel_label), "accel_widget");
+ if (accel_label->priv->accel_widget)
+ {
+ gtk_accel_label_set_accel_closure (accel_label, NULL);
+ g_signal_handlers_disconnect_by_func (accel_label->priv->accel_widget,
+ refetch_widget_accel_closure,
+ accel_label);
+ g_object_weak_unref (G_OBJECT (accel_label->priv->accel_widget),
+ (GWeakNotify) accel_widget_weak_ref_cb, accel_label);
+ }
+ accel_label->priv->accel_widget = accel_widget;
+ if (accel_label->priv->accel_widget)
+ {
+ g_object_weak_ref (G_OBJECT (accel_label->priv->accel_widget),
+ (GWeakNotify) accel_widget_weak_ref_cb, accel_label);
+ g_signal_connect_object (accel_label->priv->accel_widget, "accel-closures-changed",
+ G_CALLBACK (refetch_widget_accel_closure),
+ accel_label, G_CONNECT_SWAPPED);
+ refetch_widget_accel_closure (accel_label);
+ }
+ g_object_notify (G_OBJECT (accel_label), "accel-widget");
}
}
static void
-gtk_accel_label_queue_refetch (GtkAccelLabel *accel_label)
+gtk_accel_label_reset (GtkAccelLabel *accel_label)
{
- g_return_if_fail (GTK_IS_ACCEL_LABEL (accel_label));
-
- if (accel_label->queue_id == 0)
- accel_label->queue_id = gtk_idle_add_priority (G_PRIORITY_HIGH_IDLE,
- (GtkFunction) gtk_accel_label_refetch_idle,
- accel_label);
+ if (accel_label->priv->accel_string)
+ {
+ g_free (accel_label->priv->accel_string);
+ accel_label->priv->accel_string = NULL;
+ }
+
+ gtk_widget_queue_resize (GTK_WIDGET (accel_label));
}
static void
@@ -417,10 +554,18 @@ check_accel_changed (GtkAccelGroup *accel_group,
GClosure *accel_closure,
GtkAccelLabel *accel_label)
{
- if (accel_closure == accel_label->accel_closure)
- gtk_accel_label_queue_refetch (accel_label);
+ if (accel_closure == accel_label->priv->accel_closure)
+ gtk_accel_label_reset (accel_label);
}
+/**
+ * gtk_accel_label_set_accel_closure:
+ * @accel_label: a #GtkAccelLabel
+ * @accel_closure: the closure to monitor for accelerator changes.
+ *
+ * Sets the closure to be monitored by this accelerator label. The closure
+ * must be connected to an accelerator group; see gtk_accel_group_connect().
+ **/
void
gtk_accel_label_set_accel_closure (GtkAccelLabel *accel_label,
GClosure *accel_closure)
@@ -429,142 +574,419 @@ gtk_accel_label_set_accel_closure (GtkAccelLabel *accel_label,
if (accel_closure)
g_return_if_fail (gtk_accel_group_from_accel_closure (accel_closure) != NULL);
- if (accel_closure != accel_label->accel_closure)
+ if (accel_closure != accel_label->priv->accel_closure)
{
- if (accel_label->accel_closure)
+ if (accel_label->priv->accel_closure)
{
- g_signal_handlers_disconnect_by_func (accel_label->accel_group,
- G_CALLBACK (check_accel_changed),
+ g_signal_handlers_disconnect_by_func (accel_label->priv->accel_group,
+ check_accel_changed,
accel_label);
- accel_label->accel_group = NULL;
- g_closure_unref (accel_label->accel_closure);
+ accel_label->priv->accel_group = NULL;
+ g_closure_unref (accel_label->priv->accel_closure);
}
- accel_label->accel_closure = accel_closure;
- if (accel_label->accel_closure)
+ accel_label->priv->accel_closure = accel_closure;
+ if (accel_label->priv->accel_closure)
{
- g_closure_ref (accel_label->accel_closure);
- accel_label->accel_group = gtk_accel_group_from_accel_closure (accel_closure);
- g_signal_connect_object (accel_label->accel_group, "accel_changed",
+ g_closure_ref (accel_label->priv->accel_closure);
+ accel_label->priv->accel_group = gtk_accel_group_from_accel_closure (accel_closure);
+ g_signal_connect_object (accel_label->priv->accel_group, "accel-changed",
G_CALLBACK (check_accel_changed),
accel_label, 0);
}
- gtk_accel_label_queue_refetch (accel_label);
- g_object_notify (G_OBJECT (accel_label), "accel_closure");
+ gtk_accel_label_reset (accel_label);
+ g_object_notify (G_OBJECT (accel_label), "accel-closure");
}
}
static gboolean
-gtk_accel_label_refetch_idle (GtkAccelLabel *accel_label)
+find_accel (GtkAccelKey *key,
+ GClosure *closure,
+ gpointer data)
{
- gboolean retval;
+ return data == (gpointer) closure;
+}
- GDK_THREADS_ENTER ();
- retval = gtk_accel_label_refetch (accel_label);
- GDK_THREADS_LEAVE ();
+static const gchar *
+gtk_accel_label_get_string (GtkAccelLabel *accel_label)
+{
+ if (!accel_label->priv->accel_string)
+ gtk_accel_label_refetch (accel_label);
+
+ return accel_label->priv->accel_string;
+}
+
+/* Underscores in key names are better displayed as spaces
+ * E.g., Page_Up should be "Page Up".
+ *
+ * Some keynames also have prefixes that are not suitable
+ * for display, e.g XF86AudioMute, so strip those out, too.
+ *
+ * This function is only called on untranslated keynames,
+ * so no need to be UTF-8 safe.
+ */
+static void
+append_without_underscores (GString *s,
+ gchar *str)
+{
+ gchar *p;
- return retval;
+ if (g_str_has_prefix (str, "XF86"))
+ p = str + 4;
+ else if (g_str_has_prefix (str, "ISO_"))
+ p = str + 4;
+ else
+ p = str;
+
+ for ( ; *p; p++)
+ {
+ if (*p == '_')
+ g_string_append_c (s, ' ');
+ else
+ g_string_append_c (s, *p);
+ }
}
+/* On Mac, if the key has symbolic representation (e.g. arrow keys),
+ * append it to gstring and return TRUE; otherwise return FALSE.
+ * See http://docs.info.apple.com/article.html?path=Mac/10.5/en/cdb_symbs.html
+ * for the list of special keys. */
static gboolean
-find_accel (GtkAccelKey *key,
- GClosure *closure,
- gpointer data)
+append_keyval_symbol (guint accelerator_key,
+ GString *gstring)
{
- return data == (gpointer) closure;
+#ifdef GDK_WINDOWING_QUARTZ
+ switch (accelerator_key)
+ {
+ case GDK_KEY_Return:
+ /* U+21A9 LEFTWARDS ARROW WITH HOOK */
+ g_string_append (gstring, "\xe2\x86\xa9");
+ return TRUE;
+
+ case GDK_KEY_ISO_Enter:
+ /* U+2324 UP ARROWHEAD BETWEEN TWO HORIZONTAL BARS */
+ g_string_append (gstring, "\xe2\x8c\xa4");
+ return TRUE;
+
+ case GDK_KEY_Left:
+ /* U+2190 LEFTWARDS ARROW */
+ g_string_append (gstring, "\xe2\x86\x90");
+ return TRUE;
+
+ case GDK_KEY_Up:
+ /* U+2191 UPWARDS ARROW */
+ g_string_append (gstring, "\xe2\x86\x91");
+ return TRUE;
+
+ case GDK_KEY_Right:
+ /* U+2192 RIGHTWARDS ARROW */
+ g_string_append (gstring, "\xe2\x86\x92");
+ return TRUE;
+
+ case GDK_KEY_Down:
+ /* U+2193 DOWNWARDS ARROW */
+ g_string_append (gstring, "\xe2\x86\x93");
+ return TRUE;
+
+ case GDK_KEY_Page_Up:
+ /* U+21DE UPWARDS ARROW WITH DOUBLE STROKE */
+ g_string_append (gstring, "\xe2\x87\x9e");
+ return TRUE;
+
+ case GDK_KEY_Page_Down:
+ /* U+21DF DOWNWARDS ARROW WITH DOUBLE STROKE */
+ g_string_append (gstring, "\xe2\x87\x9f");
+ return TRUE;
+
+ case GDK_KEY_Home:
+ /* U+2196 NORTH WEST ARROW */
+ g_string_append (gstring, "\xe2\x86\x96");
+ return TRUE;
+
+ case GDK_KEY_End:
+ /* U+2198 SOUTH EAST ARROW */
+ g_string_append (gstring, "\xe2\x86\x98");
+ return TRUE;
+
+ case GDK_KEY_Escape:
+ /* U+238B BROKEN CIRCLE WITH NORTHWEST ARROW */
+ g_string_append (gstring, "\xe2\x8e\x8b");
+ return TRUE;
+
+ case GDK_KEY_BackSpace:
+ /* U+232B ERASE TO THE LEFT */
+ g_string_append (gstring, "\xe2\x8c\xab");
+ return TRUE;
+
+ case GDK_KEY_Delete:
+ /* U+2326 ERASE TO THE RIGHT */
+ g_string_append (gstring, "\xe2\x8c\xa6");
+ return TRUE;
+
+ default:
+ return FALSE;
+ }
+#else /* !GDK_WINDOWING_QUARTZ */
+ return FALSE;
+#endif
}
-gboolean
-gtk_accel_label_refetch (GtkAccelLabel *accel_label)
+gchar *
+_gtk_accel_label_class_get_accelerator_label (GtkAccelLabelClass *klass,
+ guint accelerator_key,
+ GdkModifierType accelerator_mods)
{
- GtkAccelLabelClass *class;
- gchar *utf8;
+ GString *gstring;
+ gboolean seen_mod = FALSE;
+ gunichar ch;
+
+ gstring = g_string_new ("");
+
+ if (accelerator_mods & GDK_SHIFT_MASK)
+ {
+ g_string_append (gstring, klass->mod_name_shift);
+ seen_mod = TRUE;
+ }
+ if (accelerator_mods & GDK_CONTROL_MASK)
+ {
+ if (seen_mod)
+ g_string_append (gstring, klass->mod_separator);
+ g_string_append (gstring, klass->mod_name_control);
+ seen_mod = TRUE;
+ }
+ if (accelerator_mods & GDK_MOD1_MASK)
+ {
+ if (seen_mod)
+ g_string_append (gstring, klass->mod_separator);
+ g_string_append (gstring, klass->mod_name_alt);
+ seen_mod = TRUE;
+ }
+ if (accelerator_mods & GDK_MOD2_MASK)
+ {
+ if (seen_mod)
+ g_string_append (gstring, klass->mod_separator);
- g_return_val_if_fail (GTK_IS_ACCEL_LABEL (accel_label), FALSE);
+ g_string_append (gstring, "Mod2");
+ seen_mod = TRUE;
+ }
+ if (accelerator_mods & GDK_MOD3_MASK)
+ {
+ if (seen_mod)
+ g_string_append (gstring, klass->mod_separator);
- class = GTK_ACCEL_LABEL_GET_CLASS (accel_label);
+ g_string_append (gstring, "Mod3");
+ seen_mod = TRUE;
+ }
+ if (accelerator_mods & GDK_MOD4_MASK)
+ {
+ if (seen_mod)
+ g_string_append (gstring, klass->mod_separator);
- g_free (accel_label->accel_string);
- accel_label->accel_string = NULL;
+ g_string_append (gstring, "Mod4");
+ seen_mod = TRUE;
+ }
+ if (accelerator_mods & GDK_MOD5_MASK)
+ {
+ if (seen_mod)
+ g_string_append (gstring, klass->mod_separator);
- if (accel_label->accel_closure)
+ g_string_append (gstring, "Mod5");
+ seen_mod = TRUE;
+ }
+ if (accelerator_mods & GDK_SUPER_MASK)
+ {
+ if (seen_mod)
+ g_string_append (gstring, klass->mod_separator);
+
+ /* This is the text that should appear next to menu accelerators
+ * that use the super key. If the text on this key isn't typically
+ * translated on keyboards used for your language, don't translate
+ * this.
+ */
+ g_string_append (gstring, C_("keyboard label", "Super"));
+ seen_mod = TRUE;
+ }
+ if (accelerator_mods & GDK_HYPER_MASK)
+ {
+ if (seen_mod)
+ g_string_append (gstring, klass->mod_separator);
+
+ /* This is the text that should appear next to menu accelerators
+ * that use the hyper key. If the text on this key isn't typically
+ * translated on keyboards used for your language, don't translate
+ * this.
+ */
+ g_string_append (gstring, C_("keyboard label", "Hyper"));
+ seen_mod = TRUE;
+ }
+ if (accelerator_mods & GDK_META_MASK)
{
- GtkAccelKey *key = gtk_accel_group_find (accel_label->accel_group, find_accel, accel_label->accel_closure);
+ if (seen_mod)
+ g_string_append (gstring, klass->mod_separator);
+
+#ifndef GDK_WINDOWING_QUARTZ
+ /* This is the text that should appear next to menu accelerators
+ * that use the meta key. If the text on this key isn't typically
+ * translated on keyboards used for your language, don't translate
+ * this.
+ */
+ g_string_append (gstring, C_("keyboard label", "Meta"));
+#else
+ /* Command key symbol U+2318 PLACE OF INTEREST SIGN */
+ g_string_append (gstring, "\xe2\x8c\x98");
+#endif
+ seen_mod = TRUE;
+ }
+
+ ch = gdk_keyval_to_unicode (accelerator_key);
+ if (ch && ch < 0x80 && (g_unichar_isgraph (ch) || ch == ' '))
+ {
+ if (seen_mod)
+ g_string_append (gstring, klass->mod_separator);
- if (key && key->accel_flags & GTK_ACCEL_VISIBLE)
+ switch (ch)
{
- GString *gstring;
- gboolean seen_mod = FALSE;
-
- gstring = g_string_new (accel_label->accel_string);
- g_string_append (gstring, gstring->len ? class->accel_seperator : " ");
-
- if (key->accel_mods & GDK_SHIFT_MASK)
- {
- g_string_append (gstring, class->mod_name_shift);
- seen_mod = TRUE;
- }
- if (key->accel_mods & GDK_CONTROL_MASK)
- {
- if (seen_mod)
- g_string_append (gstring, class->mod_separator);
- g_string_append (gstring, class->mod_name_control);
- seen_mod = TRUE;
- }
- if (key->accel_mods & GDK_MOD1_MASK)
- {
- if (seen_mod)
- g_string_append (gstring, class->mod_separator);
- g_string_append (gstring, class->mod_name_alt);
- seen_mod = TRUE;
- }
- if (seen_mod)
- g_string_append (gstring, class->mod_separator);
- if (key->accel_key < 0x80 ||
- (key->accel_key > 0x80 &&
- key->accel_key <= 0xff &&
- class->latin1_to_char))
- {
- switch (key->accel_key)
- {
- case ' ':
- g_string_append (gstring, "Space");
- break;
- case '\\':
- g_string_append (gstring, "Backslash");
- break;
- default:
- g_string_append_unichar (gstring, toupper (key->accel_key));
- break;
- }
- }
+ case ' ':
+ g_string_append (gstring, C_("keyboard label", "Space"));
+ break;
+ case '\\':
+ g_string_append (gstring, C_("keyboard label", "Backslash"));
+ break;
+ default:
+ g_string_append_unichar (gstring, g_unichar_toupper (ch));
+ break;
+ }
+ }
+ else if (!append_keyval_symbol (accelerator_key, gstring))
+ {
+ gchar *tmp;
+
+ tmp = gdk_keyval_name (gdk_keyval_to_lower (accelerator_key));
+ if (tmp != NULL)
+ {
+ if (seen_mod)
+ g_string_append (gstring, klass->mod_separator);
+
+ if (tmp[0] != 0 && tmp[1] == 0)
+ g_string_append_c (gstring, g_ascii_toupper (tmp[0]));
else
{
- gchar *tmp;
-
- tmp = gtk_accelerator_name (key->accel_key, 0);
- if (tmp[0] != 0 && tmp[1] == 0)
- tmp[0] = toupper (tmp[0]);
- g_string_append (gstring, tmp);
- g_free (tmp);
+ const gchar *str;
+ str = g_dpgettext2 (GETTEXT_PACKAGE, "keyboard label", tmp);
+ if (str == tmp)
+ append_without_underscores (gstring, tmp);
+ else
+ g_string_append (gstring, str);
}
- g_free (accel_label->accel_string);
- accel_label->accel_string = gstring->str;
- g_string_free (gstring, FALSE);
}
- if (!accel_label->accel_string)
- accel_label->accel_string = g_strdup ("-/-");
}
-
- if (!accel_label->accel_string)
- accel_label->accel_string = g_strdup ("");
- if (accel_label->queue_id)
+ return g_string_free (gstring, FALSE);
+}
+
+/**
+ * gtk_accel_label_refetch:
+ * @accel_label: a #GtkAccelLabel.
+ *
+ * Recreates the string representing the accelerator keys.
+ * This should not be needed since the string is automatically updated whenever
+ * accelerators are added or removed from the associated widget.
+ *
+ * Returns: always returns %FALSE.
+ */
+gboolean
+gtk_accel_label_refetch (GtkAccelLabel *accel_label)
+{
+ gboolean enable_accels;
+
+ g_return_val_if_fail (GTK_IS_ACCEL_LABEL (accel_label), FALSE);
+
+ if (accel_label->priv->accel_string)
{
- gtk_idle_remove (accel_label->queue_id);
- accel_label->queue_id = 0;
+ g_free (accel_label->priv->accel_string);
+ accel_label->priv->accel_string = NULL;
+ }
+
+ g_object_get (gtk_widget_get_settings (GTK_WIDGET (accel_label)),
+ "gtk-enable-accels", &enable_accels,
+ NULL);
+
+ if (enable_accels && (accel_label->priv->accel_closure || accel_label->priv->accel_key))
+ {
+ gboolean have_accel = FALSE;
+ guint accel_key;
+ GdkModifierType accel_mods;
+
+ /* First check for a manual accel set with _set_accel() */
+ if (accel_label->priv->accel_key)
+ {
+ accel_mods = accel_label->priv->accel_mods;
+ accel_key = accel_label->priv->accel_key;
+ have_accel = TRUE;
+ }
+
+ /* If we don't have a hardcoded value, check the accel group */
+ if (!have_accel)
+ {
+ GtkAccelKey *key;
+
+ key = gtk_accel_group_find (accel_label->priv->accel_group, find_accel, accel_label->priv->accel_closure);
+
+ if (key && key->accel_flags & GTK_ACCEL_VISIBLE)
+ {
+ accel_key = key->accel_key;
+ accel_mods = key->accel_mods;
+ have_accel = TRUE;
+ }
+ }
+
+ /* If we found a key using either method, set it */
+ if (have_accel)
+ {
+ GtkAccelLabelClass *klass;
+ gchar *tmp;
+
+ klass = GTK_ACCEL_LABEL_GET_CLASS (accel_label);
+ tmp = _gtk_accel_label_class_get_accelerator_label (klass, accel_key, accel_mods);
+ accel_label->priv->accel_string = g_strconcat (" ", tmp, NULL);
+ g_free (tmp);
+ }
+
+ else
+ /* Otherwise we have a closure with no key. Show "-/-". */
+ accel_label->priv->accel_string = g_strdup ("-/-");
}
+ if (!accel_label->priv->accel_string)
+ accel_label->priv->accel_string = g_strdup ("");
+
gtk_widget_queue_resize (GTK_WIDGET (accel_label));
return FALSE;
}
+
+/**
+ * gtk_accel_label_set_accel:
+ * @accel_label: a #GtkAccelLabel
+ * @accelerator_key: a keyval, or 0
+ * @accelerator_mods: the modifier mask for the accel
+ *
+ * Manually sets a keyval and modifier mask as the accelerator rendered
+ * by @accel_label.
+ *
+ * If a keyval and modifier are explicitly set then these values are
+ * used regardless of any associated accel closure or widget.
+ *
+ * Providing an @accelerator_key of 0 removes the manual setting.
+ *
+ * Since: 3.6
+ */
+void
+gtk_accel_label_set_accel (GtkAccelLabel *accel_label,
+ guint accelerator_key,
+ GdkModifierType accelerator_mods)
+{
+ accel_label->priv->accel_key = accelerator_key;
+ accel_label->priv->accel_mods = accelerator_mods;
+
+ gtk_accel_label_reset (accel_label);
+}