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