Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkaccelgroup.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Keyboard Accelerator Groups
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5
   6 Groups of global keyboard accelerators for an entire #GtkWindow
   7
   8 <!-- ##### SECTION Long_Description ##### -->
   9 <para id="GtkAccelGroup">
  10 A #GtkAccelGroup represents a group of keyboard accelerators,
  11 typically attached to a toplevel #GtkWindow (with
  12 gtk_window_add_accel_group()). Usually you won't need to create a
  13 #GtkAccelGroup directly; instead, when using #GtkItemFactory, GTK+
  14 automatically sets up the accelerators for your menus in the item
  15 factory's #GtkAccelGroup.
  16 </para>
  17
  18 <para>
  19 Note that <firstterm>accelerators</firstterm> are different from
  20 <firstterm>mnemonics</firstterm>. Accelerators are shortcuts for
  21 activating a menu item; they appear alongside the menu item they're a
  22 shortcut for. For example "Ctrl+Q" might appear alongside the "Quit"
  23 menu item. Mnemonics are shortcuts for GUI elements such as text
  24 entries or buttons; they appear as underlined characters. See
  25 gtk_label_new_with_mnemonic(). Menu items can have both accelerators
  26 and mnemonics, of course.
  27 </para>
  28
  29 <!-- ##### SECTION See_Also ##### -->
  30 <para>
  31 gtk_window_add_accel_group(), gtk_accel_map_change_entry(),
  32 gtk_item_factory_new(), gtk_label_new_with_mnemonic()
  33 </para>
  34
  35 <!-- ##### STRUCT GtkAccelGroup ##### -->
  36 <para>
  37 An object representing and maintaining a group of accelerators.
  38 </para>
  39
  40
  41 <!-- ##### FUNCTION gtk_accel_group_new ##### -->
  42 <para>
  43
  44 </para>
  45
  46 @Returns:
  47
  48
  49 <!-- ##### MACRO gtk_accel_group_ref ##### -->
  50 <para>
  51 Deprecated equivalent of g_object_ref().
  52 </para>
  53
  54 @Returns:
  55
  56
  57 <!-- ##### MACRO gtk_accel_group_unref ##### -->
  58 <para>
  59 Deprecated equivalent of g_object_unref().
  60 </para>
  61
  62
  63
  64 <!-- ##### FUNCTION gtk_accel_group_connect ##### -->
  65 <para>
  66
  67 </para>
  68
  69 @accel_group:
  70 @accel_key:
  71 @accel_mods:
  72 @accel_flags:
  73 @closure:
  74 <!-- # Unused Parameters # -->
  75 @accel_path_quark:
  76 @path_quark:
  77
  78
  79 <!-- ##### FUNCTION gtk_accel_group_connect_by_path ##### -->
  80 <para>
  81
  82 </para>
  83
  84 @accel_group:
  85 @accel_path:
  86 @closure:
  87
  88
  89 <!-- ##### USER_FUNCTION GtkAccelGroupActivate ##### -->
  90 <para>
  91
  92 </para>
  93
  94 @accel_group:
  95 @acceleratable:
  96 @keyval:
  97 @modifier:
  98 @Returns:
  99
 100
 101 <!-- ##### USER_FUNCTION GtkAccelGroupFindFunc ##### -->
 102 <para>
 103
 104 </para>
 105
 106 @key:
 107 @closure:
 108 @data:
 109 @Returns:
 110
 111
 112 <!-- ##### FUNCTION gtk_accel_group_disconnect ##### -->
 113 <para>
 114
 115 </para>
 116
 117 @accel_group:
 118 @closure:
 119 @Returns:
 120 <!-- # Unused Parameters # -->
 121 @accel_key:
 122 @accel_mods:
 123
 124
 125 <!-- ##### FUNCTION gtk_accel_group_disconnect_key ##### -->
 126 <para>
 127
 128 </para>
 129
 130 @accel_group:
 131 @accel_key:
 132 @accel_mods:
 133 @Returns:
 134
 135
 136 <!-- ##### FUNCTION gtk_accel_group_query ##### -->
 137 <para>
 138
 139 </para>
 140
 141 @accel_group:
 142 @accel_key:
 143 @accel_mods:
 144 @n_entries:
 145 @Returns:
 146
 147
 148 <!-- ##### FUNCTION gtk_accel_group_lock ##### -->
 149 <para>
 150
 151 </para>
 152
 153 @accel_group:
 154
 155
 156 <!-- ##### FUNCTION gtk_accel_group_unlock ##### -->
 157 <para>
 158
 159 </para>
 160
 161 @accel_group:
 162
 163
 164 <!-- ##### FUNCTION gtk_accel_group_from_accel_closure ##### -->
 165 <para>
 166
 167 </para>
 168
 169 @closure:
 170 @Returns:
 171
 172
 173 <!-- ##### FUNCTION gtk_accel_groups_activate ##### -->
 174 <para>
 175
 176 </para>
 177
 178 @object:
 179 @accel_key:
 180 @accel_mods:
 181 @Returns:
 182 <!-- # Unused Parameters # -->
 183 @acceleratable:
 184
 185
 186 <!-- ##### FUNCTION gtk_accel_groups_from_object ##### -->
 187 <para>
 188
 189 </para>
 190
 191 @object:
 192 @Returns:
 193
 194
 195 <!-- ##### FUNCTION gtk_accel_group_find ##### -->
 196 <para>
 197
 198 </para>
 199
 200 @accel_group:
 201 @find_func:
 202 @data:
 203 @Returns:
 204
 205
 206 <!-- ##### STRUCT GtkAccelKey ##### -->
 207 <para>
 208
 209 </para>
 210
 211 @accel_key:
 212 @accel_mods:
 213 @accel_flags:
 214
 215 <!-- ##### FUNCTION gtk_accelerator_valid ##### -->
 216 <para>
 217
 218 </para>
 219
 220 @keyval:
 221 @modifiers:
 222 @Returns:
 223
 224
 225 <!-- ##### FUNCTION gtk_accelerator_parse ##### -->
 226 <para>
 227
 228 </para>
 229
 230 @accelerator:
 231 @accelerator_key:
 232 @accelerator_mods:
 233
 234
 235 <!-- ##### FUNCTION gtk_accelerator_name ##### -->
 236 <para>
 237
 238 </para>
 239
 240 @accelerator_key:
 241 @accelerator_mods:
 242 @Returns:
 243
 244
 245 <!-- ##### FUNCTION gtk_accelerator_set_default_mod_mask ##### -->
 246 <para>
 247
 248 </para>
 249
 250 @default_mod_mask:
 251
 252
 253 <!-- ##### FUNCTION gtk_accelerator_get_default_mod_mask ##### -->
 254 <para>
 255
 256 </para>
 257
 258 @Returns:
 259
 260