Add IDL docs to tarball, and build them with doxygen when available.
[platform/core/uifw/at-spi2-atk.git] / docs / reference / cspi / at-spi-cspi-sections.txt
1 <SECTION>
2 <FILE>spi_main</FILE>
3 <TITLE>SPI main loop and initialization</TITLE>
4 SPI_init
5 SPI_event_main
6 SPI_event_quit
7 SPI_eventIsReady
8 SPI_nextEvent
9 SPI_exit
10 <SUBSECTION Utility Functions>
11 SPI_freeString
12 </SECTION>
13
14 <SECTION>
15 <FILE>spi_event</FILE>
16 <TITLE>Event Listener Support</TITLE>
17 AccessibleEvent
18 AccessibleEventListenerCB
19 AccessibleEvent_ref
20 AccessibleEvent_unref
21 SPI_createAccessibleEventListener
22 AccessibleEventListener_unref
23 AccessibleEventListener_addCallback
24 AccessibleEventListener_removeCallback
25 <SUBSECTION Specific Event Support>
26 AccessibleActiveDescendantChangedEvent_getActiveDescendant
27 AccessibleChildChangedEvent_getChildAccessible
28 AccessibleDescriptionChangedEvent_getDescriptionString
29 AccessibleNameChangedEvent_getNameString
30 AccessibleParentChangedEvent_getParentAccessible
31 AccessibleTableCaptionChangedEvent_getCaptionString
32 AccessibleTableColumnDescriptionChangedEvent_getDescriptionString
33 AccessibleTableHeaderChangedEvent_getHeaderAccessible
34 AccessibleTableRowDescriptionChangedEvent_getDescriptionString
35 AccessibleTableSummaryChangedEvent_getSummaryAccessible
36 AccessibleTextChangedEvent_getChangeString
37 AccessibleTextSelectionChangedEvent_getSelectionString
38 AccessibleWindowEvent_getTitleString
39 </SECTION>
40
41 <SECTION>
42 <FILE>spi_registry</FILE>
43 <TITLE>Registry queries</TITLE>
44 AccessibleKeySynthType
45 SPI_getDesktopCount
46 SPI_getDesktop
47 SPI_getDesktopList
48 SPI_freeDesktopList
49 <SUBSECTION Event Registration>
50 AccessibleKeystrokeListenerCB
51 AccessibleKeyEventMask
52 AccessibleModifierMaskType
53 AccessibleKeyMaskType
54 AccessibleKeyEventType
55 AccessibleKeyListenerSyncType
56 AccessibleKeystroke
57 SPI_createAccessibleKeySet
58 SPI_freeAccessibleKeySet
59 SPI_createAccessibleKeystrokeListener
60 SPI_registerGlobalEventListener
61 SPI_deregisterGlobalEventListener
62 SPI_deregisterGlobalEventListenerAll
63 SPI_registerAccessibleKeystrokeListener
64 SPI_deregisterAccessibleKeystrokeListener
65 AccessibleKeystrokeListener_unref
66 AccessibleKeystrokeListener_removeCallback
67 AccessibleKeystrokeListener_addCallback
68 SPI_generateKeyboardEvent
69 SPI_generateMouseEvent
70 AccessibleDeviceEvent
71 AccessibleDeviceEventMask
72 AccessibleDeviceEventType
73 AccessibleDeviceListenerCB
74 SPI_createAccessibleDeviceListener
75 SPI_registerDeviceEventListener
76 SPI_deregisterDeviceEventListener
77 AccessibleDeviceListener_addCallback
78 AccessibleDeviceListener_removeCallback
79 AccessibleDeviceListener_unref
80 <SUBSECTION Private>
81 SPI_KEYSET_ALL_KEYS
82 </SECTION>
83
84 <SECTION>
85 <FILE>spi_accessible</FILE>
86 <TITLE>Accessible Objects</TITLE>
87 Accessible
88 Accessible_ref
89 Accessible_unref
90 Accessible_getName
91 Accessible_getDescription
92 Accessible_getParent
93 Accessible_getChildCount
94 Accessible_getChildAtIndex
95 Accessible_getIndexInParent
96 Accessible_getRelationSet
97 Accessible_getRole
98 Accessible_getRoleName
99 Accessible_getStateSet
100 <SUBSECTION Interface Queries>
101 Accessible_isAction
102 Accessible_isApplication
103 Accessible_isComponent
104 Accessible_isEditableText
105 Accessible_isHypertext
106 Accessible_isImage
107 Accessible_isSelection
108 Accessible_isStreamableContent
109 Accessible_isTable
110 Accessible_isText
111 Accessible_isValue
112 Accessible_getAction
113 Accessible_getApplication
114 Accessible_getComponent
115 Accessible_getEditableText
116 Accessible_getHypertext
117 Accessible_getImage
118 Accessible_getSelection
119 Accessible_getStreamableContent
120 Accessible_getTable
121 Accessible_getText
122 Accessible_getValue
123 Accessible_queryInterface
124 <SUBSECTION Auxiliary types>
125 AccessibleRole
126 AccessibleRole_getName
127 <SUBSECTION Private>
128 InternalEvent
129 SPI_INTERNAL_EVENT_MAGIC
130 CSPI_OBJREF
131 cspi_ev
132 cspi_exception
133 cspi_registry
134 cspi_object_add
135 cspi_object_ref
136 cspi_object_unref
137 cspi_object_borrow
138 cspi_object_take
139 cspi_object_return
140 cspi_accessible_is_a
141 cspi_return_if_fail
142 cspi_return_val_if_fail
143 cspi_return_if_ev
144 cspi_return_val_if_ev
145 cspi_check_ev
146 cspi_dup_ref
147 cspi_release_unref
148 cspi_exception_get_text
149 cspi_init
150 cspi_ping
151 cspi_main
152 cspi_main_quit
153 cspi_event_listener_get_type
154 cspi_event_listener_new
155 cspi_event_listener_get_corba
156 cspi_event_listener_add_cb
157 cspi_event_listener_remove_cb
158 cspi_event_listener_unref
159 cspi_keystroke_listener_new
160 cspi_keystroke_listener_unref
161 cspi_keystroke_listener_get_corba
162 cspi_keystroke_listener_add_cb
163 cspi_keystroke_listener_remove_cb
164 cspi_device_listener_get_type
165 cspi_device_listener_new
166 cspi_device_listener_add_cb
167 cspi_device_listener_remove_cb
168 cspi_device_listener_unref
169 CSpiEventListener
170 CSpiEventListenerClass
171 CSPI_EVENT_LISTENER_TYPE
172 CSPI_EVENT_LISTENER
173 CSPI_EVENT_LISTENER_CLASS
174 CSPI_IS_EVENT_LISTENER
175 CSPI_IS_EVENT_LISTENER_CLASS
176 CSpiDeviceListener
177 CSpiDeviceListenerClass
178 CSPI_DEVICE_LISTENER_TYPE
179 CSPI_DEVICE_LISTENER
180 CSPI_DEVICE_LISTENER_CLASS
181 CSPI_IS_DEVICE_LISTENER
182 CSPI_IS_DEVICE_LISTENER_CLASS
183 </SECTION>
184
185 <SECTION>
186 <FILE>spi_application</FILE>
187 <TITLE>AccessibleApplication API</TITLE>
188 AccessibleApplication_ref
189 AccessibleApplication_unref
190 AccessibleApplication_getToolkitName
191 AccessibleApplication_getVersion
192 AccessibleApplication_getID
193 AccessibleApplication_pause
194 AccessibleApplication_resume
195 </SECTION>
196
197 <SECTION>
198 <FILE>spi_action</FILE>
199 <TITLE>AccessibleAction Interface</TITLE>
200 AccessibleAction_ref
201 AccessibleAction_unref
202 AccessibleAction_getNActions
203 AccessibleAction_doAction
204 AccessibleAction_getKeyBinding
205 AccessibleAction_getName
206 AccessibleAction_getDescription
207 </SECTION>
208
209 <SECTION>
210 <FILE>spi_component</FILE>
211 <TITLE>AccessibleComponent Interface</TITLE>
212 AccessibleCoordType
213 AccessibleComponentLayer
214 AccessibleComponent_ref
215 AccessibleComponent_unref
216 AccessibleComponent_contains
217 AccessibleComponent_getAccessibleAtPoint
218 AccessibleComponent_getExtents
219 AccessibleComponent_getPosition
220 AccessibleComponent_getSize
221 AccessibleComponent_getLayer
222 AccessibleComponent_getMDIZOrder
223 AccessibleComponent_grabFocus
224 </SECTION>
225
226 <SECTION>
227 <FILE>spi_editabletext</FILE>
228 <TITLE>AccessibleEditableText Interface</TITLE>
229 AccessibleEditableText_ref
230 AccessibleEditableText_unref
231 AccessibleEditableText_copyText
232 AccessibleEditableText_deleteText
233 AccessibleEditableText_insertText
234 AccessibleEditableText_cutText
235 AccessibleEditableText_pasteText
236 AccessibleEditableText_setTextContents
237 AccessibleEditableText_setAttributes
238 </SECTION>
239
240 <SECTION>
241 <FILE>spi_hypertext</FILE>
242 <TITLE>AccessibleHypertext Interface</TITLE>
243 AccessibleHypertext_ref
244 AccessibleHypertext_unref
245 AccessibleHypertext_getNLinks
246 AccessibleHypertext_getLink
247 AccessibleHypertext_getLinkIndex
248 </SECTION>
249
250 <SECTION>
251 <FILE>spi_image</FILE>
252 <TITLE>AccessibleImage Interface</TITLE>
253 AccessibleImage_ref
254 AccessibleImage_unref
255 AccessibleImage_getImageDescription
256 AccessibleImage_getImageSize
257 AccessibleImage_getImagePosition
258 AccessibleImage_getImageExtents
259 </SECTION>
260
261 <SECTION>
262 <FILE>spi_selection</FILE>
263 <TITLE>AccessibleSelection Interface</TITLE>
264 AccessibleSelection_ref
265 AccessibleSelection_unref
266 AccessibleSelection_getNSelectedChildren
267 AccessibleSelection_getSelectedChild
268 AccessibleSelection_selectChild
269 AccessibleSelection_isChildSelected
270 AccessibleSelection_deselectSelectedChild
271 AccessibleSelection_clearSelection
272 AccessibleSelection_selectAll
273 </SECTION>
274
275 <SECTION>
276 <FILE>spi_streamable_content</FILE>
277 <TITLE>AccessibleStreamableContent Interface</TITLE>
278 AccessibleStreamableContent_ref
279 AccessibleStreamableContent_unref
280 AccessibleStreamableContent_getContentTypes
281 AccessibleStreamableContent_open
282 AccessibleStreamableContent_seek
283 AccessibleStreamableContent_read
284 </SECTION>
285
286 <SECTION>
287 <FILE>spi_table</FILE>
288 <TITLE>AccessibleTable Interface</TITLE>
289 AccessibleTable_ref
290 AccessibleTable_unref
291 AccessibleTable_getAccessibleAt
292 AccessibleTable_getCaption
293 AccessibleTable_getColumnAtIndex
294 AccessibleTable_getColumnDescription
295 AccessibleTable_getColumnExtentAt
296 AccessibleTable_getColumnHeader
297 AccessibleTable_getIndexAt
298 AccessibleTable_getNColumns
299 AccessibleTable_getNRows
300 AccessibleTable_getNSelectedColumns
301 AccessibleTable_getNSelectedRows
302 AccessibleTable_getRowAtIndex
303 AccessibleTable_getRowDescription
304 AccessibleTable_getRowExtentAt
305 AccessibleTable_getRowHeader
306 AccessibleTable_getSelectedRows
307 AccessibleTable_getSelectedColumns
308 AccessibleTable_getSummary
309 AccessibleTable_isColumnSelected
310 AccessibleTable_isRowSelected
311 AccessibleTable_isSelected
312 </SECTION>
313
314 <SECTION>
315 <FILE>spi_text</FILE>
316 <TITLE>AccessibleText Interface</TITLE>
317 AccessibleTextBoundaryType
318 AccessibleTextClipType
319 AccessibleText_ref
320 AccessibleText_unref
321 AccessibleText_addSelection
322 AccessibleText_getAttributes
323 AccessibleText_getBoundedRanges
324 AccessibleText_getCaretOffset
325 AccessibleText_getCharacterCount
326 AccessibleText_getCharacterExtents
327 AccessibleText_getNSelections
328 AccessibleText_getOffsetAtPoint
329 AccessibleText_getRangeExtents
330 AccessibleText_getSelection
331 AccessibleText_getText
332 AccessibleText_getTextBeforeOffset
333 AccessibleText_getTextAfterOffset
334 AccessibleText_getTextAtOffset
335 AccessibleText_removeSelection
336 AccessibleText_setCaretOffset
337 AccessibleText_setSelection
338 AccessibleTextRange_freeRanges
339 </SECTION>
340
341 <SECTION>
342 <FILE>spi_value</FILE>
343 <TITLE>AccessibleValue Interface</TITLE>
344 AccessibleValue_ref
345 AccessibleValue_unref
346 AccessibleValue_getCurrentValue
347 AccessibleValue_getMaximumValue
348 AccessibleValue_getMinimumValue
349 AccessibleValue_setCurrentValue
350 </SECTION>
351
352 <SECTION>
353 <FILE>spi_hyperlink</FILE>
354 <TITLE>AccessibleHyperlink Interface</TITLE>
355 AccessibleHyperlink_ref
356 AccessibleHyperlink_unref
357 AccessibleHyperlink_getNAnchors
358 AccessibleHyperlink_getIndexRange
359 AccessibleHyperlink_getObject
360 AccessibleHyperlink_getURI
361 AccessibleHyperlink_isValid
362 </SECTION>
363
364 <SECTION>
365 <FILE>spi_stateset</FILE>
366 <TITLE>State and StateSets</TITLE>
367 AccessibleState
368 AccessibleStateSet
369 AccessibleStateSet_ref
370 AccessibleStateSet_unref
371 AccessibleStateSet_add
372 AccessibleStateSet_compare
373 AccessibleStateSet_contains
374 AccessibleStateSet_equals
375 AccessibleStateSet_isEmpty
376 AccessibleStateSet_remove
377 </SECTION>
378
379 <SECTION>
380 <FILE>spi_relation</FILE>
381 <TITLE>AccessibleRelations and RelationSets</TITLE>
382 AccessibleRelationType
383 AccessibleRelation_ref
384 AccessibleRelation_unref
385 AccessibleRelation_getNTargets
386 AccessibleRelation_getTarget
387 AccessibleRelation_getRelationType
388 </SECTION>