Synopsis

class atk.Action(gobject.GInterface):
    def do_action(i)
    def get_n_actions()
    def get_description(i)
    def get_name(i)
    def get_keybinding(i)
    def set_description(i, desc)
    def get_localized_name(i)

Description

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 test, etc.) or atk.Value (set value) then these actions should not be exposed by atk.Action as well.

Also note that the atk.Action 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, 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.

Methods

    def do_action(i)

    def get_n_actions()

    def get_description(i)

    def get_name(i)

    def get_keybinding(i)

    def set_description(i, desc)

    def get_localized_name(i)