1 <!-- ##### SECTION Title ##### -->
4 <!-- ##### SECTION Short_Description ##### -->
5 The ATK interface provided by UI components which the user can
6 activate/interact with,
8 <!-- ##### SECTION Long_Description ##### -->
10 #AtkAction should be implemented by instances of #AtkObject classes with
11 which the user can interact directly, i.e. buttons, checkboxes,
12 scrollbars, e.g. components which are not "passive"
13 providers of UI information.
16 Exceptions: when the user interaction is already covered by
17 another appropriate interface such as #AtkEditableText (insert/delete
18 test, etc.) or #AtkValue (set value) then these actions should not be
19 exposed by #AtkAction as well.
22 Also note that the #AtkAction API is limited in that parameters may not
23 be passed to the object being activated; thus the action must be
24 self-contained and specifiable via only a single "verb". Concrete
25 examples include "press", "release", "click" for buttons, "drag"
26 (meaning initiate drag) and "drop" for drag sources and drop targets,
30 Though most UI interactions on components should be invocable via
31 keyboard as well as mouse, there will generally be a close mapping
32 between "mouse actions" that are possible on a component and the
33 AtkActions. Where mouse and keyboard actions are redundant in effect,
34 #AtkAction should expose only one action rather than exposing redundant
35 actions if possible. By convention we have been using "mouse centric"
36 terminology for #AtkAction names.
39 <!-- ##### SECTION See_Also ##### -->
44 <!-- ##### SECTION Stability_Level ##### -->
47 <!-- ##### SECTION Image ##### -->
50 <!-- ##### STRUCT AtkAction ##### -->
52 The AtkAction structure does not contain any fields.
56 <!-- ##### FUNCTION atk_action_do_action ##### -->
66 <!-- ##### FUNCTION atk_action_get_n_actions ##### -->
75 <!-- ##### FUNCTION atk_action_get_description ##### -->
85 <!-- ##### FUNCTION atk_action_get_name ##### -->
95 <!-- ##### FUNCTION atk_action_get_localized_name ##### -->
105 <!-- ##### FUNCTION atk_action_get_keybinding ##### -->
115 <!-- ##### FUNCTION atk_action_set_description ##### -->