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

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