← Back to branch summary

~ubuntu-branches/ubuntu/precise/atk1.0/precise

« back to all changes in this revision

Viewing changes to atk/atkaction.c

  • Committer: Package Import Robot
  • Author(s): Luke Yelavich
  • Date: 2012-03-07 09:14:51 UTC
  • mfrom: (1.2.41)
  • Revision ID: package-import@ubuntu.com-20120307091451-lvrxjpc5wy2okfyt
Tags: 2.3.91-0ubuntu1
* New upstream release
  - Bug 665549: add sanity-check of atk_text_get_text
  - Bug 668441: atk_action_get_keybinding docs are confusing and need
    updating
  - Using abstract atk_object_get_name to check accessible-name
    notification
  - Updated Belarusian, Estonian, Hungarian, Turkish, Norwegian,
    Ukranian and Uyghur translations

Show diffs side-by-side

added added

removed removed

Lines of Context:
atk/atkaction.c
185
185
/**
186
186
 * atk_action_get_keybinding:
187
187
 * @action: a #GObject instance that implements AtkActionIface
188
 
 * @i: the action index corresponding to the action to be performed 
189
 
 *
190
 
 * Returns a keybinding associated with this action, if one exists.
191
 
 * The returned string is in the format "<a>;<b>;<c>"
192
 
 * (i.e. semicolon-delimited), where <a> is the keybinding which
193
 
 * activates the object if it is presently enabled onscreen, 
194
 
 * <b> corresponds to the keybinding or sequence of keys
195
 
 * which invokes the action even if the relevant element is not
196
 
 * currently posted on screen (for instance, for a menu item it
197
 
 * posts the parent menus before invoking).  The last token in the
198
 
 * above string, if non-empty, represents a keyboard shortcut which
199
 
 * invokes the same action without posting the component or its
200
 
 * enclosing menus or dialogs. 
201
 
 *
202
 
 * Returns a string representing the available keybindings, or %NULL
 
188
 * @i: the action index corresponding to the action to be performed
 
189
 *
 
190
 * Gets the keybinding which can be used to activate this action, if one
 
191
 * exists. The string returned should contain localized, human-readable,
 
192
 * key sequences as they would appear when displayed on screen. It must
 
193
 * be in the format "mnemonic;sequence;shortcut".
 
194
 *
 
195
 * - The mnemonic key activates the object if it is presently enabled onscreen.
 
196
 *   This typically corresponds to the underlined letter within the widget.
 
197
 *   Example: "n" in a traditional "New..." menu item or the "a" in "Apply" for
 
198
 *   a button.
 
199
 * - The sequence is the full list of keys which invoke the action even if the
 
200
 *   relevant element is not currently shown on screen. For instance, for a menu
 
201
 *   item the sequence is the keybindings used to open the parent menus before
 
202
 *   invoking. The sequence string is colon-delimited. Example: "Alt+F:N" in a
 
203
 *   traditional "New..." menu item.
 
204
 * - The shortcut, if it exists, will invoke the same action without showing
 
205
 *   the component or its enclosing menus or dialogs. Example: "Ctrl+N" in a
 
206
 *   traditional "New..." menu item.
 
207
 *
 
208
 * Example: For a traditional "New..." menu item, the expected return value
 
209
 * would be: "N;Alt+F:N;Ctrl+N" for the English locale and "N;Alt+D:N;Strg+N"
 
210
 * for the German locale. If, hypothetically, this menu item lacked a mnemonic,
 
211
 * it would be represented by ";;Ctrl+N" and ";;Strg+N" respectively.
 
212
 *
 
213
 * Returns the keybinding which can be used to activate this action, or %NULL
203
214
 * if there is no keybinding for this action.
204
215
 *
205
216
 **/