Action

Description 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 test, etc.) or AtkValue (set value) then these actions should not be exposed by AtkAction as well. Also note that the AtkAction API is limited in that parameters may not be passed to the object being activated; thus the action must be self-contained and specifiable via only a single "verb". Concrete examples include "press", "release", "click" for buttons, "drag" (meaning initiate drag) and "drop" for drag sources and drop targets, etc. 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.

class Action {

protected

AtkAction* atkAction;

AtkAction* getActionStruct();

void* getStruct();

this(AtkAction* atkAction);

int doAction(int i);

int getNActions();

string getDescription(int i);

string getName(int i);

string getLocalizedName(int i);

string getKeybinding(int i);

int setDescription(int i, string desc);

}

Constructors

this this(AtkAction* atkAction): Sets our main struct and passes it to the parent class

Members

Functions

doAction int doAction(int i): Perform the specified action on the object.
getActionStruct AtkAction* getActionStruct(): Undocumented in source. Be warned that the author may not have intended to support it.
getDescription string getDescription(int i): Returns a description of the specified action of the object.
getKeybinding string getKeybinding(int i): Returns a keybinding associated with this action, if one exists. The returned string is in the format "<a>;<b>;<c>" (i.e. semicolon-delimited), where <a> is the keybinding which activates the object if it is presently enabled onscreen, <b> corresponds to the keybinding or sequence of keys which invokes the action even if the relevant element is not currently posted on screen (for instance, for a menu item it posts the parent menus before invoking). The last token in the above string, if non-empty, represents a keyboard shortcut which invokes the same action without posting the component or its enclosing menus or dialogs.
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. 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.
getStruct void* getStruct(): the main Gtk struct as a void*
setDescription int setDescription(int i, string desc): Sets a description of the specified action of the object.

Variables

atkAction AtkAction* atkAction;: the main Gtk struct

Action

Constructors

Members

Functions

Variables

Meta

Source