1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * GtkAccelLabel: GtkLabel with accelerator monitoring facilities.
5 * Copyright (C) 1998 Tim Janik
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
24 * Modified by the GTK+ Team and others 1997-2001. See the AUTHORS
25 * file for a list of people on the GTK+ Team. See the ChangeLog
26 * files for a list of changes. These files are distributed with
27 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
32 #include "gtkaccellabel.h"
33 #include "gtkaccelmap.h"
43 static void gtk_accel_label_class_init (GtkAccelLabelClass *klass);
44 static void gtk_accel_label_init (GtkAccelLabel *accel_label);
45 static void gtk_accel_label_set_property (GObject *object,
49 static void gtk_accel_label_get_property (GObject *object,
53 static void gtk_accel_label_destroy (GtkObject *object);
54 static void gtk_accel_label_finalize (GObject *object);
55 static void gtk_accel_label_size_request (GtkWidget *widget,
56 GtkRequisition *requisition);
57 static gboolean gtk_accel_label_expose_event (GtkWidget *widget,
58 GdkEventExpose *event);
59 static gboolean gtk_accel_label_refetch_idle (GtkAccelLabel *accel_label);
61 static GtkLabelClass *parent_class = NULL;
65 gtk_accel_label_get_type (void)
67 static GType accel_label_type = 0;
69 if (!accel_label_type)
71 static const GTypeInfo accel_label_info =
73 sizeof (GtkAccelLabelClass),
75 NULL, /* base_finalize */
76 (GClassInitFunc) gtk_accel_label_class_init,
77 NULL, /* class_finalize */
78 NULL, /* class_data */
79 sizeof (GtkAccelLabel),
81 (GInstanceInitFunc) gtk_accel_label_init,
85 g_type_register_static (GTK_TYPE_LABEL, "GtkAccelLabel",
86 &accel_label_info, 0);
89 return accel_label_type;
93 gtk_accel_label_class_init (GtkAccelLabelClass *class)
95 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
96 GtkObjectClass *object_class = GTK_OBJECT_CLASS (class);
97 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (class);
99 parent_class = g_type_class_peek_parent (class);
101 gobject_class->finalize = gtk_accel_label_finalize;
102 gobject_class->set_property = gtk_accel_label_set_property;
103 gobject_class->get_property = gtk_accel_label_get_property;
105 object_class->destroy = gtk_accel_label_destroy;
107 widget_class->size_request = gtk_accel_label_size_request;
108 widget_class->expose_event = gtk_accel_label_expose_event;
110 class->signal_quote1 = g_strdup ("<:");
111 class->signal_quote2 = g_strdup (":>");
112 /* This is the text that should appear next to menu accelerators
113 * that use the shift key. If the text on this key isn't typically
114 * translated on keyboards used for your language, don't translate
117 class->mod_name_shift = g_strdup (_("Shift"));
118 /* This is the text that should appear next to menu accelerators
119 * that use the control key. If the text on this key isn't typically
120 * translated on keyboards used for your language, don't translate
123 class->mod_name_control = g_strdup (_("Ctrl"));
124 /* This is the text that should appear next to menu accelerators
125 * that use the alt key. If the text on this key isn't typically
126 * translated on keyboards used for your language, don't translate
129 class->mod_name_alt = g_strdup (_("Alt"));
130 class->mod_separator = g_strdup ("+");
131 class->accel_seperator = g_strdup (" / ");
132 class->latin1_to_char = TRUE;
134 g_object_class_install_property (gobject_class,
136 g_param_spec_boxed ("accel_closure",
137 _("Accelerator Closure"),
138 _("The closure to be monitored for accelerator changes"),
140 G_PARAM_READABLE | G_PARAM_WRITABLE));
141 g_object_class_install_property (gobject_class,
143 g_param_spec_object ("accel_widget",
144 _("Accelerator Widget"),
145 _("The widget to be monitored for accelerator changes"),
147 G_PARAM_READABLE | G_PARAM_WRITABLE));
151 gtk_accel_label_set_property (GObject *object,
156 GtkAccelLabel *accel_label;
158 accel_label = GTK_ACCEL_LABEL (object);
162 case PROP_ACCEL_CLOSURE:
163 gtk_accel_label_set_accel_closure (accel_label, g_value_get_boxed (value));
165 case PROP_ACCEL_WIDGET:
166 gtk_accel_label_set_accel_widget (accel_label, g_value_get_object (value));
169 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
175 gtk_accel_label_get_property (GObject *object,
180 GtkAccelLabel *accel_label;
182 accel_label = GTK_ACCEL_LABEL (object);
186 case PROP_ACCEL_CLOSURE:
187 g_value_set_boxed (value, accel_label->accel_closure);
189 case PROP_ACCEL_WIDGET:
190 g_value_set_object (value, accel_label->accel_widget);
193 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
199 gtk_accel_label_init (GtkAccelLabel *accel_label)
201 accel_label->queue_id = 0;
202 accel_label->accel_padding = 3;
203 accel_label->accel_widget = NULL;
204 accel_label->accel_closure = NULL;
205 accel_label->accel_group = NULL;
206 accel_label->accel_string = NULL;
208 gtk_accel_label_refetch (accel_label);
212 gtk_accel_label_new (const gchar *string)
214 GtkAccelLabel *accel_label;
216 g_return_val_if_fail (string != NULL, NULL);
218 accel_label = g_object_new (GTK_TYPE_ACCEL_LABEL, NULL);
220 gtk_label_set_text (GTK_LABEL (accel_label), string);
222 return GTK_WIDGET (accel_label);
226 gtk_accel_label_destroy (GtkObject *object)
228 GtkAccelLabel *accel_label = GTK_ACCEL_LABEL (object);
230 gtk_accel_label_set_accel_widget (accel_label, NULL);
231 gtk_accel_label_set_accel_closure (accel_label, NULL);
233 GTK_OBJECT_CLASS (parent_class)->destroy (object);
237 gtk_accel_label_finalize (GObject *object)
239 GtkAccelLabel *accel_label = GTK_ACCEL_LABEL (object);
241 if (accel_label->queue_id)
243 gtk_idle_remove (accel_label->queue_id);
244 accel_label->queue_id = 0;
246 g_free (accel_label->accel_string);
248 G_OBJECT_CLASS (parent_class)->finalize (object);
252 * gtk_accel_label_get_accel_widget:
253 * @accel_label: a #GtkAccelLabel
255 * Fetches the widget monitored by this accelerator label. See
256 * gtk_accel_label_set_accel_widget().
258 * Return value: the object monitored by the accelerator label,
262 gtk_accel_label_get_accel_widget (GtkAccelLabel *accel_label)
264 g_return_val_if_fail (GTK_IS_ACCEL_LABEL (accel_label), NULL);
266 return accel_label->accel_widget;
270 gtk_accel_label_get_accel_width (GtkAccelLabel *accel_label)
272 g_return_val_if_fail (GTK_IS_ACCEL_LABEL (accel_label), 0);
274 return (accel_label->accel_string_width +
275 (accel_label->accel_string_width ? accel_label->accel_padding : 0));
279 gtk_accel_label_size_request (GtkWidget *widget,
280 GtkRequisition *requisition)
282 GtkAccelLabel *accel_label = GTK_ACCEL_LABEL (widget);
286 if (GTK_WIDGET_CLASS (parent_class)->size_request)
287 GTK_WIDGET_CLASS (parent_class)->size_request (widget, requisition);
289 layout = gtk_widget_create_pango_layout (widget, accel_label->accel_string);
290 pango_layout_get_pixel_size (layout, &width, NULL);
291 accel_label->accel_string_width = width;
293 g_object_unref (layout);
297 gtk_accel_label_expose_event (GtkWidget *widget,
298 GdkEventExpose *event)
300 GtkAccelLabel *accel_label = GTK_ACCEL_LABEL (widget);
301 GtkMisc *misc = GTK_MISC (accel_label);
304 if (GTK_WIDGET_DRAWABLE (accel_label))
308 ac_width = gtk_accel_label_get_accel_width (accel_label);
310 if (widget->allocation.width >= widget->requisition.width + ac_width)
315 widget->allocation.width -= ac_width;
316 if (GTK_WIDGET_CLASS (parent_class)->expose_event)
317 GTK_WIDGET_CLASS (parent_class)->expose_event (widget, event);
318 widget->allocation.width += ac_width;
320 x = widget->allocation.x + widget->allocation.width - misc->xpad - ac_width;
322 y = (widget->allocation.y * (1.0 - misc->yalign) +
323 (widget->allocation.y + widget->allocation.height -
324 (widget->requisition.height - misc->ypad * 2)) *
327 layout = gtk_widget_create_pango_layout (widget, accel_label->accel_string);
329 gtk_paint_layout (widget->style,
331 GTK_WIDGET_STATE (widget),
339 g_object_unref (layout);
343 if (GTK_WIDGET_CLASS (parent_class)->expose_event)
344 GTK_WIDGET_CLASS (parent_class)->expose_event (widget, event);
352 refetch_widget_accel_closure (GtkAccelLabel *accel_label)
354 GClosure *closure = NULL;
357 g_return_if_fail (GTK_IS_ACCEL_LABEL (accel_label));
358 g_return_if_fail (GTK_IS_WIDGET (accel_label->accel_widget));
360 clist = gtk_widget_list_accel_closures (accel_label->accel_widget);
361 for (list = clist; list; list = list->next)
363 /* we just take the first closure used */
364 closure = list->data;
368 gtk_accel_label_set_accel_closure (accel_label, closure);
372 * gtk_accel_label_set_accel_widget:
373 * @accel_label: a #GtkAccelLabel
374 * @accel_widget: the widget to be monitored.
376 * Sets the widget to be monitored by this accelerator label.
379 gtk_accel_label_set_accel_widget (GtkAccelLabel *accel_label,
380 GtkWidget *accel_widget)
382 g_return_if_fail (GTK_IS_ACCEL_LABEL (accel_label));
384 g_return_if_fail (GTK_IS_WIDGET (accel_widget));
386 if (accel_widget != accel_label->accel_widget)
388 if (accel_label->accel_widget)
390 gtk_accel_label_set_accel_closure (accel_label, NULL);
391 g_signal_handlers_disconnect_by_func (accel_label->accel_widget,
392 refetch_widget_accel_closure,
394 g_object_unref (accel_label->accel_widget);
396 accel_label->accel_widget = accel_widget;
397 if (accel_label->accel_widget)
399 g_object_ref (accel_label->accel_widget);
400 g_signal_connect_object (accel_label->accel_widget, "accel_closures_changed",
401 G_CALLBACK (refetch_widget_accel_closure),
402 accel_label, G_CONNECT_SWAPPED);
403 refetch_widget_accel_closure (accel_label);
405 g_object_notify (G_OBJECT (accel_label), "accel_widget");
410 gtk_accel_label_queue_refetch (GtkAccelLabel *accel_label)
412 g_return_if_fail (GTK_IS_ACCEL_LABEL (accel_label));
414 if (accel_label->queue_id == 0)
415 accel_label->queue_id = gtk_idle_add_priority (G_PRIORITY_HIGH_IDLE,
416 (GtkFunction) gtk_accel_label_refetch_idle,
421 check_accel_changed (GtkAccelGroup *accel_group,
423 GdkModifierType modifier,
424 GClosure *accel_closure,
425 GtkAccelLabel *accel_label)
427 if (accel_closure == accel_label->accel_closure)
428 gtk_accel_label_queue_refetch (accel_label);
432 * gtk_accel_label_set_accel_closure:
433 * @accel_label: a #GtkAccelLabel
434 * @accel_closure: the closure to monitor for accelerator changes.
436 * Sets the closure to be monitored by this accelerator label. The closure
437 * must be connected to an accelerator group; see gtk_accel_group_connect().
440 gtk_accel_label_set_accel_closure (GtkAccelLabel *accel_label,
441 GClosure *accel_closure)
443 g_return_if_fail (GTK_IS_ACCEL_LABEL (accel_label));
445 g_return_if_fail (gtk_accel_group_from_accel_closure (accel_closure) != NULL);
447 if (accel_closure != accel_label->accel_closure)
449 if (accel_label->accel_closure)
451 g_signal_handlers_disconnect_by_func (accel_label->accel_group,
454 accel_label->accel_group = NULL;
455 g_closure_unref (accel_label->accel_closure);
457 accel_label->accel_closure = accel_closure;
458 if (accel_label->accel_closure)
460 g_closure_ref (accel_label->accel_closure);
461 accel_label->accel_group = gtk_accel_group_from_accel_closure (accel_closure);
462 g_signal_connect_object (accel_label->accel_group, "accel_changed",
463 G_CALLBACK (check_accel_changed),
466 gtk_accel_label_queue_refetch (accel_label);
467 g_object_notify (G_OBJECT (accel_label), "accel_closure");
472 gtk_accel_label_refetch_idle (GtkAccelLabel *accel_label)
476 GDK_THREADS_ENTER ();
477 retval = gtk_accel_label_refetch (accel_label);
478 GDK_THREADS_LEAVE ();
484 find_accel (GtkAccelKey *key,
488 return data == (gpointer) closure;
492 gtk_accel_label_refetch (GtkAccelLabel *accel_label)
494 GtkAccelLabelClass *class;
496 g_return_val_if_fail (GTK_IS_ACCEL_LABEL (accel_label), FALSE);
498 class = GTK_ACCEL_LABEL_GET_CLASS (accel_label);
500 g_free (accel_label->accel_string);
501 accel_label->accel_string = NULL;
503 if (accel_label->accel_closure)
505 GtkAccelKey *key = gtk_accel_group_find (accel_label->accel_group, find_accel, accel_label->accel_closure);
507 if (key && key->accel_flags & GTK_ACCEL_VISIBLE)
510 gboolean seen_mod = FALSE;
513 gstring = g_string_new (accel_label->accel_string);
514 g_string_append (gstring, gstring->len ? class->accel_seperator : " ");
516 if (key->accel_mods & GDK_SHIFT_MASK)
518 g_string_append (gstring, class->mod_name_shift);
521 if (key->accel_mods & GDK_CONTROL_MASK)
524 g_string_append (gstring, class->mod_separator);
525 g_string_append (gstring, class->mod_name_control);
528 if (key->accel_mods & GDK_MOD1_MASK)
531 g_string_append (gstring, class->mod_separator);
532 g_string_append (gstring, class->mod_name_alt);
536 g_string_append (gstring, class->mod_separator);
538 ch = gdk_keyval_to_unicode (key->accel_key);
539 if (ch && (g_unichar_isgraph (ch) || ch == ' ') &&
540 (ch < 0x80 || class->latin1_to_char))
545 g_string_append (gstring, "Space");
548 g_string_append (gstring, "Backslash");
551 g_string_append_unichar (gstring, g_unichar_toupper (ch));
559 tmp = gtk_accelerator_name (key->accel_key, 0);
560 if (tmp[0] != 0 && tmp[1] == 0)
561 tmp[0] = g_ascii_toupper (tmp[0]);
562 g_string_append (gstring, tmp);
565 g_free (accel_label->accel_string);
566 accel_label->accel_string = gstring->str;
567 g_string_free (gstring, FALSE);
569 if (!accel_label->accel_string)
570 accel_label->accel_string = g_strdup ("-/-");
573 if (!accel_label->accel_string)
574 accel_label->accel_string = g_strdup ("");
576 if (accel_label->queue_id)
578 gtk_idle_remove (accel_label->queue_id);
579 accel_label->queue_id = 0;
582 gtk_widget_queue_resize (GTK_WIDGET (accel_label));