atk.action
Module for [Action] interface
Types 2
The ATK interface provided by UI components which the user can activate/interact with.
#AtkAction should be implemented by instances of #AtkObject 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 #AtkEditableText (insert/delete text, etc.) or #AtkValue (set value) then these actions should not be exposed by #AtkAction 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, #AtkAction should expose only one action rather than exposing redundant actions if possible. By convention we have been using "mouse centric" terminology for #AtkAction names.
bool doAction(int i)Perform the specified action on the object.string getDescription(int i)Returns a description of the specified action of the object.string getKeybinding(int i)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 scre...string getLocalizedName(int i)Returns the localized name of the specified action of the object.int getNActions()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. Returns: a the number of actions, or 0 if ...string getName(int i)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 ...bool setDescription(int i, string desc)Sets a description of the specified action of the object.