summaryrefslogtreecommitdiff
path: root/docs/tmpl/atkutil.sgml
blob: dddb115a1ae3fc5d24dc3491e7a1542a0590e461 (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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
<!-- ##### SECTION Title ##### -->
AtkUtil

<!-- ##### SECTION Short_Description ##### -->
This is a utility class which supports the adding and removal of event listeners.

<!-- ##### SECTION Long_Description ##### -->
<para>
This is a utility class which supports the adding and removal of event 
listeners. The adding and removing of the listeners must be done in the 
same thread. The file also contains a number of utility functions.

</para>

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

</para>

<!-- ##### STRUCT AtkUtil ##### -->
<para>
The AtkObject structure should not be accessed directly.

</para>


<!-- ##### ENUM AtkCoordType ##### -->
<para>

</para>

@ATK_XY_SCREEN: 
@ATK_XY_WINDOW: 

<!-- ##### FUNCTION atk_add_focus_tracker ##### -->
<para>

</para>

@focus_tracker: 
@Returns: 


<!-- ##### FUNCTION atk_remove_focus_tracker ##### -->
<para>

</para>

@tracker_id: 


<!-- ##### FUNCTION atk_focus_tracker_init ##### -->
<para>

</para>

@add_function: 


<!-- ##### FUNCTION atk_focus_tracker_notify ##### -->
<para>

</para>

@object: 


<!-- ##### USER_FUNCTION AtkEventListener ##### -->
<para>
An AtkEventListener is user specified function which is called when an event,
such as receiving focus, occurs. The parameter of the AtkEventListener is the
AtkObject on which the event occurred.
</para>

@Param1: 


<!-- ##### USER_FUNCTION AtkEventListenerInit ##### -->
<para>
An AtkEventListenerInit is an initialization function in an implementation 
of the ATK interface used to perform implementation-specific initialization
when enabling focus tracking.

</para>



<!-- ##### FUNCTION atk_add_global_event_listener ##### -->
<para>

</para>

@listener: 
@event_type: 
@Returns: 


<!-- ##### FUNCTION atk_remove_global_event_listener ##### -->
<para>

</para>

@listener_id: 


<!-- ##### STRUCT AtkKeyEventStruct ##### -->
<para>
The AtkKeyEventStruct describes a keyboard event.
</para>

@type: 
@state: 
@keyval: 
@length: 
@string: 
@keycode: 
@timestamp: 

<!-- ##### ENUM AtkKeyEventType ##### -->
<para>

</para>

@ATK_KEY_EVENT_PRESS: 
@ATK_KEY_EVENT_RELEASE: 
@ATK_KEY_EVENT_LAST_DEFINED: 

<!-- ##### USER_FUNCTION AtkKeySnoopFunc ##### -->
<para>
An AtkKeySnoopFunc is a function which is called when a keyboard event occurs.
</para>

@event: 
@func_data: 
@Returns: 


<!-- ##### FUNCTION atk_add_key_event_listener ##### -->
<para>

</para>

@listener: 
@data: 
@Returns: 


<!-- ##### FUNCTION atk_remove_key_event_listener ##### -->
<para>

</para>

@listener_id: 


<!-- ##### FUNCTION atk_get_root ##### -->
<para>

</para>

@Returns: 


<!-- ##### FUNCTION atk_get_focus_object ##### -->
<para>

</para>

@Returns: 


<!-- ##### FUNCTION atk_get_toolkit_name ##### -->
<para>

</para>

@Returns: 


<!-- ##### FUNCTION atk_get_toolkit_version ##### -->
<para>

</para>

@Returns: