summaryrefslogtreecommitdiff
path: root/docs/tmpl/atkaction.sgml
blob: 11a04b2a4ab5ad1cfd23fcf44ed27f7138603d5b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
<!-- ##### SECTION Title ##### -->
AtkAction

<!-- ##### SECTION Short_Description ##### -->
The ATK interface provided by UI components which the user can
activate/interact with,

<!-- ##### SECTION Long_Description ##### -->
<para>
#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.
</para>
<para>
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.  
</para>
<para>
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.  
</para>
<para>
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.
</para>

<!-- ##### SECTION See_Also ##### -->
<para>

</para>

<!-- ##### SECTION Stability_Level ##### -->


<!-- ##### SECTION Image ##### -->


<!-- ##### STRUCT AtkAction ##### -->
<para>
The AtkAction structure does not contain any fields.
</para>


<!-- ##### FUNCTION atk_action_do_action ##### -->
<para>

</para>

@action: 
@i: 
@Returns: 


<!-- ##### FUNCTION atk_action_get_n_actions ##### -->
<para>

</para>

@action: 
@Returns: 


<!-- ##### FUNCTION atk_action_get_description ##### -->
<para>

</para>

@action: 
@i: 
@Returns: 


<!-- ##### FUNCTION atk_action_get_name ##### -->
<para>

</para>

@action: 
@i: 
@Returns: 


<!-- ##### FUNCTION atk_action_get_localized_name ##### -->
<para>

</para>

@action: 
@i: 
@Returns: 


<!-- ##### FUNCTION atk_action_get_keybinding ##### -->
<para>

</para>

@action: 
@i: 
@Returns: 


<!-- ##### FUNCTION atk_action_set_description ##### -->
<para>

</para>

@action: 
@i: 
@desc: 
@Returns: