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