#include <stdlib.h>
#include "gtkaccelgroup.h"
+#include "gtkaccelgroupprivate.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 "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.
+ */
+
+#define GTK_ACCEL_GROUP_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), GTK_TYPE_ACCEL_GROUP, GtkAccelGroupPrivate))
+
/* --- prototypes --- */
static void gtk_accel_group_finalize (GObject *object);
static void gtk_accel_group_get_property (GObject *object,
G_TYPE_UINT,
GDK_TYPE_MODIFIER_TYPE,
G_TYPE_CLOSURE);
+
+ g_type_class_add_private (object_class, sizeof (GtkAccelGroupPrivate));
}
static void
GtkAccelGroup *accel_group = GTK_ACCEL_GROUP (object);
guint i;
- for (i = 0; i < accel_group->n_accels; i++)
+ for (i = 0; i < accel_group->priv->n_accels; i++)
{
- GtkAccelGroupEntry *entry = &accel_group->priv_accels[i];
+ GtkAccelGroupEntry *entry = &accel_group->priv->priv_accels[i];
if (entry->accel_path_quark)
{
g_closure_unref (entry->closure);
}
- g_free (accel_group->priv_accels);
+ g_free (accel_group->priv->priv_accels);
G_OBJECT_CLASS (gtk_accel_group_parent_class)->finalize (object);
}
switch (param_id)
{
case PROP_IS_LOCKED:
- g_value_set_boolean (value, accel_group->lock_count > 0);
+ g_value_set_boolean (value, accel_group->priv->lock_count > 0);
break;
case PROP_MODIFIER_MASK:
- g_value_set_flags (value, accel_group->modifier_mask);
+ g_value_set_flags (value, accel_group->priv->modifier_mask);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
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->acceleratables = NULL;
- accel_group->n_accels = 0;
- accel_group->priv_accels = NULL;
+ GtkAccelGroupPrivate *priv = GTK_ACCEL_GROUP_GET_PRIVATE (accel_group);
+
+ priv->lock_count = 0;
+ priv->modifier_mask = gtk_accelerator_get_default_mod_mask ();
+ priv->acceleratables = NULL;
+ priv->n_accels = 0;
+ priv->priv_accels = NULL;
+
+ accel_group->priv = priv;
}
/**
{
g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), FALSE);
- return accel_group->lock_count > 0;
+ return accel_group->priv->lock_count > 0;
}
/**
{
g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), 0);
- return accel_group->modifier_mask;
+ return accel_group->priv->modifier_mask;
}
static void
GtkAccelGroup *accel_group;
accel_group = slist->data;
- accel_group->acceleratables = g_slist_remove (accel_group->acceleratables, stale_object);
+ accel_group->priv->acceleratables = g_slist_remove (accel_group->priv->acceleratables, stale_object);
g_object_unref (accel_group);
}
g_slist_free (free_list);
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);
+ g_return_if_fail (g_slist_find (accel_group->priv->acceleratables, object) == NULL);
g_object_ref (accel_group);
- accel_group->acceleratables = g_slist_prepend (accel_group->acceleratables, object);
+ accel_group->priv->acceleratables = g_slist_prepend (accel_group->priv->acceleratables, object);
slist = g_object_get_qdata (object, quark_acceleratable_groups);
if (slist)
g_object_weak_unref (object,
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);
+ g_return_if_fail (g_slist_find (accel_group->priv->acceleratables, object) != NULL);
- accel_group->acceleratables = g_slist_remove (accel_group->acceleratables, object);
+ accel_group->priv->acceleratables = g_slist_remove (accel_group->priv->acceleratables, object);
slist = g_object_get_qdata (object, quark_acceleratable_groups);
g_object_weak_unref (object,
(GWeakNotify) accel_group_weak_ref_detach,
/**
* gtk_accel_groups_from_object:
- * @object: a #GObject, usually a #GtkWindow
- * @returns: a list of all accel groups which are attached to @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_val_if_fail (find_func != NULL, NULL);
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,
+ for (i = 0; i < accel_group->priv->n_accels; i++)
+ if (find_func (&accel_group->priv->priv_accels[i].key,
+ accel_group->priv->priv_accels[i].closure,
data))
{
- key = &accel_group->priv_accels[i].key;
+ key = &accel_group->priv->priv_accels[i].key;
break;
}
g_object_unref (accel_group);
{
g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
- accel_group->lock_count += 1;
+ accel_group->priv->lock_count += 1;
- if (accel_group->lock_count == 1) {
+ if (accel_group->priv->lock_count == 1) {
/* State change from unlocked to locked */
g_object_notify (G_OBJECT (accel_group), "is-locked");
}
gtk_accel_group_unlock (GtkAccelGroup *accel_group)
{
g_return_if_fail (GTK_IS_ACCEL_GROUP (accel_group));
- g_return_if_fail (accel_group->lock_count > 0);
+ g_return_if_fail (accel_group->priv->lock_count > 0);
- accel_group->lock_count -= 1;
+ accel_group->priv->lock_count -= 1;
- if (accel_group->lock_count < 1) {
+ if (accel_group->priv->lock_count < 1) {
/* State change from locked to unlocked */
g_object_notify (G_OBJECT (accel_group), "is-locked");
}
GClosure *closure,
GQuark path_quark)
{
- guint pos, i = accel_group->n_accels++;
+ guint pos, i = accel_group->priv->n_accels++;
GtkAccelGroupEntry key;
/* 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)
+ if (bsearch_compare_accels (&key, accel_group->priv->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;
+ accel_group->priv->priv_accels = g_renew (GtkAccelGroupEntry, accel_group->priv->priv_accels, accel_group->priv->n_accels);
+ g_memmove (accel_group->priv->priv_accels + pos + 1, accel_group->priv->priv_accels + pos,
+ (i - pos) * sizeof (accel_group->priv->priv_accels[0]));
+ accel_group->priv->priv_accels[pos].key.accel_key = accel_key;
+ accel_group->priv->priv_accels[pos].key.accel_mods = accel_mods;
+ accel_group->priv->priv_accels[pos].key.accel_flags = accel_flags;
+ accel_group->priv->priv_accels[pos].closure = g_closure_ref (closure);
+ accel_group->priv->priv_accels[pos].accel_path_quark = path_quark;
g_closure_sink (closure);
/* handle closure invalidation and reverse lookups */
guint pos)
{
GQuark accel_quark = 0;
- GtkAccelGroupEntry *entry = accel_group->priv_accels + pos;
+ GtkAccelGroupEntry *entry = accel_group->priv->priv_accels + pos;
guint accel_key = entry->key.accel_key;
GdkModifierType accel_mods = entry->key.accel_mods;
GClosure *closure = entry->closure;
_gtk_accel_map_remove_group (g_quark_to_string (entry->accel_path_quark), accel_group);
/* physically remove */
- accel_group->n_accels -= 1;
+ accel_group->priv->n_accels -= 1;
g_memmove (entry, entry + 1,
- (accel_group->n_accels - pos) * sizeof (accel_group->priv_accels[0]));
+ (accel_group->priv->n_accels - pos) * sizeof (accel_group->priv->priv_accels[0]));
/* and notify */
if (accel_quark)
*count_p = 0;
- if (!accel_group->n_accels)
+ if (!accel_group->priv->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);
+ entry = bsearch (&key, accel_group->priv->priv_accels, accel_group->priv->n_accels,
+ sizeof (accel_group->priv->priv_accels[0]), bsearch_compare_accels);
if (!entry)
return NULL;
/* step back to the first member */
- for (; entry > accel_group->priv_accels; entry--)
+ for (; entry > accel_group->priv->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)++)
+ for (; entry + *count_p < accel_group->priv->priv_accels + accel_group->priv->n_accels; (*count_p)++)
if (entry[*count_p].key.accel_key != accel_key ||
entry[*count_p].key.accel_mods != accel_mods)
break;
/**
* gtk_accel_group_disconnect:
* @accel_group: the accelerator group to remove an accelerator from
- * @closure: the closure to remove from this accelerator group
+ * @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,
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)
+ for (i = 0; i < accel_group->priv->n_accels; i++)
+ if (accel_group->priv->priv_accels[i].closure == closure)
{
g_object_ref (accel_group);
quick_accel_remove (accel_group, i);
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)
+ for (i = 0; i < accel_group->priv->n_accels; i++)
+ if (accel_group->priv->priv_accels[i].accel_path_quark == accel_path_quark)
{
- GClosure *closure = g_closure_ref (accel_group->priv_accels[i].closure);
+ GClosure *closure = g_closure_ref (accel_group->priv->priv_accels[i].closure);
clist = g_slist_prepend (clist, closure);
}
g_object_unref (accel_group);
}
+GSList*
+_gtk_accel_group_get_accelerables (GtkAccelGroup *accel_group)
+{
+ g_return_val_if_fail (GTK_IS_ACCEL_GROUP (accel_group), NULL);
+
+ return accel_group->priv->acceleratables;
+}
+
/**
* 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: location to return the number of entries found, or %NULL
- * @returns: an array of @n_entries #GtkAccelGroupEntry elements, or %NULL. The array is owned by GTK+ and must not be freed.
+ * @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.
/**
* gtk_accel_group_from_accel_closure:
* @closure: a #GClosure
- * @returns: the #GtkAccelGroup to which @closure is connected, or %NULL.
+ * @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().
GdkModifierType modifiers)
{
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_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_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,
+ GDK_KEY_Shift_L, GDK_KEY_Shift_R, GDK_KEY_Shift_Lock, GDK_KEY_Caps_Lock, GDK_KEY_ISO_Lock,
+ GDK_KEY_Control_L, GDK_KEY_Control_R, GDK_KEY_Meta_L, GDK_KEY_Meta_R,
+ GDK_KEY_Alt_L, GDK_KEY_Alt_R, GDK_KEY_Super_L, GDK_KEY_Super_R, GDK_KEY_Hyper_L, GDK_KEY_Hyper_R,
+ GDK_KEY_ISO_Level3_Shift, GDK_KEY_ISO_Next_Group, GDK_KEY_ISO_Prev_Group,
+ GDK_KEY_ISO_First_Group, GDK_KEY_ISO_Last_Group,
+ GDK_KEY_Mode_switch, GDK_KEY_Num_Lock, GDK_KEY_Multi_key,
+ GDK_KEY_Scroll_Lock, GDK_KEY_Sys_Req,
+ GDK_KEY_Tab, GDK_KEY_ISO_Left_Tab, GDK_KEY_KP_Tab,
+ GDK_KEY_First_Virtual_Screen, GDK_KEY_Prev_Virtual_Screen,
+ GDK_KEY_Next_Virtual_Screen, GDK_KEY_Last_Virtual_Screen,
+ GDK_KEY_Terminate_Server, GDK_KEY_AudibleBell_Enable,
0
};
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,
+ GDK_KEY_Up, GDK_KEY_Down, GDK_KEY_Left, GDK_KEY_Right,
+ GDK_KEY_KP_Up, GDK_KEY_KP_Down, GDK_KEY_KP_Left, GDK_KEY_KP_Right,
0
};
const guint *ac_val;
/**
* gtk_accelerator_parse:
* @accelerator: string representing an accelerator
- * @accelerator_key: return location for accelerator keyval
- * @accelerator_mods: return location for accelerator modifier mask
+ * @accelerator_key: (out): return location for accelerator keyval
+ * @accelerator_mods: (out): 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>".
+ * Key names are parsed using gdk_keyval_from_name(). For character keys the
+ * name is not the symbol, but the lowercase name, e.g. one would use
+ * "<Ctrl>minus" instead of "<Ctrl>-".
*
* If the parse fails, @accelerator_key and @accelerator_mods will
* be set to 0 (zero).
*
* Gets the value set by gtk_accelerator_set_default_mod_mask().
*/
-guint
+GdkModifierType
gtk_accelerator_get_default_mod_mask (void)
{
return default_accel_mod_mask;
}
-
-#define __GTK_ACCEL_GROUP_C__
-#include "gtkaliasdef.c"