forked from AuroraMiddleware/gtk
002d2b73cb
2001-09-08 Havoc Pennington <hp@pobox.com> * gtk/gtk-sections.txt: move some of the accel group functions into a Private subsection 2001-09-08 Havoc Pennington <hp@pobox.com> * gtk/gtkaccelgroup.c: add docs to functions that I can imagine people might want to use
198 lines
3.0 KiB
Plaintext
198 lines
3.0 KiB
Plaintext
<!-- ##### SECTION Title ##### -->
|
|
Keyboard Accelerators
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
|
|
|
global keyboard accelerators (for an entire #GtkWindow)
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
<para>
|
|
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.
|
|
</para>
|
|
|
|
<para>
|
|
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.
|
|
</para>
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
<para>
|
|
gtk_label_new_with_mnemonic(), gtk_window_add_accel_group()
|
|
</para>
|
|
|
|
<!-- ##### STRUCT GtkAccelGroup ##### -->
|
|
<para>
|
|
On opaque data type representing a group of accelerators.
|
|
</para>
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_accel_group_new ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_accel_group_get_default ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_accel_group_ref ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@accel_group:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_accel_group_unref ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@accel_group:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_accel_group_activate ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@accel_group:
|
|
@accel_key:
|
|
@accel_mods:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_accel_groups_activate ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@object:
|
|
@accel_key:
|
|
@accel_mods:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_accel_group_attach ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@accel_group:
|
|
@object:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_accel_group_detach ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@accel_group:
|
|
@object:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_accel_group_add ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@accel_group:
|
|
@accel_key:
|
|
@accel_mods:
|
|
@accel_flags:
|
|
@object:
|
|
@accel_signal:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_accel_group_remove ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@accel_group:
|
|
@accel_key:
|
|
@accel_mods:
|
|
@object:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_accel_group_lock ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@accel_group:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_accel_group_unlock ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@accel_group:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_accelerator_valid ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@keyval:
|
|
@modifiers:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_accelerator_parse ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@accelerator:
|
|
@accelerator_key:
|
|
@accelerator_mods:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_accelerator_name ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@accelerator_key:
|
|
@accelerator_mods:
|
|
@Returns:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_accelerator_set_default_mod_mask ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@default_mod_mask:
|
|
|
|
|
|
<!-- ##### FUNCTION gtk_accelerator_get_default_mod_mask ##### -->
|
|
<para>
|
|
|
|
</para>
|
|
|
|
@Returns:
|
|
|
|
|