ActionT

gtk.Action 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 gobject.Value (set value) then these actions should not be exposed by gtk.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, gtk.Action should expose only one action rather than exposing redundant actions if possible. By convention we have been using "mouse centric" terminology for gtk.Action names.

Members

Functions

doAction
bool doAction(int i)

Perform the specified action on the object.

getActionStruct
AtkAction* getActionStruct(bool transferOwnership = false)

Get the main Gtk struct

getDescription
string getDescription(int i)

Returns a description of the specified action of the object.

getKeybinding
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 screen. It must be in the format "mnemonic;sequence;shortcut".

getLocalizedName
string getLocalizedName(int i)

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

getNActions
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.

getName
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 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.

setDescription
bool setDescription(int i, string desc)

Sets a description of the specified action of the object.

Meta