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