1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1998, 2001 Tim Janik
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
21 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
22 * file for a list of people on the GTK+ Team. See the ChangeLog
23 * files for a list of changes. These files are distributed with
24 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
31 #include "gtkaccelgroup.h"
32 #include "gtkaccelgroupprivate.h"
33 #include "gtkaccellabel.h" /* For _gtk_accel_label_class_get_accelerator_label */
34 #include "gtkaccelmap.h"
36 #include "gtkmain.h" /* For _gtk_boolean_handled_accumulator */
37 #include "gdk/gdkkeysyms.h"
38 #include "gtkmarshalers.h"
42 * SECTION:gtkaccelgroup
43 * @Short_description: Groups of global keyboard accelerators for an entire GtkWindow
44 * @Title: Accelerator Groups
45 * @See_also:gtk_window_add_accel_group(), gtk_accel_map_change_entry(),
46 * gtk_item_factory_new(), gtk_label_new_with_mnemonic()
48 * A #GtkAccelGroup represents a group of keyboard accelerators,
49 * typically attached to a toplevel #GtkWindow (with
50 * gtk_window_add_accel_group()). Usually you won't need to create a
51 * #GtkAccelGroup directly; instead, when using #GtkItemFactory, GTK+
52 * automatically sets up the accelerators for your menus in the item
53 * factory's #GtkAccelGroup.
56 * Note that <firstterm>accelerators</firstterm> are different from
57 * <firstterm>mnemonics</firstterm>. Accelerators are shortcuts for
58 * activating a menu item; they appear alongside the menu item they're a
59 * shortcut for. For example "Ctrl+Q" might appear alongside the "Quit"
60 * menu item. Mnemonics are shortcuts for GUI elements such as text
61 * entries or buttons; they appear as underlined characters. See
62 * gtk_label_new_with_mnemonic(). Menu items can have both accelerators
63 * and mnemonics, of course.
66 #define GTK_ACCEL_GROUP_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), GTK_TYPE_ACCEL_GROUP, GtkAccelGroupPrivate))
68 /* --- prototypes --- */
69 static void gtk_accel_group_finalize (GObject *object);
70 static void gtk_accel_group_get_property (GObject *object,
74 static void accel_closure_invalidate (gpointer data,
78 /* --- variables --- */
79 static guint signal_accel_activate = 0;
80 static guint signal_accel_changed = 0;
81 static guint quark_acceleratable_groups = 0;
82 static guint default_accel_mod_mask = (GDK_SHIFT_MASK |
96 G_DEFINE_TYPE (GtkAccelGroup, gtk_accel_group, G_TYPE_OBJECT)
98 /* --- functions --- */
100 gtk_accel_group_class_init (GtkAccelGroupClass *class)
102 GObjectClass *object_class = G_OBJECT_CLASS (class);
104 quark_acceleratable_groups = g_quark_from_static_string ("gtk-acceleratable-accel-groups");
106 object_class->finalize = gtk_accel_group_finalize;
107 object_class->get_property = gtk_accel_group_get_property;
109 class->accel_changed = NULL;
111 g_object_class_install_property (object_class,
113 g_param_spec_boolean ("is-locked",
115 "Is the accel group locked",
119 g_object_class_install_property (object_class,
121 g_param_spec_flags ("modifier-mask",
124 GDK_TYPE_MODIFIER_TYPE,
125 default_accel_mod_mask,
129 * GtkAccelGroup::accel-activate:
130 * @accel_group: the #GtkAccelGroup which received the signal
131 * @acceleratable: the object on which the accelerator was activated
132 * @keyval: the accelerator keyval
133 * @modifier: the modifier combination of the accelerator
135 * The accel-activate signal is an implementation detail of
136 * #GtkAccelGroup and not meant to be used by applications.
138 * Returns: %TRUE if the accelerator was activated
140 signal_accel_activate =
141 g_signal_new (I_("accel-activate"),
142 G_OBJECT_CLASS_TYPE (class),
145 _gtk_boolean_handled_accumulator, NULL,
146 _gtk_marshal_BOOLEAN__OBJECT_UINT_FLAGS,
150 GDK_TYPE_MODIFIER_TYPE);
152 * GtkAccelGroup::accel-changed:
153 * @accel_group: the #GtkAccelGroup which received the signal
154 * @keyval: the accelerator keyval
155 * @modifier: the modifier combination of the accelerator
156 * @accel_closure: the #GClosure of the accelerator
158 * The accel-changed signal is emitted when a #GtkAccelGroupEntry
159 * is added to or removed from the accel group.
161 * Widgets like #GtkAccelLabel which display an associated
162 * accelerator should connect to this signal, and rebuild
163 * their visual representation if the @accel_closure is theirs.
165 signal_accel_changed =
166 g_signal_new (I_("accel-changed"),
167 G_OBJECT_CLASS_TYPE (class),
168 G_SIGNAL_RUN_FIRST | G_SIGNAL_DETAILED,
169 G_STRUCT_OFFSET (GtkAccelGroupClass, accel_changed),
171 _gtk_marshal_VOID__UINT_FLAGS_BOXED,
174 GDK_TYPE_MODIFIER_TYPE,
177 g_type_class_add_private (object_class, sizeof (GtkAccelGroupPrivate));
181 gtk_accel_group_finalize (GObject *object)
183 GtkAccelGroup *accel_group = GTK_ACCEL_GROUP (object);
186 for (i = 0; i < accel_group->priv->n_accels; i++)
188 GtkAccelGroupEntry *entry = &accel_group->priv->priv_accels[i];
190 if (entry->accel_path_quark)
192 const gchar *accel_path = g_quark_to_string (entry->accel_path_quark);
194 _gtk_accel_map_remove_group (accel_path, accel_group);
196 g_closure_remove_invalidate_notifier (entry->closure, accel_group, accel_closure_invalidate);
198 /* remove quick_accel_add() refcount */
199 g_closure_unref (entry->closure);
202 g_free (accel_group->priv->priv_accels);
204 G_OBJECT_CLASS (gtk_accel_group_parent_class)->finalize (object);
208 gtk_accel_group_get_property (GObject *object,
213 GtkAccelGroup *accel_group = GTK_ACCEL_GROUP (object);
218 g_value_set_boolean (value, accel_group->priv->lock_count > 0);
220 case PROP_MODIFIER_MASK:
221 g_value_set_flags (value, accel_group->priv->modifier_mask);
224 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
230 gtk_accel_group_init (GtkAccelGroup *accel_group)
232 GtkAccelGroupPrivate *priv = GTK_ACCEL_GROUP_GET_PRIVATE (accel_group);
234 priv->lock_count = 0;
235 priv->modifier_mask = gtk_accelerator_get_default_mod_mask ();
236 priv->acceleratables = NULL;
238 priv->priv_accels = NULL;
240 accel_group->priv = priv;
244 * gtk_accel_group_new:
245 * @returns: a new #GtkAccelGroup object
247 * Creates a new #GtkAccelGroup.
250 gtk_accel_group_new (void)
252 return g_object_new (GTK_TYPE_ACCEL_GROUP, NULL);
256 * gtk_accel_group_get_is_locked:
257 * @accel_group: a #GtkAccelGroup
259 * Locks are added and removed using gtk_accel_group_lock() and
260 * gtk_accel_group_unlock().
262 * Returns: %TRUE if there are 1 or more locks on the @accel_group,
268 gtk_accel_group_get_is_locked (GtkAccelGroup *accel_group)
270 g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), FALSE);
272 return accel_group->priv->lock_count > 0;
276 * gtk_accel_group_get_modifier_mask:
277 * @accel_group: a #GtkAccelGroup
279 * Gets a #GdkModifierType representing the mask for this
280 * @accel_group. For example, #GDK_CONTROL_MASK, #GDK_SHIFT_MASK, etc.
282 * Returns: the modifier mask for this accel group.
287 gtk_accel_group_get_modifier_mask (GtkAccelGroup *accel_group)
289 g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), 0);
291 return accel_group->priv->modifier_mask;
295 accel_group_weak_ref_detach (GSList *free_list,
296 GObject *stale_object)
300 for (slist = free_list; slist; slist = slist->next)
302 GtkAccelGroup *accel_group;
304 accel_group = slist->data;
305 accel_group->priv->acceleratables = g_slist_remove (accel_group->priv->acceleratables, stale_object);
306 g_object_unref (accel_group);
308 g_slist_free (free_list);
309 g_object_set_qdata (stale_object, quark_acceleratable_groups, NULL);
313 _gtk_accel_group_attach (GtkAccelGroup *accel_group,
318 g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
319 g_return_if_fail (G_IS_OBJECT (object));
320 g_return_if_fail (g_slist_find (accel_group->priv->acceleratables, object) == NULL);
322 g_object_ref (accel_group);
323 accel_group->priv->acceleratables = g_slist_prepend (accel_group->priv->acceleratables, object);
324 slist = g_object_get_qdata (object, quark_acceleratable_groups);
326 g_object_weak_unref (object,
327 (GWeakNotify) accel_group_weak_ref_detach,
329 slist = g_slist_prepend (slist, accel_group);
330 g_object_set_qdata (object, quark_acceleratable_groups, slist);
331 g_object_weak_ref (object,
332 (GWeakNotify) accel_group_weak_ref_detach,
337 _gtk_accel_group_detach (GtkAccelGroup *accel_group,
342 g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
343 g_return_if_fail (G_IS_OBJECT (object));
344 g_return_if_fail (g_slist_find (accel_group->priv->acceleratables, object) != NULL);
346 accel_group->priv->acceleratables = g_slist_remove (accel_group->priv->acceleratables, object);
347 slist = g_object_get_qdata (object, quark_acceleratable_groups);
348 g_object_weak_unref (object,
349 (GWeakNotify) accel_group_weak_ref_detach,
351 slist = g_slist_remove (slist, accel_group);
352 g_object_set_qdata (object, quark_acceleratable_groups, slist);
354 g_object_weak_ref (object,
355 (GWeakNotify) accel_group_weak_ref_detach,
357 g_object_unref (accel_group);
361 * gtk_accel_groups_from_object:
362 * @object: a #GObject, usually a #GtkWindow
364 * Gets a list of all accel groups which are attached to @object.
366 * Returns: (element-type GtkAccelGroup) (transfer none): a list of all accel groups which are attached to @object
369 gtk_accel_groups_from_object (GObject *object)
371 g_return_val_if_fail (G_IS_OBJECT (object), NULL);
373 return g_object_get_qdata (object, quark_acceleratable_groups);
377 * gtk_accel_group_find:
378 * @accel_group: a #GtkAccelGroup
379 * @find_func: a function to filter the entries of @accel_group with
380 * @data: data to pass to @find_func
381 * @returns: the key of the first entry passing @find_func. The key is
382 * owned by GTK+ and must not be freed.
384 * Finds the first entry in an accelerator group for which
385 * @find_func returns %TRUE and returns its #GtkAccelKey.
389 gtk_accel_group_find (GtkAccelGroup *accel_group,
390 GtkAccelGroupFindFunc find_func,
393 GtkAccelKey *key = NULL;
396 g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), NULL);
397 g_return_val_if_fail (find_func != NULL, NULL);
399 g_object_ref (accel_group);
400 for (i = 0; i < accel_group->priv->n_accels; i++)
401 if (find_func (&accel_group->priv->priv_accels[i].key,
402 accel_group->priv->priv_accels[i].closure,
405 key = &accel_group->priv->priv_accels[i].key;
408 g_object_unref (accel_group);
414 * gtk_accel_group_lock:
415 * @accel_group: a #GtkAccelGroup
417 * Locks the given accelerator group.
419 * Locking an acelerator group prevents the accelerators contained
420 * within it to be changed during runtime. Refer to
421 * gtk_accel_map_change_entry() about runtime accelerator changes.
423 * If called more than once, @accel_group remains locked until
424 * gtk_accel_group_unlock() has been called an equivalent number
428 gtk_accel_group_lock (GtkAccelGroup *accel_group)
430 g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
432 accel_group->priv->lock_count += 1;
434 if (accel_group->priv->lock_count == 1) {
435 /* State change from unlocked to locked */
436 g_object_notify (G_OBJECT (accel_group), "is-locked");
441 * gtk_accel_group_unlock:
442 * @accel_group: a #GtkAccelGroup
444 * Undoes the last call to gtk_accel_group_lock() on this @accel_group.
447 gtk_accel_group_unlock (GtkAccelGroup *accel_group)
449 g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
450 g_return_if_fail (accel_group->priv->lock_count > 0);
452 accel_group->priv->lock_count -= 1;
454 if (accel_group->priv->lock_count < 1) {
455 /* State change from locked to unlocked */
456 g_object_notify (G_OBJECT (accel_group), "is-locked");
461 accel_closure_invalidate (gpointer data,
464 GtkAccelGroup *accel_group = GTK_ACCEL_GROUP (data);
466 gtk_accel_group_disconnect (accel_group, closure);
470 bsearch_compare_accels (const void *d1,
473 const GtkAccelGroupEntry *entry1 = d1;
474 const GtkAccelGroupEntry *entry2 = d2;
476 if (entry1->key.accel_key == entry2->key.accel_key)
477 return entry1->key.accel_mods < entry2->key.accel_mods ? -1 : entry1->key.accel_mods > entry2->key.accel_mods;
479 return entry1->key.accel_key < entry2->key.accel_key ? -1 : 1;
483 quick_accel_add (GtkAccelGroup *accel_group,
485 GdkModifierType accel_mods,
486 GtkAccelFlags accel_flags,
490 guint pos, i = accel_group->priv->n_accels++;
491 GtkAccelGroupEntry key;
494 key.key.accel_key = accel_key;
495 key.key.accel_mods = accel_mods;
496 for (pos = 0; pos < i; pos++)
497 if (bsearch_compare_accels (&key, accel_group->priv->priv_accels + pos) < 0)
500 /* insert at position, ref closure */
501 accel_group->priv->priv_accels = g_renew (GtkAccelGroupEntry, accel_group->priv->priv_accels, accel_group->priv->n_accels);
502 g_memmove (accel_group->priv->priv_accels + pos + 1, accel_group->priv->priv_accels + pos,
503 (i - pos) * sizeof (accel_group->priv->priv_accels[0]));
504 accel_group->priv->priv_accels[pos].key.accel_key = accel_key;
505 accel_group->priv->priv_accels[pos].key.accel_mods = accel_mods;
506 accel_group->priv->priv_accels[pos].key.accel_flags = accel_flags;
507 accel_group->priv->priv_accels[pos].closure = g_closure_ref (closure);
508 accel_group->priv->priv_accels[pos].accel_path_quark = path_quark;
509 g_closure_sink (closure);
511 /* handle closure invalidation and reverse lookups */
512 g_closure_add_invalidate_notifier (closure, accel_group, accel_closure_invalidate);
514 /* get accel path notification */
516 _gtk_accel_map_add_group (g_quark_to_string (path_quark), accel_group);
518 /* connect and notify changed */
521 gchar *accel_name = gtk_accelerator_name (accel_key, accel_mods);
522 GQuark accel_quark = g_quark_from_string (accel_name);
527 g_signal_connect_closure_by_id (accel_group, signal_accel_activate, accel_quark, closure, FALSE);
530 g_signal_emit (accel_group, signal_accel_changed, accel_quark, accel_key, accel_mods, closure);
535 quick_accel_remove (GtkAccelGroup *accel_group,
538 GQuark accel_quark = 0;
539 GtkAccelGroupEntry *entry = accel_group->priv->priv_accels + pos;
540 guint accel_key = entry->key.accel_key;
541 GdkModifierType accel_mods = entry->key.accel_mods;
542 GClosure *closure = entry->closure;
544 /* quark for notification */
547 gchar *accel_name = gtk_accelerator_name (accel_key, accel_mods);
549 accel_quark = g_quark_from_string (accel_name);
553 /* clean up closure invalidate notification and disconnect */
554 g_closure_remove_invalidate_notifier (entry->closure, accel_group, accel_closure_invalidate);
556 g_signal_handlers_disconnect_matched (accel_group,
557 G_SIGNAL_MATCH_ID | G_SIGNAL_MATCH_DETAIL | G_SIGNAL_MATCH_CLOSURE,
558 signal_accel_activate, accel_quark,
559 closure, NULL, NULL);
560 /* clean up accel path notification */
561 if (entry->accel_path_quark)
562 _gtk_accel_map_remove_group (g_quark_to_string (entry->accel_path_quark), accel_group);
564 /* physically remove */
565 accel_group->priv->n_accels -= 1;
566 g_memmove (entry, entry + 1,
567 (accel_group->priv->n_accels - pos) * sizeof (accel_group->priv->priv_accels[0]));
571 g_signal_emit (accel_group, signal_accel_changed, accel_quark, accel_key, accel_mods, closure);
573 /* remove quick_accel_add() refcount */
574 g_closure_unref (closure);
577 static GtkAccelGroupEntry*
578 quick_accel_find (GtkAccelGroup *accel_group,
580 GdkModifierType accel_mods,
583 GtkAccelGroupEntry *entry;
584 GtkAccelGroupEntry key;
588 if (!accel_group->priv->n_accels)
591 key.key.accel_key = accel_key;
592 key.key.accel_mods = accel_mods;
593 entry = bsearch (&key, accel_group->priv->priv_accels, accel_group->priv->n_accels,
594 sizeof (accel_group->priv->priv_accels[0]), bsearch_compare_accels);
599 /* step back to the first member */
600 for (; entry > accel_group->priv->priv_accels; entry--)
601 if (entry[-1].key.accel_key != accel_key ||
602 entry[-1].key.accel_mods != accel_mods)
604 /* count equal members */
605 for (; entry + *count_p < accel_group->priv->priv_accels + accel_group->priv->n_accels; (*count_p)++)
606 if (entry[*count_p].key.accel_key != accel_key ||
607 entry[*count_p].key.accel_mods != accel_mods)
613 * gtk_accel_group_connect:
614 * @accel_group: the accelerator group to install an accelerator in
615 * @accel_key: key value of the accelerator
616 * @accel_mods: modifier combination of the accelerator
617 * @accel_flags: a flag mask to configure this accelerator
618 * @closure: closure to be executed upon accelerator activation
620 * Installs an accelerator in this group. When @accel_group is being activated
621 * in response to a call to gtk_accel_groups_activate(), @closure will be
622 * invoked if the @accel_key and @accel_mods from gtk_accel_groups_activate()
623 * match those of this connection.
625 * The signature used for the @closure is that of #GtkAccelGroupActivate.
627 * Note that, due to implementation details, a single closure can only be
628 * connected to one accelerator group.
631 gtk_accel_group_connect (GtkAccelGroup *accel_group,
633 GdkModifierType accel_mods,
634 GtkAccelFlags accel_flags,
637 g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
638 g_return_if_fail (closure != NULL);
639 g_return_if_fail (accel_key > 0);
640 g_return_if_fail (gtk_accel_group_from_accel_closure (closure) == NULL);
642 g_object_ref (accel_group);
643 if (!closure->is_invalid)
644 quick_accel_add (accel_group,
645 gdk_keyval_to_lower (accel_key),
646 accel_mods, accel_flags, closure, 0);
647 g_object_unref (accel_group);
651 * gtk_accel_group_connect_by_path:
652 * @accel_group: the accelerator group to install an accelerator in
653 * @accel_path: path used for determining key and modifiers.
654 * @closure: closure to be executed upon accelerator activation
656 * Installs an accelerator in this group, using an accelerator path to look
657 * up the appropriate key and modifiers (see gtk_accel_map_add_entry()).
658 * When @accel_group is being activated in response to a call to
659 * gtk_accel_groups_activate(), @closure will be invoked if the @accel_key and
660 * @accel_mods from gtk_accel_groups_activate() match the key and modifiers
663 * The signature used for the @closure is that of #GtkAccelGroupActivate.
665 * Note that @accel_path string will be stored in a #GQuark. Therefore, if you
666 * pass a static string, you can save some memory by interning it first with
667 * g_intern_static_string().
670 gtk_accel_group_connect_by_path (GtkAccelGroup *accel_group,
671 const gchar *accel_path,
675 GdkModifierType accel_mods = 0;
678 g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
679 g_return_if_fail (closure != NULL);
680 g_return_if_fail (_gtk_accel_path_is_valid (accel_path));
682 if (closure->is_invalid)
685 g_object_ref (accel_group);
687 if (gtk_accel_map_lookup_entry (accel_path, &key))
689 accel_key = gdk_keyval_to_lower (key.accel_key);
690 accel_mods = key.accel_mods;
693 quick_accel_add (accel_group, accel_key, accel_mods, GTK_ACCEL_VISIBLE, closure,
694 g_quark_from_string (accel_path));
696 g_object_unref (accel_group);
700 * gtk_accel_group_disconnect:
701 * @accel_group: the accelerator group to remove an accelerator from
702 * @closure: (allow-none): the closure to remove from this accelerator group, or %NULL
703 * to remove all closures
704 * @returns: %TRUE if the closure was found and got disconnected
706 * Removes an accelerator previously installed through
707 * gtk_accel_group_connect().
709 * Since 2.20 @closure can be %NULL.
712 gtk_accel_group_disconnect (GtkAccelGroup *accel_group,
717 g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), FALSE);
719 for (i = 0; i < accel_group->priv->n_accels; i++)
720 if (accel_group->priv->priv_accels[i].closure == closure)
722 g_object_ref (accel_group);
723 quick_accel_remove (accel_group, i);
724 g_object_unref (accel_group);
731 * gtk_accel_group_disconnect_key:
732 * @accel_group: the accelerator group to install an accelerator in
733 * @accel_key: key value of the accelerator
734 * @accel_mods: modifier combination of the accelerator
735 * @returns: %TRUE if there was an accelerator which could be
736 * removed, %FALSE otherwise
738 * Removes an accelerator previously installed through
739 * gtk_accel_group_connect().
742 gtk_accel_group_disconnect_key (GtkAccelGroup *accel_group,
744 GdkModifierType accel_mods)
746 GtkAccelGroupEntry *entries;
747 GSList *slist, *clist = NULL;
748 gboolean removed_one = FALSE;
751 g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), FALSE);
753 g_object_ref (accel_group);
755 accel_key = gdk_keyval_to_lower (accel_key);
756 entries = quick_accel_find (accel_group, accel_key, accel_mods, &n);
759 GClosure *closure = g_closure_ref (entries[n].closure);
761 clist = g_slist_prepend (clist, closure);
764 for (slist = clist; slist; slist = slist->next)
766 GClosure *closure = slist->data;
768 removed_one |= gtk_accel_group_disconnect (accel_group, closure);
769 g_closure_unref (closure);
771 g_slist_free (clist);
773 g_object_unref (accel_group);
779 _gtk_accel_group_reconnect (GtkAccelGroup *accel_group,
780 GQuark accel_path_quark)
782 GSList *slist, *clist = NULL;
785 g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
787 g_object_ref (accel_group);
789 for (i = 0; i < accel_group->priv->n_accels; i++)
790 if (accel_group->priv->priv_accels[i].accel_path_quark == accel_path_quark)
792 GClosure *closure = g_closure_ref (accel_group->priv->priv_accels[i].closure);
794 clist = g_slist_prepend (clist, closure);
797 for (slist = clist; slist; slist = slist->next)
799 GClosure *closure = slist->data;
801 gtk_accel_group_disconnect (accel_group, closure);
802 gtk_accel_group_connect_by_path (accel_group, g_quark_to_string (accel_path_quark), closure);
803 g_closure_unref (closure);
805 g_slist_free (clist);
807 g_object_unref (accel_group);
811 _gtk_accel_group_get_accelerables (GtkAccelGroup *accel_group)
813 g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), NULL);
815 return accel_group->priv->acceleratables;
819 * gtk_accel_group_query:
820 * @accel_group: the accelerator group to query
821 * @accel_key: key value of the accelerator
822 * @accel_mods: modifier combination of the accelerator
823 * @n_entries: (allow-none): location to return the number of entries found, or %NULL
824 * @returns: (allow-none): an array of @n_entries #GtkAccelGroupEntry elements, or %NULL. The array is owned by GTK+ and must not be freed.
826 * Queries an accelerator group for all entries matching @accel_key and
830 gtk_accel_group_query (GtkAccelGroup *accel_group,
832 GdkModifierType accel_mods,
835 GtkAccelGroupEntry *entries;
838 g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), NULL);
840 entries = quick_accel_find (accel_group, gdk_keyval_to_lower (accel_key), accel_mods, &n);
843 *n_entries = entries ? n : 0;
849 * gtk_accel_group_from_accel_closure:
850 * @closure: a #GClosure
851 * @returns: (allow-none): the #GtkAccelGroup to which @closure is connected, or %NULL.
853 * Finds the #GtkAccelGroup to which @closure is connected;
854 * see gtk_accel_group_connect().
857 gtk_accel_group_from_accel_closure (GClosure *closure)
861 g_return_val_if_fail (closure != NULL, NULL);
863 /* a few remarks on what we do here. in general, we need a way to reverse lookup
864 * accel_groups from closures that are being used in accel groups. this could
865 * be done e.g via a hashtable. it is however cheaper (memory wise) to just
866 * use the invalidation notifier on the closure itself (which we need to install
867 * anyway), that contains the accel group as data which, besides needing to peek
868 * a bit at closure internals, works just as good.
870 for (i = 0; i < G_CLOSURE_N_NOTIFIERS (closure); i++)
871 if (closure->notifiers[i].notify == accel_closure_invalidate)
872 return closure->notifiers[i].data;
878 * gtk_accel_group_activate:
879 * @accel_group: a #GtkAccelGroup
880 * @accel_quark: the quark for the accelerator name
881 * @acceleratable: the #GObject, usually a #GtkWindow, on which
882 * to activate the accelerator.
883 * @accel_key: accelerator keyval from a key event
884 * @accel_mods: keyboard state mask from a key event
886 * Finds the first accelerator in @accel_group
887 * that matches @accel_key and @accel_mods, and
890 * Returns: %TRUE if an accelerator was activated and handled this keypress
893 gtk_accel_group_activate (GtkAccelGroup *accel_group,
895 GObject *acceleratable,
897 GdkModifierType accel_mods)
899 gboolean was_handled;
901 g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), FALSE);
902 g_return_val_if_fail (G_IS_OBJECT (acceleratable), FALSE);
905 g_signal_emit (accel_group, signal_accel_activate, accel_quark,
906 acceleratable, accel_key, accel_mods, &was_handled);
912 * gtk_accel_groups_activate:
913 * @object: the #GObject, usually a #GtkWindow, on which
914 * to activate the accelerator.
915 * @accel_key: accelerator keyval from a key event
916 * @accel_mods: keyboard state mask from a key event
918 * Finds the first accelerator in any #GtkAccelGroup attached
919 * to @object that matches @accel_key and @accel_mods, and
920 * activates that accelerator.
922 * Returns: %TRUE if an accelerator was activated and handled this keypress
925 gtk_accel_groups_activate (GObject *object,
927 GdkModifierType accel_mods)
929 g_return_val_if_fail (G_IS_OBJECT (object), FALSE);
931 if (gtk_accelerator_valid (accel_key, accel_mods))
937 accel_name = gtk_accelerator_name (accel_key, (accel_mods & gtk_accelerator_get_default_mod_mask ()));
938 accel_quark = g_quark_from_string (accel_name);
941 for (slist = gtk_accel_groups_from_object (object); slist; slist = slist->next)
942 if (gtk_accel_group_activate (slist->data, accel_quark, object, accel_key, accel_mods))
950 * gtk_accelerator_valid:
951 * @keyval: a GDK keyval
952 * @modifiers: modifier mask
953 * @returns: %TRUE if the accelerator is valid
955 * Determines whether a given keyval and modifier mask constitute
956 * a valid keyboard accelerator. For example, the #GDK_a keyval
957 * plus #GDK_CONTROL_MASK is valid - this is a "Ctrl+a" accelerator.
958 * But, you can't, for instance, use the #GDK_Control_L keyval
962 gtk_accelerator_valid (guint keyval,
963 GdkModifierType modifiers)
965 static const guint invalid_accelerator_vals[] = {
966 GDK_KEY_Shift_L, GDK_KEY_Shift_R, GDK_KEY_Shift_Lock, GDK_KEY_Caps_Lock, GDK_KEY_ISO_Lock,
967 GDK_KEY_Control_L, GDK_KEY_Control_R, GDK_KEY_Meta_L, GDK_KEY_Meta_R,
968 GDK_KEY_Alt_L, GDK_KEY_Alt_R, GDK_KEY_Super_L, GDK_KEY_Super_R, GDK_KEY_Hyper_L, GDK_KEY_Hyper_R,
969 GDK_KEY_ISO_Level3_Shift, GDK_KEY_ISO_Next_Group, GDK_KEY_ISO_Prev_Group,
970 GDK_KEY_ISO_First_Group, GDK_KEY_ISO_Last_Group,
971 GDK_KEY_Mode_switch, GDK_KEY_Num_Lock, GDK_KEY_Multi_key,
972 GDK_KEY_Scroll_Lock, GDK_KEY_Sys_Req,
973 GDK_KEY_Tab, GDK_KEY_ISO_Left_Tab, GDK_KEY_KP_Tab,
974 GDK_KEY_First_Virtual_Screen, GDK_KEY_Prev_Virtual_Screen,
975 GDK_KEY_Next_Virtual_Screen, GDK_KEY_Last_Virtual_Screen,
976 GDK_KEY_Terminate_Server, GDK_KEY_AudibleBell_Enable,
979 static const guint invalid_unmodified_vals[] = {
980 GDK_KEY_Up, GDK_KEY_Down, GDK_KEY_Left, GDK_KEY_Right,
981 GDK_KEY_KP_Up, GDK_KEY_KP_Down, GDK_KEY_KP_Left, GDK_KEY_KP_Right,
986 modifiers &= GDK_MODIFIER_MASK;
989 return keyval >= 0x20;
991 ac_val = invalid_accelerator_vals;
994 if (keyval == *ac_val++)
1000 ac_val = invalid_unmodified_vals;
1003 if (keyval == *ac_val++)
1011 static inline gboolean
1012 is_alt (const gchar *string)
1014 return ((string[0] == '<') &&
1015 (string[1] == 'a' || string[1] == 'A') &&
1016 (string[2] == 'l' || string[2] == 'L') &&
1017 (string[3] == 't' || string[3] == 'T') &&
1018 (string[4] == '>'));
1021 static inline gboolean
1022 is_ctl (const gchar *string)
1024 return ((string[0] == '<') &&
1025 (string[1] == 'c' || string[1] == 'C') &&
1026 (string[2] == 't' || string[2] == 'T') &&
1027 (string[3] == 'l' || string[3] == 'L') &&
1028 (string[4] == '>'));
1031 static inline gboolean
1032 is_modx (const gchar *string)
1034 return ((string[0] == '<') &&
1035 (string[1] == 'm' || string[1] == 'M') &&
1036 (string[2] == 'o' || string[2] == 'O') &&
1037 (string[3] == 'd' || string[3] == 'D') &&
1038 (string[4] >= '1' && string[4] <= '5') &&
1039 (string[5] == '>'));
1042 static inline gboolean
1043 is_ctrl (const gchar *string)
1045 return ((string[0] == '<') &&
1046 (string[1] == 'c' || string[1] == 'C') &&
1047 (string[2] == 't' || string[2] == 'T') &&
1048 (string[3] == 'r' || string[3] == 'R') &&
1049 (string[4] == 'l' || string[4] == 'L') &&
1050 (string[5] == '>'));
1053 static inline gboolean
1054 is_shft (const gchar *string)
1056 return ((string[0] == '<') &&
1057 (string[1] == 's' || string[1] == 'S') &&
1058 (string[2] == 'h' || string[2] == 'H') &&
1059 (string[3] == 'f' || string[3] == 'F') &&
1060 (string[4] == 't' || string[4] == 'T') &&
1061 (string[5] == '>'));
1064 static inline gboolean
1065 is_shift (const gchar *string)
1067 return ((string[0] == '<') &&
1068 (string[1] == 's' || string[1] == 'S') &&
1069 (string[2] == 'h' || string[2] == 'H') &&
1070 (string[3] == 'i' || string[3] == 'I') &&
1071 (string[4] == 'f' || string[4] == 'F') &&
1072 (string[5] == 't' || string[5] == 'T') &&
1073 (string[6] == '>'));
1076 static inline gboolean
1077 is_control (const gchar *string)
1079 return ((string[0] == '<') &&
1080 (string[1] == 'c' || string[1] == 'C') &&
1081 (string[2] == 'o' || string[2] == 'O') &&
1082 (string[3] == 'n' || string[3] == 'N') &&
1083 (string[4] == 't' || string[4] == 'T') &&
1084 (string[5] == 'r' || string[5] == 'R') &&
1085 (string[6] == 'o' || string[6] == 'O') &&
1086 (string[7] == 'l' || string[7] == 'L') &&
1087 (string[8] == '>'));
1090 static inline gboolean
1091 is_release (const gchar *string)
1093 return ((string[0] == '<') &&
1094 (string[1] == 'r' || string[1] == 'R') &&
1095 (string[2] == 'e' || string[2] == 'E') &&
1096 (string[3] == 'l' || string[3] == 'L') &&
1097 (string[4] == 'e' || string[4] == 'E') &&
1098 (string[5] == 'a' || string[5] == 'A') &&
1099 (string[6] == 's' || string[6] == 'S') &&
1100 (string[7] == 'e' || string[7] == 'E') &&
1101 (string[8] == '>'));
1104 static inline gboolean
1105 is_meta (const gchar *string)
1107 return ((string[0] == '<') &&
1108 (string[1] == 'm' || string[1] == 'M') &&
1109 (string[2] == 'e' || string[2] == 'E') &&
1110 (string[3] == 't' || string[3] == 'T') &&
1111 (string[4] == 'a' || string[4] == 'A') &&
1112 (string[5] == '>'));
1115 static inline gboolean
1116 is_super (const gchar *string)
1118 return ((string[0] == '<') &&
1119 (string[1] == 's' || string[1] == 'S') &&
1120 (string[2] == 'u' || string[2] == 'U') &&
1121 (string[3] == 'p' || string[3] == 'P') &&
1122 (string[4] == 'e' || string[4] == 'E') &&
1123 (string[5] == 'r' || string[5] == 'R') &&
1124 (string[6] == '>'));
1127 static inline gboolean
1128 is_hyper (const gchar *string)
1130 return ((string[0] == '<') &&
1131 (string[1] == 'h' || string[1] == 'H') &&
1132 (string[2] == 'y' || string[2] == 'Y') &&
1133 (string[3] == 'p' || string[3] == 'P') &&
1134 (string[4] == 'e' || string[4] == 'E') &&
1135 (string[5] == 'r' || string[5] == 'R') &&
1136 (string[6] == '>'));
1140 * gtk_accelerator_parse:
1141 * @accelerator: string representing an accelerator
1142 * @accelerator_key: (out): return location for accelerator keyval
1143 * @accelerator_mods: (out): return location for accelerator modifier mask
1145 * Parses a string representing an accelerator. The
1146 * format looks like "<Control>a" or "<Shift><Alt>F1" or
1147 * "<Release>z" (the last one is for key release).
1148 * The parser is fairly liberal and allows lower or upper case,
1149 * and also abbreviations such as "<Ctl>" and "<Ctrl>".
1150 * Key names are parsed using gdk_keyval_from_name(). For character keys the
1151 * name is not the symbol, but the lowercase name, e.g. one would use
1152 * "<Ctrl>minus" instead of "<Ctrl>-".
1154 * If the parse fails, @accelerator_key and @accelerator_mods will
1155 * be set to 0 (zero).
1158 gtk_accelerator_parse (const gchar *accelerator,
1159 guint *accelerator_key,
1160 GdkModifierType *accelerator_mods)
1163 GdkModifierType mods;
1166 if (accelerator_key)
1167 *accelerator_key = 0;
1168 if (accelerator_mods)
1169 *accelerator_mods = 0;
1170 g_return_if_fail (accelerator != NULL);
1174 len = strlen (accelerator);
1177 if (*accelerator == '<')
1179 if (len >= 9 && is_release (accelerator))
1183 mods |= GDK_RELEASE_MASK;
1185 else if (len >= 9 && is_control (accelerator))
1189 mods |= GDK_CONTROL_MASK;
1191 else if (len >= 7 && is_shift (accelerator))
1195 mods |= GDK_SHIFT_MASK;
1197 else if (len >= 6 && is_shft (accelerator))
1201 mods |= GDK_SHIFT_MASK;
1203 else if (len >= 6 && is_ctrl (accelerator))
1207 mods |= GDK_CONTROL_MASK;
1209 else if (len >= 6 && is_modx (accelerator))
1211 static const guint mod_vals[] = {
1212 GDK_MOD1_MASK, GDK_MOD2_MASK, GDK_MOD3_MASK,
1213 GDK_MOD4_MASK, GDK_MOD5_MASK
1218 mods |= mod_vals[*accelerator - '1'];
1221 else if (len >= 5 && is_ctl (accelerator))
1225 mods |= GDK_CONTROL_MASK;
1227 else if (len >= 5 && is_alt (accelerator))
1231 mods |= GDK_MOD1_MASK;
1233 else if (len >= 6 && is_meta (accelerator))
1237 mods |= GDK_META_MASK;
1239 else if (len >= 7 && is_hyper (accelerator))
1243 mods |= GDK_HYPER_MASK;
1245 else if (len >= 7 && is_super (accelerator))
1249 mods |= GDK_SUPER_MASK;
1255 last_ch = *accelerator;
1256 while (last_ch && last_ch != '>')
1258 last_ch = *accelerator;
1266 keyval = gdk_keyval_from_name (accelerator);
1272 if (accelerator_key)
1273 *accelerator_key = gdk_keyval_to_lower (keyval);
1274 if (accelerator_mods)
1275 *accelerator_mods = mods;
1279 * gtk_accelerator_name:
1280 * @accelerator_key: accelerator keyval
1281 * @accelerator_mods: accelerator modifier mask
1283 * Converts an accelerator keyval and modifier mask
1284 * into a string parseable by gtk_accelerator_parse().
1285 * For example, if you pass in #GDK_q and #GDK_CONTROL_MASK,
1286 * this function returns "<Control>q".
1288 * If you need to display accelerators in the user interface,
1289 * see gtk_accelerator_get_label().
1291 * Returns: a newly-allocated accelerator name
1294 gtk_accelerator_name (guint accelerator_key,
1295 GdkModifierType accelerator_mods)
1297 static const gchar text_release[] = "<Release>";
1298 static const gchar text_shift[] = "<Shift>";
1299 static const gchar text_control[] = "<Control>";
1300 static const gchar text_mod1[] = "<Alt>";
1301 static const gchar text_mod2[] = "<Mod2>";
1302 static const gchar text_mod3[] = "<Mod3>";
1303 static const gchar text_mod4[] = "<Mod4>";
1304 static const gchar text_mod5[] = "<Mod5>";
1305 static const gchar text_meta[] = "<Meta>";
1306 static const gchar text_super[] = "<Super>";
1307 static const gchar text_hyper[] = "<Hyper>";
1312 accelerator_mods &= GDK_MODIFIER_MASK;
1314 keyval_name = gdk_keyval_name (gdk_keyval_to_lower (accelerator_key));
1319 if (accelerator_mods & GDK_RELEASE_MASK)
1320 l += sizeof (text_release) - 1;
1321 if (accelerator_mods & GDK_SHIFT_MASK)
1322 l += sizeof (text_shift) - 1;
1323 if (accelerator_mods & GDK_CONTROL_MASK)
1324 l += sizeof (text_control) - 1;
1325 if (accelerator_mods & GDK_MOD1_MASK)
1326 l += sizeof (text_mod1) - 1;
1327 if (accelerator_mods & GDK_MOD2_MASK)
1328 l += sizeof (text_mod2) - 1;
1329 if (accelerator_mods & GDK_MOD3_MASK)
1330 l += sizeof (text_mod3) - 1;
1331 if (accelerator_mods & GDK_MOD4_MASK)
1332 l += sizeof (text_mod4) - 1;
1333 if (accelerator_mods & GDK_MOD5_MASK)
1334 l += sizeof (text_mod5) - 1;
1335 l += strlen (keyval_name);
1336 if (accelerator_mods & GDK_META_MASK)
1337 l += sizeof (text_meta) - 1;
1338 if (accelerator_mods & GDK_HYPER_MASK)
1339 l += sizeof (text_hyper) - 1;
1340 if (accelerator_mods & GDK_SUPER_MASK)
1341 l += sizeof (text_super) - 1;
1343 accelerator = g_new (gchar, l + 1);
1347 if (accelerator_mods & GDK_RELEASE_MASK)
1349 strcpy (accelerator + l, text_release);
1350 l += sizeof (text_release) - 1;
1352 if (accelerator_mods & GDK_SHIFT_MASK)
1354 strcpy (accelerator + l, text_shift);
1355 l += sizeof (text_shift) - 1;
1357 if (accelerator_mods & GDK_CONTROL_MASK)
1359 strcpy (accelerator + l, text_control);
1360 l += sizeof (text_control) - 1;
1362 if (accelerator_mods & GDK_MOD1_MASK)
1364 strcpy (accelerator + l, text_mod1);
1365 l += sizeof (text_mod1) - 1;
1367 if (accelerator_mods & GDK_MOD2_MASK)
1369 strcpy (accelerator + l, text_mod2);
1370 l += sizeof (text_mod2) - 1;
1372 if (accelerator_mods & GDK_MOD3_MASK)
1374 strcpy (accelerator + l, text_mod3);
1375 l += sizeof (text_mod3) - 1;
1377 if (accelerator_mods & GDK_MOD4_MASK)
1379 strcpy (accelerator + l, text_mod4);
1380 l += sizeof (text_mod4) - 1;
1382 if (accelerator_mods & GDK_MOD5_MASK)
1384 strcpy (accelerator + l, text_mod5);
1385 l += sizeof (text_mod5) - 1;
1387 if (accelerator_mods & GDK_META_MASK)
1389 strcpy (accelerator + l, text_meta);
1390 l += sizeof (text_meta) - 1;
1392 if (accelerator_mods & GDK_HYPER_MASK)
1394 strcpy (accelerator + l, text_hyper);
1395 l += sizeof (text_hyper) - 1;
1397 if (accelerator_mods & GDK_SUPER_MASK)
1399 strcpy (accelerator + l, text_super);
1400 l += sizeof (text_super) - 1;
1402 strcpy (accelerator + l, keyval_name);
1408 * gtk_accelerator_get_label:
1409 * @accelerator_key: accelerator keyval
1410 * @accelerator_mods: accelerator modifier mask
1412 * Converts an accelerator keyval and modifier mask into a string
1413 * which can be used to represent the accelerator to the user.
1415 * Returns: a newly-allocated string representing the accelerator.
1420 gtk_accelerator_get_label (guint accelerator_key,
1421 GdkModifierType accelerator_mods)
1423 GtkAccelLabelClass *klass;
1426 klass = g_type_class_ref (GTK_TYPE_ACCEL_LABEL);
1427 label = _gtk_accel_label_class_get_accelerator_label (klass,
1430 g_type_class_unref (klass); /* klass is kept alive since gtk uses static types */
1436 * gtk_accelerator_set_default_mod_mask:
1437 * @default_mod_mask: accelerator modifier mask
1439 * Sets the modifiers that will be considered significant for keyboard
1440 * accelerators. The default mod mask is #GDK_CONTROL_MASK |
1441 * #GDK_SHIFT_MASK | #GDK_MOD1_MASK | #GDK_SUPER_MASK |
1442 * #GDK_HYPER_MASK | #GDK_META_MASK, that is, Control, Shift, Alt,
1443 * Super, Hyper and Meta. Other modifiers will by default be ignored
1444 * by #GtkAccelGroup.
1445 * You must include at least the three modifiers Control, Shift
1446 * and Alt in any value you pass to this function.
1448 * The default mod mask should be changed on application startup,
1449 * before using any accelerator groups.
1452 gtk_accelerator_set_default_mod_mask (GdkModifierType default_mod_mask)
1454 default_accel_mod_mask = (default_mod_mask & GDK_MODIFIER_MASK) |
1455 (GDK_CONTROL_MASK | GDK_SHIFT_MASK | GDK_MOD1_MASK);
1459 * gtk_accelerator_get_default_mod_mask:
1460 * @returns: the default accelerator modifier mask
1462 * Gets the value set by gtk_accelerator_set_default_mod_mask().
1465 gtk_accelerator_get_default_mod_mask (void)
1467 return default_accel_mod_mask;