Added docs for SPI_freeString, and used it to stop memory leak of strings
[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_grabFocus
121 </SECTION>
122
123 <SECTION>
124 <FILE>spi_editabletext</FILE>
125 <TITLE>AccessibleEditableText Interface</TITLE>
126 AccessibleEditableText_ref
127 AccessibleEditableText_unref
128 AccessibleEditableText_copyText
129 AccessibleEditableText_deleteText
130 AccessibleEditableText_insertText
131 AccessibleEditableText_cutText
132 AccessibleEditableText_pasteText
133 AccessibleEditableText_setTextContents
134 AccessibleEditableText_setAttributes
135 </SECTION>
136
137 <SECTION>
138 <FILE>spi_hypertext</FILE>
139 <TITLE>AccessibleHypertext Interface</TITLE>
140 AccessibleHypertext_ref
141 AccessibleHypertext_unref
142 AccessibleHypertext_getNLinks
143 AccessibleHypertext_getLink
144 AccessibleHypertext_getLinkIndex
145 </SECTION>
146
147 <SECTION>
148 <FILE>spi_image</FILE>
149 <TITLE>AccessibleImage Interface</TITLE>
150 AccessibleImage_ref
151 AccessibleImage_unref
152 AccessibleImage_getImageDescription
153 AccessibleImage_getImageSize
154 AccessibleImage_getImagePosition
155 </SECTION>
156
157 <SECTION>
158 <FILE>spi_selection</FILE>
159 <TITLE>AccessibleSelection Interface</TITLE>
160 AccessibleSelection_ref
161 AccessibleSelection_unref
162 AccessibleSelection_getNSelectedChildren
163 AccessibleSelection_getSelectedChild
164 AccessibleSelection_selectChild
165 AccessibleSelection_isChildSelected
166 AccessibleSelection_deselectSelectedChild
167 AccessibleSelection_clearSelection
168 AccessibleSelection_selectAll
169 </SECTION>
170
171 <SECTION>
172 <FILE>spi_table</FILE>
173 <TITLE>AccessibleTable Interface</TITLE>
174 AccessibleTable_ref
175 AccessibleTable_unref
176 AccessibleTable_getAccessibleAt
177 AccessibleTable_getCaption
178 AccessibleTable_getColumnAtIndex
179 AccessibleTable_getColumnDescription
180 AccessibleTable_getColumnExtentAt
181 AccessibleTable_getColumnHeader
182 AccessibleTable_getIndexAt
183 AccessibleTable_getNColumns
184 AccessibleTable_getNRows
185 AccessibleTable_getNSelectedColumns
186 AccessibleTable_getNSelectedRows
187 AccessibleTable_getRowAtIndex
188 AccessibleTable_getRowDescription
189 AccessibleTable_getRowExtentAt
190 AccessibleTable_getRowHeader
191 AccessibleTable_getSelectedRows
192 AccessibleTable_getSelectedColumns
193 AccessibleTable_getSummary
194 AccessibleTable_isColumnSelected
195 AccessibleTable_isRowSelected
196 AccessibleTable_isSelected
197 </SECTION>
198
199 <SECTION>
200 <FILE>spi_text</FILE>
201 <TITLE>AccessibleText Interface</TITLE>
202 AccessibleTextBoundaryType
203 AccessibleText_ref
204 AccessibleText_unref
205 AccessibleText_addSelection
206 AccessibleText_getAttributes
207 AccessibleText_getCaretOffset
208 AccessibleText_getCharacterCount
209 AccessibleText_getCharacterExtents
210 AccessibleText_getNSelections
211 AccessibleText_getOffsetAtPoint
212 AccessibleText_getSelection
213 AccessibleText_getText
214 AccessibleText_getTextBeforeOffset
215 AccessibleText_getTextAfterOffset
216 AccessibleText_getTextAtOffset
217 AccessibleText_removeSelection
218 AccessibleText_setCaretOffset
219 AccessibleText_setSelection
220 </SECTION>
221
222 <SECTION>
223 <FILE>spi_value</FILE>
224 <TITLE>AccessibleValue Interface</TITLE>
225 AccessibleValue_ref
226 AccessibleValue_unref
227 AccessibleValue_getCurrentValue
228 AccessibleValue_getMaximumValue
229 AccessibleValue_getMinimumValue
230 AccessibleValue_setCurrentValue
231 </SECTION>
232
233 <SECTION>
234 <FILE>spi_hyperlink</FILE>
235 <TITLE>AccessibleHyperlink Interface</TITLE>
236 AccessibleHyperlink_getNAnchors
237 AccessibleHyperlink_getIndexRange
238 AccessibleHyperlink_getObject
239 AccessibleHyperlink_getURI
240 AccessibleHyperlink_isValid
241 </SECTION>
242
243 <SECTION>
244 <FILE>spi_stateset</FILE>
245 <TITLE>State and StateSets</TITLE>
246 AccessibleState
247 AccessibleStateSet_ref
248 AccessibleStateSet_unref
249 AccessibleStateSet_add
250 AccessibleStateSet_compare
251 AccessibleStateSet_contains
252 AccessibleStateSet_equals
253 AccessibleStateSet_isEmpty
254 AccessibleStateSet_remove
255 </SECTION>
256
257 <SECTION>
258 <FILE>spi_relation</FILE>
259 <TITLE>AccessibleRelations and RelationSets</TITLE>
260 AccessibleRelationType
261 AccessibleRelation_ref
262 AccessibleRelation_unref
263 AccessibleRelation_getTarget
264 AccessibleRelation_getRelationType
265 </SECTION>