Added boolean return types for methods in Component, Selection,
[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 SPI_createAccessibleEventListener
20 AccessibleEventListener_unref
21 AccessibleEventListener_addCallback
22 AccessibleEventListener_removeCallback
23 </SECTION>
24
25 <SECTION>
26 <FILE>spi_registry</FILE>
27 <TITLE>Registry queries</TITLE>
28 AccessibleKeySynthType
29 SPI_getDesktopCount
30 SPI_getDesktop
31 SPI_getDesktopList
32 <SUBSECTION Event Registration>
33 AccessibleKeystrokeListenerCB
34 AccessibleKeyEventMask
35 AccessibleKeyMaskType
36 AccessibleKeyEventType
37 AccessibleKeyListenerSyncType
38 AccessibleKeystroke
39 SPI_createAccessibleKeystrokeListener
40 SPI_registerGlobalEventListener
41 SPI_deregisterGlobalEventListener
42 SPI_deregisterGlobalEventListenerAll
43 SPI_registerAccessibleKeystrokeListener
44 SPI_deregisterAccessibleKeystrokeListener
45 AccessibleKeystrokeListener_ref
46 AccessibleKeystrokeListener_unref
47 AccessibleKeystrokeListener_removeCallback
48 AccessibleKeystrokeListener_addCallback
49 SPI_generateKeyboardEvent
50 SPI_generateMouseEvent
51 </SECTION>
52
53 <SECTION>
54 <FILE>spi_accessible</FILE>
55 <TITLE>Accessible Objects</TITLE>
56 Accessible_ref
57 Accessible_unref
58 Accessible_getName
59 Accessible_getDescription
60 Accessible_getParent
61 Accessible_getChildCount
62 Accessible_getChildAtIndex
63 Accessible_getIndexInParent
64 Accessible_getRelationSet
65 Accessible_getRole
66 Accessible_getRoleName
67 Accessible_getStateSet
68 <SUBSECTION Interface Queries>
69 Accessible_isAction
70 Accessible_isApplication
71 Accessible_isComponent
72 Accessible_isEditableText
73 Accessible_isHypertext
74 Accessible_isImage
75 Accessible_isSelection
76 Accessible_isTable
77 Accessible_isText
78 Accessible_isValue
79 Accessible_getAction
80 Accessible_getApplication
81 Accessible_getComponent
82 Accessible_getEditableText
83 Accessible_getHypertext
84 Accessible_getImage
85 Accessible_getSelection
86 Accessible_getTable
87 Accessible_getText
88 Accessible_getValue
89 Accessible_queryInterface
90 <SUBSECTION Auxiliary types>
91 AccessibleRole
92 AccessibleRole_getName
93 </SECTION>
94
95 <SECTION>
96 <FILE>spi_application</FILE>
97 <TITLE>AccessibleApplication API</TITLE>
98 AccessibleApplication_ref
99 AccessibleApplication_unref
100 AccessibleApplication_getToolkitName
101 AccessibleApplication_getVersion
102 AccessibleApplication_getID
103 AccessibleApplication_pause
104 AccessibleApplication_resume
105 </SECTION>
106
107 <SECTION>
108 <FILE>spi_action</FILE>
109 <TITLE>AccessibleAction Interface</TITLE>
110 AccessibleAction_ref
111 AccessibleAction_unref
112 AccessibleAction_getNActions
113 AccessibleAction_doAction
114 AccessibleAction_getKeyBinding
115 AccessibleAction_getName
116 AccessibleAction_getDescription
117 </SECTION>
118
119 <SECTION>
120 <FILE>spi_component</FILE>
121 <TITLE>AccessibleComponent Interface</TITLE>
122 AccessibleCoordType
123 AccessibleComponentLayer
124 AccessibleComponent_ref
125 AccessibleComponent_unref
126 AccessibleComponent_contains
127 AccessibleComponent_getAccessibleAtPoint
128 AccessibleComponent_getExtents
129 AccessibleComponent_getPosition
130 AccessibleComponent_getSize
131 AccessibleComponent_getLayer
132 AccessibleComponent_getMDIZOrder
133 AccessibleComponent_grabFocus
134 </SECTION>
135
136 <SECTION>
137 <FILE>spi_editabletext</FILE>
138 <TITLE>AccessibleEditableText Interface</TITLE>
139 AccessibleEditableText_ref
140 AccessibleEditableText_unref
141 AccessibleEditableText_copyText
142 AccessibleEditableText_deleteText
143 AccessibleEditableText_insertText
144 AccessibleEditableText_cutText
145 AccessibleEditableText_pasteText
146 AccessibleEditableText_setTextContents
147 AccessibleEditableText_setAttributes
148 </SECTION>
149
150 <SECTION>
151 <FILE>spi_hypertext</FILE>
152 <TITLE>AccessibleHypertext Interface</TITLE>
153 AccessibleHypertext_ref
154 AccessibleHypertext_unref
155 AccessibleHypertext_getNLinks
156 AccessibleHypertext_getLink
157 AccessibleHypertext_getLinkIndex
158 </SECTION>
159
160 <SECTION>
161 <FILE>spi_image</FILE>
162 <TITLE>AccessibleImage Interface</TITLE>
163 AccessibleImage_ref
164 AccessibleImage_unref
165 AccessibleImage_getImageDescription
166 AccessibleImage_getImageSize
167 AccessibleImage_getImagePosition
168 AccessibleImage_getImageExtents
169 </SECTION>
170
171 <SECTION>
172 <FILE>spi_selection</FILE>
173 <TITLE>AccessibleSelection Interface</TITLE>
174 AccessibleSelection_ref
175 AccessibleSelection_unref
176 AccessibleSelection_getNSelectedChildren
177 AccessibleSelection_getSelectedChild
178 AccessibleSelection_selectChild
179 AccessibleSelection_isChildSelected
180 AccessibleSelection_deselectSelectedChild
181 AccessibleSelection_clearSelection
182 AccessibleSelection_selectAll
183 </SECTION>
184
185 <SECTION>
186 <FILE>spi_table</FILE>
187 <TITLE>AccessibleTable Interface</TITLE>
188 AccessibleTable_ref
189 AccessibleTable_unref
190 AccessibleTable_getAccessibleAt
191 AccessibleTable_getCaption
192 AccessibleTable_getColumnAtIndex
193 AccessibleTable_getColumnDescription
194 AccessibleTable_getColumnExtentAt
195 AccessibleTable_getColumnHeader
196 AccessibleTable_getIndexAt
197 AccessibleTable_getNColumns
198 AccessibleTable_getNRows
199 AccessibleTable_getNSelectedColumns
200 AccessibleTable_getNSelectedRows
201 AccessibleTable_getRowAtIndex
202 AccessibleTable_getRowDescription
203 AccessibleTable_getRowExtentAt
204 AccessibleTable_getRowHeader
205 AccessibleTable_getSelectedRows
206 AccessibleTable_getSelectedColumns
207 AccessibleTable_getSummary
208 AccessibleTable_isColumnSelected
209 AccessibleTable_isRowSelected
210 AccessibleTable_isSelected
211 </SECTION>
212
213 <SECTION>
214 <FILE>spi_text</FILE>
215 <TITLE>AccessibleText Interface</TITLE>
216 AccessibleTextBoundaryType
217 AccessibleText_ref
218 AccessibleText_unref
219 AccessibleText_addSelection
220 AccessibleText_getAttributes
221 AccessibleText_getCaretOffset
222 AccessibleText_getCharacterCount
223 AccessibleText_getCharacterExtents
224 AccessibleText_getNSelections
225 AccessibleText_getOffsetAtPoint
226 AccessibleText_getSelection
227 AccessibleText_getText
228 AccessibleText_getTextBeforeOffset
229 AccessibleText_getTextAfterOffset
230 AccessibleText_getTextAtOffset
231 AccessibleText_removeSelection
232 AccessibleText_setCaretOffset
233 AccessibleText_setSelection
234 </SECTION>
235
236 <SECTION>
237 <FILE>spi_value</FILE>
238 <TITLE>AccessibleValue Interface</TITLE>
239 AccessibleValue_ref
240 AccessibleValue_unref
241 AccessibleValue_getCurrentValue
242 AccessibleValue_getMaximumValue
243 AccessibleValue_getMinimumValue
244 AccessibleValue_setCurrentValue
245 </SECTION>
246
247 <SECTION>
248 <FILE>spi_hyperlink</FILE>
249 <TITLE>AccessibleHyperlink Interface</TITLE>
250 AccessibleHyperlink_ref
251 AccessibleHyperlink_unref
252 AccessibleHyperlink_getNAnchors
253 AccessibleHyperlink_getIndexRange
254 AccessibleHyperlink_getObject
255 AccessibleHyperlink_getURI
256 AccessibleHyperlink_isValid
257 </SECTION>
258
259 <SECTION>
260 <FILE>spi_stateset</FILE>
261 <TITLE>State and StateSets</TITLE>
262 AccessibleState
263 AccessibleStateSet_ref
264 AccessibleStateSet_unref
265 AccessibleStateSet_add
266 AccessibleStateSet_compare
267 AccessibleStateSet_contains
268 AccessibleStateSet_equals
269 AccessibleStateSet_isEmpty
270 AccessibleStateSet_remove
271 </SECTION>
272
273 <SECTION>
274 <FILE>spi_relation</FILE>
275 <TITLE>AccessibleRelations and RelationSets</TITLE>
276 AccessibleRelationType
277 AccessibleRelation_ref
278 AccessibleRelation_unref
279 AccessibleRelation_getNTargets
280 AccessibleRelation_getTarget
281 AccessibleRelation_getRelationType
282 </SECTION>