/* GTK - The GIMP Toolkit
- * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
- *
- * GtkAccelGroup: Accelerator manager for GtkObjects.
- * Copyright (C) 1998 Tim Janik
+ * Copyright (C) 1998, 2001 Tim Janik
*
* This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Library General Public
+ * modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- * Library General Public License for more details.
+ * Lesser General Public License for more details.
*
- * You should have received a copy of the GNU Library General Public
+ * 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.
*/
-#include <ctype.h>
-#include <strings.h>
+
+/*
+ * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
+ * file for a list of people on the GTK+ Team. See the ChangeLog
+ * files for a list of changes. These files are distributed with
+ * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
+ */
+
+#include "config.h"
+#include <string.h>
+#include <stdlib.h>
+
#include "gtkaccelgroup.h"
+#include "gtkaccellabel.h" /* For _gtk_accel_label_class_get_accelerator_label */
+#include "gtkaccelmap.h"
+#include "gtkintl.h"
+#include "gtkmain.h" /* For _gtk_boolean_handled_accumulator */
#include "gdk/gdkkeysyms.h"
-#include "gtksignal.h"
-#include "gtkwidget.h"
-
-
-/* --- signals --- */
-typedef void (*GtkSignalAddAccelerator) (GtkObject *object,
- guint accel_signal_id,
- GtkAccelGroup *accel_group,
- guint accel_key,
- GdkModifierType accel_mods,
- GtkAccelFlags accel_flags,
- gpointer func_data);
-typedef void (*GtkSignalRemoveAccelerator) (GtkObject *object,
- GtkAccelGroup *accel_group,
- guint accel_key,
- GdkModifierType accel_mods,
- gpointer func_data);
+#include "gtkmarshalers.h"
+#include "gtkalias.h"
+
+/**
+ * SECTION:gtkaccelgroup
+ * @Short_description: Groups of global keyboard accelerators for an entire GtkWindow
+ * @Title: Accelerator Groups
+ * @See_also:gtk_window_add_accel_group(), gtk_accel_map_change_entry(),
+ * gtk_item_factory_new(), gtk_label_new_with_mnemonic()
+ *
+ * A #GtkAccelGroup represents a group of keyboard accelerators,
+ * typically attached to a toplevel #GtkWindow (with
+ * gtk_window_add_accel_group()). Usually you won't need to create a
+ * #GtkAccelGroup directly; instead, when using #GtkItemFactory, GTK+
+ * automatically sets up the accelerators for your menus in the item
+ * factory's #GtkAccelGroup.
+ *
+ *
+ * Note that <firstterm>accelerators</firstterm> are different from
+ * <firstterm>mnemonics</firstterm>. Accelerators are shortcuts for
+ * activating a menu item; they appear alongside the menu item they're a
+ * shortcut for. For example "Ctrl+Q" might appear alongside the "Quit"
+ * menu item. Mnemonics are shortcuts for GUI elements such as text
+ * entries or buttons; they appear as underlined characters. See
+ * gtk_label_new_with_mnemonic(). Menu items can have both accelerators
+ * and mnemonics, of course.
+ */
+
+
+/* --- prototypes --- */
+static void gtk_accel_group_finalize (GObject *object);
+static void gtk_accel_group_get_property (GObject *object,
+ guint param_id,
+ GValue *value,
+ GParamSpec *pspec);
+static void accel_closure_invalidate (gpointer data,
+ GClosure *closure);
+
/* --- variables --- */
-static GtkAccelGroup *default_accel_group = NULL;
-static guint default_accel_mod_mask = (GDK_SHIFT_MASK |
- GDK_CONTROL_MASK |
- GDK_MOD1_MASK);
-static const gchar *accel_groups_key = "gtk-accel-groups";
-static guint accel_groups_key_id = 0;
-static const gchar *accel_entries_key = "gtk-accel-entries";
-static guint accel_entries_key_id = 0;
-static GHashTable *accel_entry_hash_table = NULL;
-static GMemChunk *accel_tables_mem_chunk = NULL;
-static GMemChunk *accel_entries_mem_chunk = NULL;
+static guint signal_accel_activate = 0;
+static guint signal_accel_changed = 0;
+static guint quark_acceleratable_groups = 0;
+static guint default_accel_mod_mask = (GDK_SHIFT_MASK |
+ GDK_CONTROL_MASK |
+ GDK_MOD1_MASK |
+ GDK_SUPER_MASK |
+ GDK_HYPER_MASK |
+ GDK_META_MASK);
+
+
+enum {
+ PROP_0,
+ PROP_IS_LOCKED,
+ PROP_MODIFIER_MASK,
+};
+G_DEFINE_TYPE (GtkAccelGroup, gtk_accel_group, G_TYPE_OBJECT)
/* --- functions --- */
-static gint
-gtk_accel_entries_equal (gconstpointer a,
- gconstpointer b)
+static void
+gtk_accel_group_class_init (GtkAccelGroupClass *class)
{
- const GtkAccelEntry *e1;
- const GtkAccelEntry *e2;
-
- e1 = a;
- e2 = b;
-
- return ((e1->accel_group == e2->accel_group) &&
- (e1->accelerator_key == e2->accelerator_key) &&
- (e1->accelerator_mods == e2->accelerator_mods));
+ GObjectClass *object_class = G_OBJECT_CLASS (class);
+
+ quark_acceleratable_groups = g_quark_from_static_string ("gtk-acceleratable-accel-groups");
+
+ object_class->finalize = gtk_accel_group_finalize;
+ object_class->get_property = gtk_accel_group_get_property;
+
+ class->accel_changed = NULL;
+
+ g_object_class_install_property (object_class,
+ PROP_IS_LOCKED,
+ g_param_spec_boolean ("is-locked",
+ "Is locked",
+ "Is the accel group locked",
+ FALSE,
+ G_PARAM_READABLE));
+
+ g_object_class_install_property (object_class,
+ PROP_MODIFIER_MASK,
+ g_param_spec_flags ("modifier-mask",
+ "Modifier Mask",
+ "Modifier Mask",
+ GDK_TYPE_MODIFIER_TYPE,
+ default_accel_mod_mask,
+ G_PARAM_READABLE));
+
+ /**
+ * GtkAccelGroup::accel-activate:
+ * @accel_group: the #GtkAccelGroup which received the signal
+ * @acceleratable: the object on which the accelerator was activated
+ * @keyval: the accelerator keyval
+ * @modifier: the modifier combination of the accelerator
+ *
+ * The accel-activate signal is an implementation detail of
+ * #GtkAccelGroup and not meant to be used by applications.
+ *
+ * Returns: %TRUE if the accelerator was activated
+ */
+ signal_accel_activate =
+ g_signal_new (I_("accel-activate"),
+ G_OBJECT_CLASS_TYPE (class),
+ G_SIGNAL_DETAILED,
+ 0,
+ _gtk_boolean_handled_accumulator, NULL,
+ _gtk_marshal_BOOLEAN__OBJECT_UINT_FLAGS,
+ G_TYPE_BOOLEAN, 3,
+ G_TYPE_OBJECT,
+ G_TYPE_UINT,
+ GDK_TYPE_MODIFIER_TYPE);
+ /**
+ * GtkAccelGroup::accel-changed:
+ * @accel_group: the #GtkAccelGroup which received the signal
+ * @keyval: the accelerator keyval
+ * @modifier: the modifier combination of the accelerator
+ * @accel_closure: the #GClosure of the accelerator
+ *
+ * The accel-changed signal is emitted when a #GtkAccelGroupEntry
+ * is added to or removed from the accel group.
+ *
+ * Widgets like #GtkAccelLabel which display an associated
+ * accelerator should connect to this signal, and rebuild
+ * their visual representation if the @accel_closure is theirs.
+ */
+ signal_accel_changed =
+ g_signal_new (I_("accel-changed"),
+ G_OBJECT_CLASS_TYPE (class),
+ G_SIGNAL_RUN_FIRST | G_SIGNAL_DETAILED,
+ G_STRUCT_OFFSET (GtkAccelGroupClass, accel_changed),
+ NULL, NULL,
+ _gtk_marshal_VOID__UINT_FLAGS_BOXED,
+ G_TYPE_NONE, 3,
+ G_TYPE_UINT,
+ GDK_TYPE_MODIFIER_TYPE,
+ G_TYPE_CLOSURE);
}
-static guint
-gtk_accel_entries_hash (gconstpointer a)
+static void
+gtk_accel_group_finalize (GObject *object)
{
- const GtkAccelEntry *e;
- guint h;
+ GtkAccelGroup *accel_group = GTK_ACCEL_GROUP (object);
+ guint i;
- e = a;
-
- h = (gulong) e->accel_group;
- h ^= e->accelerator_key << 16;
- h ^= e->accelerator_key >> 16;
- h ^= e->accelerator_mods;
-
- return h;
+ for (i = 0; i < accel_group->n_accels; i++)
+ {
+ GtkAccelGroupEntry *entry = &accel_group->priv_accels[i];
+
+ if (entry->accel_path_quark)
+ {
+ const gchar *accel_path = g_quark_to_string (entry->accel_path_quark);
+
+ _gtk_accel_map_remove_group (accel_path, accel_group);
+ }
+ g_closure_remove_invalidate_notifier (entry->closure, accel_group, accel_closure_invalidate);
+
+ /* remove quick_accel_add() refcount */
+ g_closure_unref (entry->closure);
+ }
+
+ g_free (accel_group->priv_accels);
+
+ G_OBJECT_CLASS (gtk_accel_group_parent_class)->finalize (object);
}
-GtkAccelGroup*
-gtk_accel_group_new (void)
+static void
+gtk_accel_group_get_property (GObject *object,
+ guint param_id,
+ GValue *value,
+ GParamSpec *pspec)
{
- GtkAccelGroup *accel_group;
-
- if (!accel_groups_key_id)
+ GtkAccelGroup *accel_group = GTK_ACCEL_GROUP (object);
+
+ switch (param_id)
{
- accel_groups_key_id = g_quark_from_static_string (accel_groups_key);
- accel_entries_key_id = g_quark_from_static_string (accel_entries_key);
-
- accel_entry_hash_table = g_hash_table_new (gtk_accel_entries_hash,
- gtk_accel_entries_equal);
-
- accel_tables_mem_chunk = g_mem_chunk_create (GtkAccelGroup, 8, G_ALLOC_AND_FREE);
- accel_entries_mem_chunk = g_mem_chunk_create (GtkAccelEntry, 64, G_ALLOC_AND_FREE);
+ case PROP_IS_LOCKED:
+ g_value_set_boolean (value, accel_group->lock_count > 0);
+ break;
+ case PROP_MODIFIER_MASK:
+ g_value_set_flags (value, accel_group->modifier_mask);
+ break;
+ default:
+ G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
+ break;
}
-
- accel_group = g_chunk_new (GtkAccelGroup, accel_tables_mem_chunk);
-
- accel_group->ref_count = 1;
+}
+
+static void
+gtk_accel_group_init (GtkAccelGroup *accel_group)
+{
accel_group->lock_count = 0;
accel_group->modifier_mask = gtk_accelerator_get_default_mod_mask ();
- accel_group->attach_objects = NULL;
-
- return accel_group;
+ accel_group->acceleratables = NULL;
+ accel_group->n_accels = 0;
+ accel_group->priv_accels = NULL;
}
+/**
+ * gtk_accel_group_new:
+ * @returns: a new #GtkAccelGroup object
+ *
+ * Creates a new #GtkAccelGroup.
+ */
GtkAccelGroup*
-gtk_accel_group_get_default (void)
+gtk_accel_group_new (void)
{
- if (!default_accel_group)
- default_accel_group = gtk_accel_group_new ();
-
- return default_accel_group;
+ return g_object_new (GTK_TYPE_ACCEL_GROUP, NULL);
}
-GtkAccelGroup*
-gtk_accel_group_ref (GtkAccelGroup *accel_group)
+/**
+ * gtk_accel_group_get_is_locked:
+ * @accel_group: a #GtkAccelGroup
+ *
+ * Locks are added and removed using gtk_accel_group_lock() and
+ * gtk_accel_group_unlock().
+ *
+ * Returns: %TRUE if there are 1 or more locks on the @accel_group,
+ * %FALSE otherwise.
+ *
+ * Since: 2.14
+ */
+gboolean
+gtk_accel_group_get_is_locked (GtkAccelGroup *accel_group)
{
- g_return_val_if_fail (accel_group != NULL, NULL);
-
- accel_group->ref_count += 1;
-
- return accel_group;
+ g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), FALSE);
+
+ return accel_group->lock_count > 0;
}
-void
-gtk_accel_group_unref (GtkAccelGroup *accel_group)
+/**
+ * gtk_accel_group_get_modifier_mask:
+ * @accel_group: a #GtkAccelGroup
+ *
+ * Gets a #GdkModifierType representing the mask for this
+ * @accel_group. For example, #GDK_CONTROL_MASK, #GDK_SHIFT_MASK, etc.
+ *
+ * Returns: the modifier mask for this accel group.
+ *
+ * Since: 2.14
+ */
+GdkModifierType
+gtk_accel_group_get_modifier_mask (GtkAccelGroup *accel_group)
{
- g_return_if_fail (accel_group != NULL);
- g_return_if_fail (accel_group->ref_count > 0);
-
- accel_group->ref_count -= 1;
- if (accel_group->ref_count == 0)
- {
- g_return_if_fail (accel_group != default_accel_group);
- g_return_if_fail (accel_group->attach_objects == NULL);
-
- g_chunk_free (accel_group, accel_tables_mem_chunk);
- }
+ g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), 0);
+
+ return accel_group->modifier_mask;
}
static void
-gtk_accel_group_object_destroy (GtkObject *object)
+accel_group_weak_ref_detach (GSList *free_list,
+ GObject *stale_object)
{
- GSList *free_list, *slist;
-
- free_list = gtk_object_get_data_by_id (object, accel_groups_key_id);
- gtk_object_set_data_by_id (object, accel_groups_key_id, NULL);
+ GSList *slist;
for (slist = free_list; slist; slist = slist->next)
{
GtkAccelGroup *accel_group;
accel_group = slist->data;
- accel_group->attach_objects = g_slist_remove (accel_group->attach_objects, object);
- gtk_accel_group_unref (accel_group);
+ accel_group->acceleratables = g_slist_remove (accel_group->acceleratables, stale_object);
+ g_object_unref (accel_group);
}
g_slist_free (free_list);
+ g_object_set_qdata (stale_object, quark_acceleratable_groups, NULL);
}
void
-gtk_accel_group_attach (GtkAccelGroup *accel_group,
- GtkObject *object)
+_gtk_accel_group_attach (GtkAccelGroup *accel_group,
+ GObject *object)
{
GSList *slist;
- g_return_if_fail (accel_group != NULL);
- g_return_if_fail (object != NULL);
- g_return_if_fail (GTK_IS_OBJECT (object));
- g_return_if_fail (g_slist_find (accel_group->attach_objects, object) == NULL);
+ g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
+ g_return_if_fail (G_IS_OBJECT (object));
+ g_return_if_fail (g_slist_find (accel_group->acceleratables, object) == NULL);
- accel_group->attach_objects = g_slist_prepend (accel_group->attach_objects, object);
- gtk_accel_group_ref (accel_group);
- slist = gtk_object_get_data_by_id (object, accel_groups_key_id);
- if (!slist)
- gtk_signal_connect (object,
- "destroy",
- GTK_SIGNAL_FUNC (gtk_accel_group_object_destroy),
- NULL);
+ g_object_ref (accel_group);
+ accel_group->acceleratables = g_slist_prepend (accel_group->acceleratables, object);
+ slist = g_object_get_qdata (object, quark_acceleratable_groups);
+ if (slist)
+ g_object_weak_unref (object,
+ (GWeakNotify) accel_group_weak_ref_detach,
+ slist);
slist = g_slist_prepend (slist, accel_group);
- gtk_object_set_data_by_id (object, accel_groups_key_id, slist);
+ g_object_set_qdata (object, quark_acceleratable_groups, slist);
+ g_object_weak_ref (object,
+ (GWeakNotify) accel_group_weak_ref_detach,
+ slist);
}
void
-gtk_accel_group_detach (GtkAccelGroup *accel_group,
- GtkObject *object)
+_gtk_accel_group_detach (GtkAccelGroup *accel_group,
+ GObject *object)
{
GSList *slist;
- g_return_if_fail (accel_group != NULL);
- g_return_if_fail (object != NULL);
- g_return_if_fail (GTK_IS_OBJECT (object));
- g_return_if_fail (g_slist_find (accel_group->attach_objects, object) != NULL);
+ g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
+ g_return_if_fail (G_IS_OBJECT (object));
+ g_return_if_fail (g_slist_find (accel_group->acceleratables, object) != NULL);
- accel_group->attach_objects = g_slist_remove (accel_group->attach_objects, object);
- gtk_accel_group_unref (accel_group);
- slist = gtk_object_get_data_by_id (object, accel_groups_key_id);
+ accel_group->acceleratables = g_slist_remove (accel_group->acceleratables, object);
+ slist = g_object_get_qdata (object, quark_acceleratable_groups);
+ g_object_weak_unref (object,
+ (GWeakNotify) accel_group_weak_ref_detach,
+ slist);
slist = g_slist_remove (slist, accel_group);
- if (!slist)
- gtk_signal_disconnect_by_func (object,
- GTK_SIGNAL_FUNC (gtk_accel_group_object_destroy),
- NULL);
- gtk_object_set_data_by_id (object, accel_groups_key_id, slist);
+ g_object_set_qdata (object, quark_acceleratable_groups, slist);
+ if (slist)
+ g_object_weak_ref (object,
+ (GWeakNotify) accel_group_weak_ref_detach,
+ slist);
+ g_object_unref (accel_group);
}
-void
-gtk_accel_group_lock (GtkAccelGroup *accel_group)
+/**
+ * gtk_accel_groups_from_object:
+ * @object: a #GObject, usually a #GtkWindow
+ *
+ * Gets a list of all accel groups which are attached to @object.
+ *
+ * Returns: (element-type GtkAccelGroup) (transfer none): a list of all accel groups which are attached to @object
+ */
+GSList*
+gtk_accel_groups_from_object (GObject *object)
{
- g_return_if_fail (accel_group != NULL);
+ g_return_val_if_fail (G_IS_OBJECT (object), NULL);
- accel_group->lock_count += 1;
+ return g_object_get_qdata (object, quark_acceleratable_groups);
}
-void
-gtk_accel_group_unlock (GtkAccelGroup *accel_group)
+/**
+ * gtk_accel_group_find:
+ * @accel_group: a #GtkAccelGroup
+ * @find_func: a function to filter the entries of @accel_group with
+ * @data: data to pass to @find_func
+ * @returns: the key of the first entry passing @find_func. The key is
+ * owned by GTK+ and must not be freed.
+ *
+ * Finds the first entry in an accelerator group for which
+ * @find_func returns %TRUE and returns its #GtkAccelKey.
+ *
+ */
+GtkAccelKey*
+gtk_accel_group_find (GtkAccelGroup *accel_group,
+ GtkAccelGroupFindFunc find_func,
+ gpointer data)
{
- g_return_if_fail (accel_group != NULL);
-
- if (accel_group->lock_count)
- accel_group->lock_count -= 1;
-}
+ GtkAccelKey *key = NULL;
+ guint i;
-static GtkAccelEntry*
-gtk_accel_group_lookup (GtkAccelGroup *accel_group,
- guint accel_key,
- GdkModifierType accel_mods)
-{
- GtkAccelEntry key_entry = { 0 };
-
- key_entry.accel_group = accel_group;
- key_entry.accelerator_key = gdk_keyval_to_lower (accel_key);
- key_entry.accelerator_mods = accel_mods & accel_group->modifier_mask;
-
- return g_hash_table_lookup (accel_entry_hash_table, &key_entry);
-}
+ g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), NULL);
+ g_return_val_if_fail (find_func != NULL, NULL);
-gboolean
-gtk_accel_group_activate (GtkAccelGroup *accel_group,
- guint accel_key,
- GdkModifierType accel_mods)
-{
- GtkAccelEntry *entry;
-
- g_return_val_if_fail (accel_group != NULL, FALSE);
-
- entry = gtk_accel_group_lookup (accel_group, accel_key, accel_mods);
- if (entry && entry->signal_id)
- {
- gtk_signal_emit (entry->object, entry->signal_id);
- return TRUE;
- }
- return FALSE;
+ g_object_ref (accel_group);
+ for (i = 0; i < accel_group->n_accels; i++)
+ if (find_func (&accel_group->priv_accels[i].key,
+ accel_group->priv_accels[i].closure,
+ data))
+ {
+ key = &accel_group->priv_accels[i].key;
+ break;
+ }
+ g_object_unref (accel_group);
+
+ return key;
}
-gboolean
-gtk_accel_groups_activate (GtkObject *object,
- guint accel_key,
- GdkModifierType accel_mods)
+/**
+ * gtk_accel_group_lock:
+ * @accel_group: a #GtkAccelGroup
+ *
+ * Locks the given accelerator group.
+ *
+ * Locking an acelerator group prevents the accelerators contained
+ * within it to be changed during runtime. Refer to
+ * gtk_accel_map_change_entry() about runtime accelerator changes.
+ *
+ * If called more than once, @accel_group remains locked until
+ * gtk_accel_group_unlock() has been called an equivalent number
+ * of times.
+ */
+void
+gtk_accel_group_lock (GtkAccelGroup *accel_group)
{
- g_return_val_if_fail (object != NULL, FALSE);
- g_return_val_if_fail (GTK_IS_OBJECT (object), FALSE);
+ g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
- if (gtk_accelerator_valid (accel_key, accel_mods))
- {
- GSList *slist;
-
- for (slist = gtk_accel_groups_from_object (object); slist; slist = slist->next)
- if (gtk_accel_group_activate (slist->data, accel_key, accel_mods))
- return TRUE;
- return gtk_accel_group_activate (gtk_accel_group_get_default (), accel_key, accel_mods);
- }
-
- return FALSE;
+ accel_group->lock_count += 1;
+
+ if (accel_group->lock_count == 1) {
+ /* State change from unlocked to locked */
+ g_object_notify (G_OBJECT (accel_group), "is-locked");
+ }
}
+/**
+ * gtk_accel_group_unlock:
+ * @accel_group: a #GtkAccelGroup
+ *
+ * Undoes the last call to gtk_accel_group_lock() on this @accel_group.
+ */
void
-gtk_accel_group_lock_entry (GtkAccelGroup *accel_group,
- guint accel_key,
- GdkModifierType accel_mods)
+gtk_accel_group_unlock (GtkAccelGroup *accel_group)
{
- GtkAccelEntry *entry;
-
- g_return_if_fail (accel_group != NULL);
-
- entry = gtk_accel_group_lookup (accel_group, accel_key, accel_mods);
- if (entry)
- entry->accel_flags |= GTK_ACCEL_LOCKED;
+ g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
+ g_return_if_fail (accel_group->lock_count > 0);
+
+ accel_group->lock_count -= 1;
+
+ if (accel_group->lock_count < 1) {
+ /* State change from locked to unlocked */
+ g_object_notify (G_OBJECT (accel_group), "is-locked");
+ }
}
-void
-gtk_accel_group_unlock_entry (GtkAccelGroup *accel_group,
- guint accel_key,
- GdkModifierType accel_mods)
+static void
+accel_closure_invalidate (gpointer data,
+ GClosure *closure)
{
- GtkAccelEntry *entry;
-
- g_return_if_fail (accel_group != NULL);
-
- entry = gtk_accel_group_lookup (accel_group, accel_key, accel_mods);
- if (entry)
- entry->accel_flags &= ~GTK_ACCEL_LOCKED;
+ GtkAccelGroup *accel_group = GTK_ACCEL_GROUP (data);
+
+ gtk_accel_group_disconnect (accel_group, closure);
}
-GtkAccelEntry*
-gtk_accel_group_get_entry (GtkAccelGroup *accel_group,
- guint accel_key,
- GdkModifierType accel_mods)
+static int
+bsearch_compare_accels (const void *d1,
+ const void *d2)
{
- g_return_val_if_fail (accel_group != NULL, 0);
-
- return gtk_accel_group_lookup (accel_group, accel_key, accel_mods);
+ const GtkAccelGroupEntry *entry1 = d1;
+ const GtkAccelGroupEntry *entry2 = d2;
+
+ if (entry1->key.accel_key == entry2->key.accel_key)
+ return entry1->key.accel_mods < entry2->key.accel_mods ? -1 : entry1->key.accel_mods > entry2->key.accel_mods;
+ else
+ return entry1->key.accel_key < entry2->key.accel_key ? -1 : 1;
}
-void
-gtk_accel_group_add (GtkAccelGroup *accel_group,
- guint accel_key,
- GdkModifierType accel_mods,
- GtkAccelFlags accel_flags,
- GtkObject *object,
- const gchar *accel_signal)
+static void
+quick_accel_add (GtkAccelGroup *accel_group,
+ guint accel_key,
+ GdkModifierType accel_mods,
+ GtkAccelFlags accel_flags,
+ GClosure *closure,
+ GQuark path_quark)
{
- guint accel_signal_id = 0;
- guint add_accelerator_signal_id = 0;
- guint remove_accelerator_signal_id = 0;
- gchar *signal;
- GtkSignalQuery *query;
- GSList *slist;
- GSList *groups;
- GSList *attach_objects;
- GtkAccelEntry *entry;
-
- g_return_if_fail (accel_group != NULL);
- g_return_if_fail (object != NULL);
- g_return_if_fail (GTK_IS_OBJECT (object));
- g_return_if_fail (accel_signal != NULL);
-
- /* check for required signals in the objects branch
- */
- signal = (gchar*) accel_signal;
- accel_signal_id = gtk_signal_lookup (signal, GTK_OBJECT_TYPE (object));
- if (accel_signal_id)
- {
- signal = "add-accelerator";
- add_accelerator_signal_id = gtk_signal_lookup (signal, GTK_OBJECT_TYPE (object));
- }
- if (add_accelerator_signal_id)
- {
- signal = "remove-accelerator";
- remove_accelerator_signal_id = gtk_signal_lookup (signal, GTK_OBJECT_TYPE (object));
- }
- if (!accel_signal_id ||
- !add_accelerator_signal_id ||
- !remove_accelerator_signal_id)
- {
- g_warning ("gtk_accel_group_add(): could not find signal \"%s\""
- "in the `%s' class ancestry",
- signal,
- gtk_type_name (GTK_OBJECT_TYPE (object)));
- return;
- }
- query = gtk_signal_query (accel_signal_id);
- if (!query ||
- query->nparams > 0)
- {
- g_warning ("gtk_accel_group_add(): signal \"%s\" in the `%s' class ancestry"
- "cannot be used as accelerator signal",
- accel_signal,
- gtk_type_name (GTK_OBJECT_TYPE (object)));
- if (query)
- g_free (query);
-
- return;
- }
- g_free (query);
+ guint pos, i = accel_group->n_accels++;
+ GtkAccelGroupEntry key;
- /* prematurely abort if the group/entry is already locked
- */
- if (accel_group->lock_count > 0)
- return;
- entry = gtk_accel_group_lookup (accel_group, accel_key, accel_mods);
- if (entry && entry->accel_flags & GTK_ACCEL_LOCKED)
- return;
-
- /* make sure our structures stay alive
- */
- gtk_accel_group_ref (accel_group);
- gtk_object_ref (object);
-
- /* remove an existing entry
- */
- if (entry)
- gtk_signal_emit (entry->object, remove_accelerator_signal_id,
- accel_group,
- gdk_keyval_to_lower (accel_key),
- accel_mods & accel_group->modifier_mask);
+ /* find position */
+ key.key.accel_key = accel_key;
+ key.key.accel_mods = accel_mods;
+ for (pos = 0; pos < i; pos++)
+ if (bsearch_compare_accels (&key, accel_group->priv_accels + pos) < 0)
+ break;
+
+ /* insert at position, ref closure */
+ accel_group->priv_accels = g_renew (GtkAccelGroupEntry, accel_group->priv_accels, accel_group->n_accels);
+ g_memmove (accel_group->priv_accels + pos + 1, accel_group->priv_accels + pos,
+ (i - pos) * sizeof (accel_group->priv_accels[0]));
+ accel_group->priv_accels[pos].key.accel_key = accel_key;
+ accel_group->priv_accels[pos].key.accel_mods = accel_mods;
+ accel_group->priv_accels[pos].key.accel_flags = accel_flags;
+ accel_group->priv_accels[pos].closure = g_closure_ref (closure);
+ accel_group->priv_accels[pos].accel_path_quark = path_quark;
+ g_closure_sink (closure);
- /* abort if the entry still exists
- */
- entry = gtk_accel_group_lookup (accel_group, accel_key, accel_mods);
- if (entry)
+ /* handle closure invalidation and reverse lookups */
+ g_closure_add_invalidate_notifier (closure, accel_group, accel_closure_invalidate);
+
+ /* get accel path notification */
+ if (path_quark)
+ _gtk_accel_map_add_group (g_quark_to_string (path_quark), accel_group);
+
+ /* connect and notify changed */
+ if (accel_key)
{
- gtk_accel_group_unref (accel_group);
- gtk_object_unref (object);
+ gchar *accel_name = gtk_accelerator_name (accel_key, accel_mods);
+ GQuark accel_quark = g_quark_from_string (accel_name);
+
+ g_free (accel_name);
- return;
- }
-
- /* collect accel groups and remove existing entries
- */
- attach_objects = accel_group->attach_objects;
- groups = NULL;
- for (attach_objects = accel_group->attach_objects; attach_objects; attach_objects = attach_objects->next)
- {
- GSList *tmp_groups;
+ /* setup handler */
+ g_signal_connect_closure_by_id (accel_group, signal_accel_activate, accel_quark, closure, FALSE);
- tmp_groups = gtk_object_get_data_by_id (attach_objects->data, accel_groups_key_id);
- while (tmp_groups)
- {
- groups = g_slist_prepend (groups, tmp_groups->data);
- gtk_accel_group_ref (tmp_groups->data);
- tmp_groups = tmp_groups->next;
- }
+ /* and notify */
+ g_signal_emit (accel_group, signal_accel_changed, accel_quark, accel_key, accel_mods, closure);
}
- for (slist = groups; slist; slist = slist->next)
+}
+
+static void
+quick_accel_remove (GtkAccelGroup *accel_group,
+ guint pos)
+{
+ GQuark accel_quark = 0;
+ GtkAccelGroupEntry *entry = accel_group->priv_accels + pos;
+ guint accel_key = entry->key.accel_key;
+ GdkModifierType accel_mods = entry->key.accel_mods;
+ GClosure *closure = entry->closure;
+
+ /* quark for notification */
+ if (accel_key)
{
- GtkAccelGroup *tmp_group;
-
- tmp_group = slist->data;
-
- /* we only remove the accelerator if neccessary
- */
- if (tmp_group->lock_count == 0)
- {
- entry = gtk_accel_group_lookup (tmp_group, accel_key, accel_mods);
- if (entry && !(entry->accel_flags & GTK_ACCEL_LOCKED))
- gtk_signal_emit (entry->object, remove_accelerator_signal_id,
- tmp_group,
- gdk_keyval_to_lower (accel_key),
- accel_mods & tmp_group->modifier_mask);
- }
- gtk_accel_group_unref (tmp_group);
+ gchar *accel_name = gtk_accelerator_name (accel_key, accel_mods);
+
+ accel_quark = g_quark_from_string (accel_name);
+ g_free (accel_name);
}
- g_slist_free (groups);
+
+ /* clean up closure invalidate notification and disconnect */
+ g_closure_remove_invalidate_notifier (entry->closure, accel_group, accel_closure_invalidate);
+ if (accel_quark)
+ g_signal_handlers_disconnect_matched (accel_group,
+ G_SIGNAL_MATCH_ID | G_SIGNAL_MATCH_DETAIL | G_SIGNAL_MATCH_CLOSURE,
+ signal_accel_activate, accel_quark,
+ closure, NULL, NULL);
+ /* clean up accel path notification */
+ if (entry->accel_path_quark)
+ _gtk_accel_map_remove_group (g_quark_to_string (entry->accel_path_quark), accel_group);
+
+ /* physically remove */
+ accel_group->n_accels -= 1;
+ g_memmove (entry, entry + 1,
+ (accel_group->n_accels - pos) * sizeof (accel_group->priv_accels[0]));
+
+ /* and notify */
+ if (accel_quark)
+ g_signal_emit (accel_group, signal_accel_changed, accel_quark, accel_key, accel_mods, closure);
+
+ /* remove quick_accel_add() refcount */
+ g_closure_unref (closure);
+}
+
+static GtkAccelGroupEntry*
+quick_accel_find (GtkAccelGroup *accel_group,
+ guint accel_key,
+ GdkModifierType accel_mods,
+ guint *count_p)
+{
+ GtkAccelGroupEntry *entry;
+ GtkAccelGroupEntry key;
+
+ *count_p = 0;
+
+ if (!accel_group->n_accels)
+ return NULL;
+
+ key.key.accel_key = accel_key;
+ key.key.accel_mods = accel_mods;
+ entry = bsearch (&key, accel_group->priv_accels, accel_group->n_accels,
+ sizeof (accel_group->priv_accels[0]), bsearch_compare_accels);
- /* now install the new accelerator
- */
- entry = gtk_accel_group_lookup (accel_group, accel_key, accel_mods);
if (!entry)
- gtk_signal_emit (object, add_accelerator_signal_id,
- accel_signal_id,
- accel_group,
- gdk_keyval_to_lower (accel_key),
- accel_mods & accel_group->modifier_mask,
- accel_flags & GTK_ACCEL_MASK);
-
- /* and release the structures again
- */
- gtk_accel_group_unref (accel_group);
- gtk_object_unref (object);
+ return NULL;
+
+ /* step back to the first member */
+ for (; entry > accel_group->priv_accels; entry--)
+ if (entry[-1].key.accel_key != accel_key ||
+ entry[-1].key.accel_mods != accel_mods)
+ break;
+ /* count equal members */
+ for (; entry + *count_p < accel_group->priv_accels + accel_group->n_accels; (*count_p)++)
+ if (entry[*count_p].key.accel_key != accel_key ||
+ entry[*count_p].key.accel_mods != accel_mods)
+ break;
+ return entry;
}
-static void
-gtk_accel_group_delete_entries (GtkObject *object)
+/**
+ * gtk_accel_group_connect:
+ * @accel_group: the accelerator group to install an accelerator in
+ * @accel_key: key value of the accelerator
+ * @accel_mods: modifier combination of the accelerator
+ * @accel_flags: a flag mask to configure this accelerator
+ * @closure: closure to be executed upon accelerator activation
+ *
+ * Installs an accelerator in this group. When @accel_group is being activated
+ * in response to a call to gtk_accel_groups_activate(), @closure will be
+ * invoked if the @accel_key and @accel_mods from gtk_accel_groups_activate()
+ * match those of this connection.
+ *
+ * The signature used for the @closure is that of #GtkAccelGroupActivate.
+ *
+ * Note that, due to implementation details, a single closure can only be
+ * connected to one accelerator group.
+ */
+void
+gtk_accel_group_connect (GtkAccelGroup *accel_group,
+ guint accel_key,
+ GdkModifierType accel_mods,
+ GtkAccelFlags accel_flags,
+ GClosure *closure)
{
- GSList *free_slist, *slist;
-
- gtk_signal_disconnect_by_func (object,
- GTK_SIGNAL_FUNC (gtk_accel_group_delete_entries),
- NULL);
+ g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
+ g_return_if_fail (closure != NULL);
+ g_return_if_fail (accel_key > 0);
+ g_return_if_fail (gtk_accel_group_from_accel_closure (closure) == NULL);
- /* we remove all entries of this object the hard
- * way (i.e. without signal emission).
- */
- free_slist = gtk_object_get_data_by_id (object, accel_entries_key_id);
- gtk_object_set_data_by_id (object, accel_entries_key_id, NULL);
- for (slist = free_slist; slist; slist = slist->next)
- {
- GtkAccelEntry *entry;
-
- entry = slist->data;
-
- g_hash_table_remove (accel_entry_hash_table, entry);
- gtk_accel_group_unref (entry->accel_group);
- g_chunk_free (entry, accel_entries_mem_chunk);
- }
- g_slist_free (free_slist);
+ g_object_ref (accel_group);
+ if (!closure->is_invalid)
+ quick_accel_add (accel_group,
+ gdk_keyval_to_lower (accel_key),
+ accel_mods, accel_flags, closure, 0);
+ g_object_unref (accel_group);
}
+/**
+ * gtk_accel_group_connect_by_path:
+ * @accel_group: the accelerator group to install an accelerator in
+ * @accel_path: path used for determining key and modifiers.
+ * @closure: closure to be executed upon accelerator activation
+ *
+ * Installs an accelerator in this group, using an accelerator path to look
+ * up the appropriate key and modifiers (see gtk_accel_map_add_entry()).
+ * When @accel_group is being activated in response to a call to
+ * gtk_accel_groups_activate(), @closure will be invoked if the @accel_key and
+ * @accel_mods from gtk_accel_groups_activate() match the key and modifiers
+ * for the path.
+ *
+ * The signature used for the @closure is that of #GtkAccelGroupActivate.
+ *
+ * Note that @accel_path string will be stored in a #GQuark. Therefore, if you
+ * pass a static string, you can save some memory by interning it first with
+ * g_intern_static_string().
+ */
void
-gtk_accel_group_handle_add (GtkObject *object,
- guint accel_signal_id,
- GtkAccelGroup *accel_group,
- guint accel_key,
- GdkModifierType accel_mods,
- GtkAccelFlags accel_flags)
+gtk_accel_group_connect_by_path (GtkAccelGroup *accel_group,
+ const gchar *accel_path,
+ GClosure *closure)
{
- GtkAccelEntry *entry;
-
- g_return_if_fail (object != NULL);
- g_return_if_fail (GTK_IS_OBJECT (object));
- g_return_if_fail (accel_group != NULL);
- g_return_if_fail (accel_signal_id > 0);
+ guint accel_key = 0;
+ GdkModifierType accel_mods = 0;
+ GtkAccelKey key;
- if (!gtk_accelerator_valid (accel_key, accel_mods))
+ g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
+ g_return_if_fail (closure != NULL);
+ g_return_if_fail (_gtk_accel_path_is_valid (accel_path));
+
+ if (closure->is_invalid)
return;
-
- entry = gtk_accel_group_lookup (accel_group, accel_key, accel_mods);
- if (!entry)
+
+ g_object_ref (accel_group);
+
+ if (gtk_accel_map_lookup_entry (accel_path, &key))
{
- GSList *slist;
-
- gtk_accel_group_ref (accel_group);
-
- entry = g_chunk_new (GtkAccelEntry, accel_entries_mem_chunk);
- entry->accel_group = accel_group;
- entry->accelerator_key = gdk_keyval_to_lower (accel_key);
- entry->accelerator_mods = accel_mods & accel_group->modifier_mask;
- entry->accel_flags = accel_flags & GTK_ACCEL_MASK;
- entry->object = object;
- entry->signal_id = accel_signal_id;
-
- g_hash_table_insert (accel_entry_hash_table, entry, entry);
-
- slist = gtk_object_get_data_by_id (object, accel_entries_key_id);
- if (!slist)
- gtk_signal_connect (object,
- "destroy",
- GTK_SIGNAL_FUNC (gtk_accel_group_delete_entries),
- NULL);
- slist = g_slist_prepend (slist, entry);
- gtk_object_set_data_by_id (object, accel_entries_key_id, slist);
+ accel_key = gdk_keyval_to_lower (key.accel_key);
+ accel_mods = key.accel_mods;
}
+
+ quick_accel_add (accel_group, accel_key, accel_mods, GTK_ACCEL_VISIBLE, closure,
+ g_quark_from_string (accel_path));
+
+ g_object_unref (accel_group);
}
-void
-gtk_accel_group_remove (GtkAccelGroup *accel_group,
- guint accel_key,
- GdkModifierType accel_mods,
- GtkObject *object)
+/**
+ * gtk_accel_group_disconnect:
+ * @accel_group: the accelerator group to remove an accelerator from
+ * @closure: (allow-none): the closure to remove from this accelerator group, or %NULL
+ * to remove all closures
+ * @returns: %TRUE if the closure was found and got disconnected
+ *
+ * Removes an accelerator previously installed through
+ * gtk_accel_group_connect().
+ *
+ * Since 2.20 @closure can be %NULL.
+ */
+gboolean
+gtk_accel_group_disconnect (GtkAccelGroup *accel_group,
+ GClosure *closure)
{
- GtkAccelEntry *entry;
- guint remove_accelerator_signal_id = 0;
-
- g_return_if_fail (accel_group != NULL);
- g_return_if_fail (object != NULL);
- g_return_if_fail (GTK_IS_OBJECT (object));
+ guint i;
+
+ g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), FALSE);
+
+ for (i = 0; i < accel_group->n_accels; i++)
+ if (accel_group->priv_accels[i].closure == closure || !closure)
+ {
+ g_object_ref (accel_group);
+ quick_accel_remove (accel_group, i);
+ g_object_unref (accel_group);
+ return TRUE;
+ }
+ return FALSE;
+}
+
+/**
+ * gtk_accel_group_disconnect_key:
+ * @accel_group: the accelerator group to install an accelerator in
+ * @accel_key: key value of the accelerator
+ * @accel_mods: modifier combination of the accelerator
+ * @returns: %TRUE if there was an accelerator which could be
+ * removed, %FALSE otherwise
+ *
+ * Removes an accelerator previously installed through
+ * gtk_accel_group_connect().
+ */
+gboolean
+gtk_accel_group_disconnect_key (GtkAccelGroup *accel_group,
+ guint accel_key,
+ GdkModifierType accel_mods)
+{
+ GtkAccelGroupEntry *entries;
+ GSList *slist, *clist = NULL;
+ gboolean removed_one = FALSE;
+ guint n;
+
+ g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), FALSE);
+
+ g_object_ref (accel_group);
- /* check for required signals in the objects branch
- */
- remove_accelerator_signal_id = gtk_signal_lookup ("remove-accelerator", GTK_OBJECT_TYPE (object));
- if (!remove_accelerator_signal_id)
+ accel_key = gdk_keyval_to_lower (accel_key);
+ entries = quick_accel_find (accel_group, accel_key, accel_mods, &n);
+ while (n--)
{
- g_warning ("gtk_accel_group_remove(): could not find signal \"%s\""
- "in the `%s' class ancestry",
- "remove-accelerator",
- gtk_type_name (GTK_OBJECT_TYPE (object)));
- return;
+ GClosure *closure = g_closure_ref (entries[n].closure);
+
+ clist = g_slist_prepend (clist, closure);
}
-
- /* prematurely abort if the entry is locked
- */
- if (accel_group->lock_count > 0)
- return;
- entry = gtk_accel_group_lookup (accel_group, accel_key, accel_mods);
- if (!entry ||
- entry->accel_flags & GTK_ACCEL_LOCKED)
- return;
- if (entry->object != object)
+
+ for (slist = clist; slist; slist = slist->next)
{
- g_warning ("gtk_accel_group_remove(): invalid object reference for accel-group entry");
- return;
+ GClosure *closure = slist->data;
+
+ removed_one |= gtk_accel_group_disconnect (accel_group, closure);
+ g_closure_unref (closure);
}
-
- /* make sure our structures stay alive
- */
- gtk_accel_group_ref (accel_group);
- gtk_object_ref (object);
-
- /* remove the entry
- */
- gtk_signal_emit (entry->object, remove_accelerator_signal_id,
- accel_group,
- gdk_keyval_to_lower (accel_key),
- accel_mods & accel_group->modifier_mask);
-
- /* and release the structures again
- */
- gtk_accel_group_unref (accel_group);
- gtk_object_unref (object);
+ g_slist_free (clist);
+
+ g_object_unref (accel_group);
+
+ return removed_one;
}
void
-gtk_accel_group_handle_remove (GtkObject *object,
- GtkAccelGroup *accel_group,
- guint accel_key,
- GdkModifierType accel_mods)
+_gtk_accel_group_reconnect (GtkAccelGroup *accel_group,
+ GQuark accel_path_quark)
{
- GtkAccelEntry *entry;
-
- g_return_if_fail (object != NULL);
- g_return_if_fail (GTK_IS_OBJECT (object));
- g_return_if_fail (accel_group != NULL);
-
- entry = gtk_accel_group_lookup (accel_group, accel_key, accel_mods);
- if (entry)
+ GSList *slist, *clist = NULL;
+ guint i;
+
+ g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
+
+ g_object_ref (accel_group);
+
+ for (i = 0; i < accel_group->n_accels; i++)
+ if (accel_group->priv_accels[i].accel_path_quark == accel_path_quark)
+ {
+ GClosure *closure = g_closure_ref (accel_group->priv_accels[i].closure);
+
+ clist = g_slist_prepend (clist, closure);
+ }
+
+ for (slist = clist; slist; slist = slist->next)
{
- if (entry->object == object)
- {
- GSList *slist;
-
- g_hash_table_remove (accel_entry_hash_table, entry);
-
- slist = gtk_object_get_data_by_id (object, accel_entries_key_id);
- if (slist)
- {
- slist = g_slist_remove (slist, entry);
- if (!slist)
- gtk_signal_disconnect_by_func (object,
- GTK_SIGNAL_FUNC (gtk_accel_group_delete_entries),
- NULL);
- gtk_object_set_data_by_id (object, accel_entries_key_id, slist);
-
- gtk_accel_group_unref (accel_group);
-
- g_chunk_free (entry, accel_entries_mem_chunk);
- }
- }
- else
- g_warning ("gtk_accel_group_handle_remove(): invalid object reference for accel-group entry");
+ GClosure *closure = slist->data;
+
+ gtk_accel_group_disconnect (accel_group, closure);
+ gtk_accel_group_connect_by_path (accel_group, g_quark_to_string (accel_path_quark), closure);
+ g_closure_unref (closure);
}
- else
- g_warning ("gtk_accel_group_handle_remove(): attempt to remove unexisting accel-group entry");
+ g_slist_free (clist);
+
+ g_object_unref (accel_group);
}
-guint
-gtk_accel_group_create_add (GtkType class_type,
- GtkSignalRunType signal_flags,
- guint handler_offset)
+/**
+ * gtk_accel_group_query:
+ * @accel_group: the accelerator group to query
+ * @accel_key: key value of the accelerator
+ * @accel_mods: modifier combination of the accelerator
+ * @n_entries: (allow-none): location to return the number of entries found, or %NULL
+ * @returns: (allow-none): an array of @n_entries #GtkAccelGroupEntry elements, or %NULL. The array is owned by GTK+ and must not be freed.
+ *
+ * Queries an accelerator group for all entries matching @accel_key and
+ * @accel_mods.
+ */
+GtkAccelGroupEntry*
+gtk_accel_group_query (GtkAccelGroup *accel_group,
+ guint accel_key,
+ GdkModifierType accel_mods,
+ guint *n_entries)
{
- g_return_val_if_fail (gtk_type_is_a (class_type, GTK_TYPE_OBJECT), 0);
-
- return gtk_signal_new ("add-accelerator",
- signal_flags,
- class_type,
- handler_offset,
- gtk_marshal_NONE__UINT_POINTER_UINT_UINT_ENUM,
- GTK_TYPE_NONE, 5,
- GTK_TYPE_UINT,
- GTK_TYPE_ACCEL_GROUP,
- GTK_TYPE_UINT,
- GTK_TYPE_GDK_MODIFIER_TYPE,
- GTK_TYPE_ACCEL_FLAGS);
+ GtkAccelGroupEntry *entries;
+ guint n;
+
+ g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), NULL);
+
+ entries = quick_accel_find (accel_group, gdk_keyval_to_lower (accel_key), accel_mods, &n);
+
+ if (n_entries)
+ *n_entries = entries ? n : 0;
+
+ return entries;
}
-guint
-gtk_accel_group_create_remove (GtkType class_type,
- GtkSignalRunType signal_flags,
- guint handler_offset)
+/**
+ * gtk_accel_group_from_accel_closure:
+ * @closure: a #GClosure
+ * @returns: (allow-none): the #GtkAccelGroup to which @closure is connected, or %NULL.
+ *
+ * Finds the #GtkAccelGroup to which @closure is connected;
+ * see gtk_accel_group_connect().
+ */
+GtkAccelGroup*
+gtk_accel_group_from_accel_closure (GClosure *closure)
{
- g_return_val_if_fail (gtk_type_is_a (class_type, GTK_TYPE_OBJECT), 0);
-
- return gtk_signal_new ("remove-accelerator",
- signal_flags,
- class_type,
- handler_offset,
- gtk_marshal_NONE__POINTER_UINT_UINT,
- GTK_TYPE_NONE, 3,
- GTK_TYPE_ACCEL_GROUP,
- GTK_TYPE_UINT,
- GTK_TYPE_GDK_MODIFIER_TYPE);
+ guint i;
+
+ g_return_val_if_fail (closure != NULL, NULL);
+
+ /* a few remarks on what we do here. in general, we need a way to reverse lookup
+ * accel_groups from closures that are being used in accel groups. this could
+ * be done e.g via a hashtable. it is however cheaper (memory wise) to just
+ * use the invalidation notifier on the closure itself (which we need to install
+ * anyway), that contains the accel group as data which, besides needing to peek
+ * a bit at closure internals, works just as good.
+ */
+ for (i = 0; i < G_CLOSURE_N_NOTIFIERS (closure); i++)
+ if (closure->notifiers[i].notify == accel_closure_invalidate)
+ return closure->notifiers[i].data;
+
+ return NULL;
}
-GSList*
-gtk_accel_groups_from_object (GtkObject *object)
+/**
+ * gtk_accel_group_activate:
+ * @accel_group: a #GtkAccelGroup
+ * @accel_quark: the quark for the accelerator name
+ * @acceleratable: the #GObject, usually a #GtkWindow, on which
+ * to activate the accelerator.
+ * @accel_key: accelerator keyval from a key event
+ * @accel_mods: keyboard state mask from a key event
+ *
+ * Finds the first accelerator in @accel_group
+ * that matches @accel_key and @accel_mods, and
+ * activates it.
+ *
+ * Returns: %TRUE if an accelerator was activated and handled this keypress
+ */
+gboolean
+gtk_accel_group_activate (GtkAccelGroup *accel_group,
+ GQuark accel_quark,
+ GObject *acceleratable,
+ guint accel_key,
+ GdkModifierType accel_mods)
{
- g_return_val_if_fail (object != NULL, NULL);
- g_return_val_if_fail (GTK_IS_OBJECT (object), NULL);
+ gboolean was_handled;
+
+ g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), FALSE);
+ g_return_val_if_fail (G_IS_OBJECT (acceleratable), FALSE);
- return gtk_object_get_data_by_id (object, accel_groups_key_id);
+ was_handled = FALSE;
+ g_signal_emit (accel_group, signal_accel_activate, accel_quark,
+ acceleratable, accel_key, accel_mods, &was_handled);
+
+ return was_handled;
}
-GSList*
-gtk_accel_group_entries_from_object (GtkObject *object)
+/**
+ * gtk_accel_groups_activate:
+ * @object: the #GObject, usually a #GtkWindow, on which
+ * to activate the accelerator.
+ * @accel_key: accelerator keyval from a key event
+ * @accel_mods: keyboard state mask from a key event
+ *
+ * Finds the first accelerator in any #GtkAccelGroup attached
+ * to @object that matches @accel_key and @accel_mods, and
+ * activates that accelerator.
+ *
+ * Returns: %TRUE if an accelerator was activated and handled this keypress
+ */
+gboolean
+gtk_accel_groups_activate (GObject *object,
+ guint accel_key,
+ GdkModifierType accel_mods)
{
- g_return_val_if_fail (object != NULL, NULL);
- g_return_val_if_fail (GTK_IS_OBJECT (object), NULL);
+ g_return_val_if_fail (G_IS_OBJECT (object), FALSE);
- return gtk_object_get_data_by_id (object, accel_entries_key_id);
+ if (gtk_accelerator_valid (accel_key, accel_mods))
+ {
+ gchar *accel_name;
+ GQuark accel_quark;
+ GSList *slist;
+
+ accel_name = gtk_accelerator_name (accel_key, (accel_mods & gtk_accelerator_get_default_mod_mask ()));
+ accel_quark = g_quark_from_string (accel_name);
+ g_free (accel_name);
+
+ for (slist = gtk_accel_groups_from_object (object); slist; slist = slist->next)
+ if (gtk_accel_group_activate (slist->data, accel_quark, object, accel_key, accel_mods))
+ return TRUE;
+ }
+
+ return FALSE;
}
+/**
+ * gtk_accelerator_valid:
+ * @keyval: a GDK keyval
+ * @modifiers: modifier mask
+ * @returns: %TRUE if the accelerator is valid
+ *
+ * Determines whether a given keyval and modifier mask constitute
+ * a valid keyboard accelerator. For example, the #GDK_a keyval
+ * plus #GDK_CONTROL_MASK is valid - this is a "Ctrl+a" accelerator.
+ * But, you can't, for instance, use the #GDK_Control_L keyval
+ * as an accelerator.
+ */
gboolean
gtk_accelerator_valid (guint keyval,
GdkModifierType modifiers)
{
- guint invalid_accelerator_vals[] = {
- GDK_BackSpace, GDK_Delete, GDK_KP_Delete,
+ static const guint invalid_accelerator_vals[] = {
GDK_Shift_L, GDK_Shift_R, GDK_Shift_Lock, GDK_Caps_Lock, GDK_ISO_Lock,
GDK_Control_L, GDK_Control_R, GDK_Meta_L, GDK_Meta_R,
- GDK_Super_L, GDK_Super_R, GDK_Hyper_L, GDK_Hyper_R,
+ GDK_Alt_L, GDK_Alt_R, GDK_Super_L, GDK_Super_R, GDK_Hyper_L, GDK_Hyper_R,
+ GDK_ISO_Level3_Shift, GDK_ISO_Next_Group, GDK_ISO_Prev_Group,
+ GDK_ISO_First_Group, GDK_ISO_Last_Group,
GDK_Mode_switch, GDK_Num_Lock, GDK_Multi_key,
GDK_Scroll_Lock, GDK_Sys_Req,
- GDK_Up, GDK_Down, GDK_Left, GDK_Right, GDK_Tab, GDK_ISO_Left_Tab,
- GDK_KP_Up, GDK_KP_Down, GDK_KP_Left, GDK_KP_Right, GDK_KP_Tab,
+ GDK_Tab, GDK_ISO_Left_Tab, GDK_KP_Tab,
GDK_First_Virtual_Screen, GDK_Prev_Virtual_Screen,
GDK_Next_Virtual_Screen, GDK_Last_Virtual_Screen,
GDK_Terminate_Server, GDK_AudibleBell_Enable,
0
};
- guint *ac_val;
+ static const guint invalid_unmodified_vals[] = {
+ GDK_Up, GDK_Down, GDK_Left, GDK_Right,
+ GDK_KP_Up, GDK_KP_Down, GDK_KP_Left, GDK_KP_Right,
+ 0
+ };
+ const guint *ac_val;
modifiers &= GDK_MODIFIER_MASK;
return FALSE;
}
+ if (!modifiers)
+ {
+ ac_val = invalid_unmodified_vals;
+ while (*ac_val)
+ {
+ if (keyval == *ac_val++)
+ return FALSE;
+ }
+ }
+
return TRUE;
}
(string[8] == '>'));
}
+static inline gboolean
+is_meta (const gchar *string)
+{
+ return ((string[0] == '<') &&
+ (string[1] == 'm' || string[1] == 'M') &&
+ (string[2] == 'e' || string[2] == 'E') &&
+ (string[3] == 't' || string[3] == 'T') &&
+ (string[4] == 'a' || string[4] == 'A') &&
+ (string[5] == '>'));
+}
+
+static inline gboolean
+is_super (const gchar *string)
+{
+ return ((string[0] == '<') &&
+ (string[1] == 's' || string[1] == 'S') &&
+ (string[2] == 'u' || string[2] == 'U') &&
+ (string[3] == 'p' || string[3] == 'P') &&
+ (string[4] == 'e' || string[4] == 'E') &&
+ (string[5] == 'r' || string[5] == 'R') &&
+ (string[6] == '>'));
+}
+
+static inline gboolean
+is_hyper (const gchar *string)
+{
+ return ((string[0] == '<') &&
+ (string[1] == 'h' || string[1] == 'H') &&
+ (string[2] == 'y' || string[2] == 'Y') &&
+ (string[3] == 'p' || string[3] == 'P') &&
+ (string[4] == 'e' || string[4] == 'E') &&
+ (string[5] == 'r' || string[5] == 'R') &&
+ (string[6] == '>'));
+}
+
+/**
+ * gtk_accelerator_parse:
+ * @accelerator: string representing an accelerator
+ * @accelerator_key: return location for accelerator keyval
+ * @accelerator_mods: return location for accelerator modifier mask
+ *
+ * Parses a string representing an accelerator. The
+ * format looks like "<Control>a" or "<Shift><Alt>F1" or
+ * "<Release>z" (the last one is for key release).
+ * The parser is fairly liberal and allows lower or upper case,
+ * and also abbreviations such as "<Ctl>" and "<Ctrl>".
+ *
+ * If the parse fails, @accelerator_key and @accelerator_mods will
+ * be set to 0 (zero).
+ */
void
-gtk_accelerator_parse (const gchar *accelerator,
- guint *accelerator_key,
- GdkModifierType*accelerator_mods)
+gtk_accelerator_parse (const gchar *accelerator,
+ guint *accelerator_key,
+ GdkModifierType *accelerator_mods)
{
guint keyval;
GdkModifierType mods;
}
else if (len >= 6 && is_modx (accelerator))
{
- guint mod_vals[] = {
+ static const guint mod_vals[] = {
GDK_MOD1_MASK, GDK_MOD2_MASK, GDK_MOD3_MASK,
GDK_MOD4_MASK, GDK_MOD5_MASK
};
len -= 5;
mods |= GDK_MOD1_MASK;
}
+ else if (len >= 6 && is_meta (accelerator))
+ {
+ accelerator += 6;
+ len -= 6;
+ mods |= GDK_META_MASK;
+ }
+ else if (len >= 7 && is_hyper (accelerator))
+ {
+ accelerator += 7;
+ len -= 7;
+ mods |= GDK_HYPER_MASK;
+ }
+ else if (len >= 7 && is_super (accelerator))
+ {
+ accelerator += 7;
+ len -= 7;
+ mods |= GDK_SUPER_MASK;
+ }
else
{
gchar last_ch;
*accelerator_mods = mods;
}
+/**
+ * gtk_accelerator_name:
+ * @accelerator_key: accelerator keyval
+ * @accelerator_mods: accelerator modifier mask
+ *
+ * Converts an accelerator keyval and modifier mask
+ * into a string parseable by gtk_accelerator_parse().
+ * For example, if you pass in #GDK_q and #GDK_CONTROL_MASK,
+ * this function returns "<Control>q".
+ *
+ * If you need to display accelerators in the user interface,
+ * see gtk_accelerator_get_label().
+ *
+ * Returns: a newly-allocated accelerator name
+ */
gchar*
gtk_accelerator_name (guint accelerator_key,
GdkModifierType accelerator_mods)
static const gchar text_mod3[] = "<Mod3>";
static const gchar text_mod4[] = "<Mod4>";
static const gchar text_mod5[] = "<Mod5>";
+ static const gchar text_meta[] = "<Meta>";
+ static const gchar text_super[] = "<Super>";
+ static const gchar text_hyper[] = "<Hyper>";
guint l;
gchar *keyval_name;
gchar *accelerator;
if (accelerator_mods & GDK_MOD5_MASK)
l += sizeof (text_mod5) - 1;
l += strlen (keyval_name);
+ if (accelerator_mods & GDK_META_MASK)
+ l += sizeof (text_meta) - 1;
+ if (accelerator_mods & GDK_HYPER_MASK)
+ l += sizeof (text_hyper) - 1;
+ if (accelerator_mods & GDK_SUPER_MASK)
+ l += sizeof (text_super) - 1;
accelerator = g_new (gchar, l + 1);
strcpy (accelerator + l, text_mod5);
l += sizeof (text_mod5) - 1;
}
+ if (accelerator_mods & GDK_META_MASK)
+ {
+ strcpy (accelerator + l, text_meta);
+ l += sizeof (text_meta) - 1;
+ }
+ if (accelerator_mods & GDK_HYPER_MASK)
+ {
+ strcpy (accelerator + l, text_hyper);
+ l += sizeof (text_hyper) - 1;
+ }
+ if (accelerator_mods & GDK_SUPER_MASK)
+ {
+ strcpy (accelerator + l, text_super);
+ l += sizeof (text_super) - 1;
+ }
strcpy (accelerator + l, keyval_name);
return accelerator;
}
+/**
+ * gtk_accelerator_get_label:
+ * @accelerator_key: accelerator keyval
+ * @accelerator_mods: accelerator modifier mask
+ *
+ * Converts an accelerator keyval and modifier mask into a string
+ * which can be used to represent the accelerator to the user.
+ *
+ * Returns: a newly-allocated string representing the accelerator.
+ *
+ * Since: 2.6
+ */
+gchar*
+gtk_accelerator_get_label (guint accelerator_key,
+ GdkModifierType accelerator_mods)
+{
+ GtkAccelLabelClass *klass;
+ gchar *label;
+
+ klass = g_type_class_ref (GTK_TYPE_ACCEL_LABEL);
+ label = _gtk_accel_label_class_get_accelerator_label (klass,
+ accelerator_key,
+ accelerator_mods);
+ g_type_class_unref (klass); /* klass is kept alive since gtk uses static types */
+
+ return label;
+}
+
+/**
+ * gtk_accelerator_set_default_mod_mask:
+ * @default_mod_mask: accelerator modifier mask
+ *
+ * Sets the modifiers that will be considered significant for keyboard
+ * accelerators. The default mod mask is #GDK_CONTROL_MASK |
+ * #GDK_SHIFT_MASK | #GDK_MOD1_MASK | #GDK_SUPER_MASK |
+ * #GDK_HYPER_MASK | #GDK_META_MASK, that is, Control, Shift, Alt,
+ * Super, Hyper and Meta. Other modifiers will by default be ignored
+ * by #GtkAccelGroup.
+ * You must include at least the three modifiers Control, Shift
+ * and Alt in any value you pass to this function.
+ *
+ * The default mod mask should be changed on application startup,
+ * before using any accelerator groups.
+ */
void
gtk_accelerator_set_default_mod_mask (GdkModifierType default_mod_mask)
{
- default_accel_mod_mask = default_mod_mask & GDK_MODIFIER_MASK;
+ default_accel_mod_mask = (default_mod_mask & GDK_MODIFIER_MASK) |
+ (GDK_CONTROL_MASK | GDK_SHIFT_MASK | GDK_MOD1_MASK);
}
+/**
+ * gtk_accelerator_get_default_mod_mask:
+ * @returns: the default accelerator modifier mask
+ *
+ * Gets the value set by gtk_accelerator_set_default_mod_mask().
+ */
guint
gtk_accelerator_get_default_mod_mask (void)
{
return default_accel_mod_mask;
}
+
+#define __GTK_ACCEL_GROUP_C__
+#include "gtkaliasdef.c"
projects / ~andy / gtk / blobdiff