Atspi.Action¶

Implementations:: Atspi.Accessible

Methods¶

	`do_action` (i)
	`get_action_description` (i)
	`get_action_name` (i)
	`get_key_binding` (i)
	`get_localized_name` (i)
	`get_n_actions` ()

Virtual Methods¶

None

Properties¶

None

Signals¶

None

Fields¶

None

Class Details¶

class Atspi.Action¶

Bases:: GObject.GInterface

do_action(i)¶

Parameters:: i (int) – an integer specifying which action to invoke.
Raises:: GLib.Error
Returns:: True if the action is successfully invoked, otherwise False.
Return type:: bool

Invoke the action indicated by #index.

get_action_description(i)¶

Parameters:: i (int) – an integer indicating which action to query.
Raises:: GLib.Error
Returns:: a UTF-8 string describing the ‘i-th’ invocable action.
Return type:: str

Get the description of ‘i-th’ action invocable on an object implementing Atspi.Action.

Deprecated since version 2.10: Use Atspi.Action.get_action_description instead.

get_action_name(i)¶

Parameters:: i (int) – an integer indicating which action to query.
Raises:: GLib.Error
Returns:: the non-localized name of the action, as a UTF-8 string.
Return type:: str

Get the name of the ‘i-th’ action invocable on an object implementing Atspi.Action.

Deprecated since version 2.10: Use Atspi.Action.get_action_name instead.

get_key_binding(i)¶

Parameters:: i (int) – an integer indicating which action to query.
Raises:: GLib.Error
Returns:: a UTF-8 string which can be parsed to determine the i-th invocable action’s keybindings.
Return type:: str

Get the keybindings for the i-th action invocable on an object implementing Atspi.Action, if any are defined. The keybindings string format is as follows: there are multiple parts to a keybinding string (typically 3). They are delimited with “;”. The first is the action’s keybinding which is usable if the object implementing the action is currently posted to the screen, e.g. if a menu is posted then these keybindings for the corresponding menu-items are available. The second keybinding substring is the full key sequence necessary to post the action’s widget and activate it, e.g. for a menu item such as “File->Open” it would both post the menu and activate the item. Thus the second keybinding string is available during the lifetime of the containing toplevel window as a whole, whereas the first keybinding string only works while the object implementing AtkAction is posted. The third (and optional) keybinding string is the “keyboard shortcut” which invokes the action without posting any menus. Meta-keys are indicated by the conventional strings “<Control>”, “<Alt>”, “<Shift>”, “<Mod2>”, etc. (we use the same string as gtk_accelerator_name() in gtk+-2.X.

get_localized_name(i)¶

Parameters:: i (int) – an integer indicating which action to query.
Raises:: GLib.Error
Returns:: the name of the action, as a UTF-8 string.
Return type:: str

Get the name of the ‘i-th’ action invocable on an object implementing Atspi.Action.

get_n_actions()¶

Raises:: GLib.Error
Returns:: an integer indicating the number of invocable actions.
Return type:: int

Get the number of actions invokable on an Atspi.Action implementor.