Atk.Action

g Atk.Action Atk.Action GObject.GInterface GObject.GInterface GObject.GInterface->Atk.Action

Implementations:
 Atk.Hyperlink, Atk.NoOpObject

Methods

  do_action (i)
  get_description (i)
  get_keybinding (i)
  get_localized_name (i)
  get_n_actions ()
  get_name (i)
  set_description (i, desc)

Virtual Methods

  do_do_action (i)
  do_get_description (i)
  do_get_keybinding (i)
  do_get_localized_name (i)
  do_get_n_actions ()
  do_get_name (i)
  do_set_description (i, desc)

Properties

None

Signals

None

Fields

None

Class Details

class Atk.Action
Bases:GObject.GInterface
Structure:Atk.ActionIface

Atk.Action should be implemented by instances of Atk.Object classes with which the user can interact directly, i.e. buttons, checkboxes, scrollbars, e.g. components which are not “passive” providers of UI information.

Exceptions: when the user interaction is already covered by another appropriate interface such as Atk.EditableText (insert/delete text, etc.) or Atk.Value (set value) then these actions should not be exposed by Atk.Action as well.

Though most UI interactions on components should be invocable via keyboard as well as mouse, there will generally be a close mapping between “mouse actions” that are possible on a component and the AtkActions. Where mouse and keyboard actions are redundant in effect, Atk.Action should expose only one action rather than exposing redundant actions if possible. By convention we have been using “mouse centric” terminology for Atk.Action names.

do_action(i)[source]
Parameters:i (int) – the action index corresponding to the action to be performed
Returns:True if success, False otherwise
Return type:bool

Perform the specified action on the object.

get_description(i)[source]
Parameters:i (int) – the action index corresponding to the action to be performed
Returns:a description string, or None if self does not implement this interface.
Return type:str or None

Returns a description of the specified action of the object.

get_keybinding(i)[source]
Parameters:i (int) – the action index corresponding to the action to be performed
Returns:the keybinding which can be used to activate this action, or None if there is no keybinding for this action.
Return type:str or None

Gets the keybinding which can be used to activate this action, if one exists. The string returned should contain localized, human-readable, key sequences as they would appear when displayed on screen. It must be in the format “mnemonic;sequence;shortcut”.

  • The mnemonic key activates the object if it is presently enabled onscreen. This typically corresponds to the underlined letter within the widget. Example: “n” in a traditional “New…” menu item or the “a” in “Apply” for a button.
  • The sequence is the full list of keys which invoke the action even if the relevant element is not currently shown on screen. For instance, for a menu item the sequence is the keybindings used to open the parent menus before invoking. The sequence string is colon-delimited. Example: “Alt+F:N” in a traditional “New…” menu item.
  • The shortcut, if it exists, will invoke the same action without showing the component or its enclosing menus or dialogs. Example: “Ctrl+N” in a traditional “New…” menu item.

Example: For a traditional “New…” menu item, the expected return value would be: “N;Alt+F:N;Ctrl+N” for the English locale and “N;Alt+D:N;Strg+N” for the German locale. If, hypothetically, this menu item lacked a mnemonic, it would be represented by “;;Ctrl+N” and “;;Strg+N” respectively.

get_localized_name(i)[source]
Parameters:i (int) – the action index corresponding to the action to be performed
Returns:a name string, or None if self does not implement this interface.
Return type:str or None

Returns the localized name of the specified action of the object.

get_n_actions()[source]
Returns:a the number of actions, or 0 if self does not implement this interface.
Return type:int

Gets the number of accessible actions available on the object. If there are more than one, the first one is considered the “default” action of the object.

get_name(i)[source]
Parameters:i (int) – the action index corresponding to the action to be performed
Returns:a name string, or None if self does not implement this interface.
Return type:str or None

Returns a non-localized string naming the specified action of the object. This name is generally not descriptive of the end result of the action, but instead names the ‘interaction type’ which the object supports. By convention, the above strings should be used to represent the actions which correspond to the common point-and-click interaction techniques of the same name: i.e. “click”, “press”, “release”, “drag”, “drop”, “popup”, etc. The “popup” action should be used to pop up a context menu for the object, if one exists.

For technical reasons, some toolkits cannot guarantee that the reported action is actually ‘bound’ to a nontrivial user event; i.e. the result of some actions via Atk.Action.do_action() may be NIL.

set_description(i, desc)[source]
Parameters:
  • i (int) – the action index corresponding to the action to be performed
  • desc (str) – the description to be assigned to this action
Returns:

a bool representing if the description was successfully set;

Return type:

bool

Sets a description of the specified action of the object.

do_do_action(i) virtual
Parameters:i (int) – the action index corresponding to the action to be performed
Returns:True if success, False otherwise
Return type:bool

Perform the specified action on the object.

do_get_description(i) virtual
Parameters:i (int) – the action index corresponding to the action to be performed
Returns:a description string, or None if action does not implement this interface.
Return type:str or None

Returns a description of the specified action of the object.

do_get_keybinding(i) virtual
Parameters:i (int) – the action index corresponding to the action to be performed
Returns:the keybinding which can be used to activate this action, or None if there is no keybinding for this action.
Return type:str or None

Gets the keybinding which can be used to activate this action, if one exists. The string returned should contain localized, human-readable, key sequences as they would appear when displayed on screen. It must be in the format “mnemonic;sequence;shortcut”.

  • The mnemonic key activates the object if it is presently enabled onscreen. This typically corresponds to the underlined letter within the widget. Example: “n” in a traditional “New…” menu item or the “a” in “Apply” for a button.
  • The sequence is the full list of keys which invoke the action even if the relevant element is not currently shown on screen. For instance, for a menu item the sequence is the keybindings used to open the parent menus before invoking. The sequence string is colon-delimited. Example: “Alt+F:N” in a traditional “New…” menu item.
  • The shortcut, if it exists, will invoke the same action without showing the component or its enclosing menus or dialogs. Example: “Ctrl+N” in a traditional “New…” menu item.

Example: For a traditional “New…” menu item, the expected return value would be: “N;Alt+F:N;Ctrl+N” for the English locale and “N;Alt+D:N;Strg+N” for the German locale. If, hypothetically, this menu item lacked a mnemonic, it would be represented by “;;Ctrl+N” and “;;Strg+N” respectively.

do_get_localized_name(i) virtual
Parameters:i (int) – the action index corresponding to the action to be performed
Returns:a name string, or None if action does not implement this interface.
Return type:str or None

Returns the localized name of the specified action of the object.

do_get_n_actions() virtual
Returns:a the number of actions, or 0 if action does not implement this interface.
Return type:int

Gets the number of accessible actions available on the object. If there are more than one, the first one is considered the “default” action of the object.

do_get_name(i) virtual
Parameters:i (int) – the action index corresponding to the action to be performed
Returns:a name string, or None if action does not implement this interface.
Return type:str or None

Returns a non-localized string naming the specified action of the object. This name is generally not descriptive of the end result of the action, but instead names the ‘interaction type’ which the object supports. By convention, the above strings should be used to represent the actions which correspond to the common point-and-click interaction techniques of the same name: i.e. “click”, “press”, “release”, “drag”, “drop”, “popup”, etc. The “popup” action should be used to pop up a context menu for the object, if one exists.

For technical reasons, some toolkits cannot guarantee that the reported action is actually ‘bound’ to a nontrivial user event; i.e. the result of some actions via Atk.Action.do_action() may be NIL.

do_set_description(i, desc) virtual
Parameters:
  • i (int) – the action index corresponding to the action to be performed
  • desc (str) – the description to be assigned to this action
Returns:

a bool representing if the description was successfully set;

Return type:

bool

Sets a description of the specified action of the object.