Updated docs to reflect recent changes to atkeditabletext and atktext
[platform/upstream/atk.git] / docs / atk-sections.txt
1 <SECTION>
2 <FILE>atkaction</FILE>
3 <TITLE>AtkAction</TITLE>
4 AtkAction
5 AtkActionIface
6 atk_action_do_action
7 atk_action_get_n_actions
8 atk_action_get_description
9 atk_action_get_keybinding
10 <SUBSECTION Standard>
11 ATK_ACTION
12 ATK_IS_ACTION
13 ATK_TYPE_ACTION
14 ATK_ACTION_GET_IFACE
15 atk_action_get_type
16 </SECTION>
17
18 <SECTION>
19 <FILE>atkcomponent</FILE>
20 <TITLE>AtkComponent</TITLE>
21 AtkComponent
22 AtkComponentIface
23 AtkFocusHandler
24 atk_component_add_focus_handler
25 atk_component_contains
26 atk_component_get_accessible_at_point
27 atk_component_get_extents
28 atk_component_get_position
29 atk_component_get_position_on_screen
30 atk_component_get_size
31 atk_component_grab_focus
32 atk_component_remove_focus_handler
33 atk_component_set_extents
34 atk_component_set_position
35 atk_component_set_size
36 <SUBSECTION Standard>
37 ATK_COMPONENT
38 ATK_IS_COMPONENT
39 ATK_TYPE_COMPONENT
40 ATK_COMPONENT_GET_IFACE
41 atk_component_get_type
42 </SECTION>
43
44 <SECTION>
45 <FILE>atkeditabletext</FILE>
46 <TITLE>AtkEditableText</TITLE>
47 AtkEditableText
48 AtkEditableTextIface
49 atk_editable_text_set_run_attributes
50 atk_editable_text_set_text_contents
51 atk_editable_text_insert_text
52 atk_editable_text_copy_text
53 atk_editable_text_cut_text
54 atk_editable_text_delete_text
55 atk_editable_text_paste_text
56 <SUBSECTION Standard>
57 ATK_EDITABLE_TEXT
58 ATK_IS_EDITABLE_TEXT
59 ATK_TYPE_EDITABLE_TEXT
60 ATK_EDITABLE_TEXT_GET_IFACE
61 atk_editable_text_get_type
62 </SECTION>
63
64 <SECTION>
65 <FILE>atkhypertext</FILE>
66 <TITLE>AtkHypertext</TITLE>
67 AtkHypertext
68 AtkHypertextIface
69 AtkHyperLink
70 atk_hypertext_get_link
71 atk_hypertext_get_n_links
72 atk_hypertext_get_link_index
73 <SUBSECTION Standard>
74 ATK_HYPERTEXT
75 ATK_IS_HYPERTEXT
76 ATK_TYPE_HYPERTEXT
77 ATK_HYPERTEXT_GET_IFACE
78 atk_hypertext_get_type
79 </SECTION>
80
81 <SECTION>
82 <FILE>atkimage</FILE>
83 <TITLE>AtkImage</TITLE>
84 AtkImage
85 AtkImageIface
86 AtkImageType
87 atk_image_get_storage_type
88 atk_image_get_image_description
89 atk_image_get_image_height
90 atk_image_get_image_width
91 atk_image_set_image_description
92 <SUBSECTION Standard>
93 ATK_IMAGE
94 ATK_IS_IMAGE
95 ATK_TYPE_IMAGE
96 ATK_IMAGE_GET_IFACE
97 atk_image_get_type
98 </SECTION>
99
100 <SECTION>
101 <FILE>atknoopobject</FILE>
102 <TITLE>AtkNoOpObject</TITLE>
103 atk_no_op_object_new
104 <SUBSECTION Standard>
105 ATK_NO_OP_OBJECT
106 ATK_IS_NO_OP_OBJECT
107 ATK_TYPE_NO_OP_OBJECT
108 agtk_widget_get_type
109 ATK_NO_OP_OBJECT_CLASS
110 ATK_IS_NO_OP_OBJECT_CLASS
111 ATK_NO_OP_OBJECT_GET_CLASS
112 </SECTION>
113
114 <SECTION>
115 <FILE>atknoopobjectfactory</FILE>
116 <TITLE>AtkNoOpObjectFactory</TITLE>
117 atk_no_op_object_factory_new
118 <SUBSECTION Standard>
119 ATK_NO_OP_OBJECT_FACTORY
120 ATK_IS_NO_OP_OBJECT_FACTORY
121 ATK_TYPE_NO_OP_OBJECT_FACTORY
122 atk_no_op_object_factory_get_type
123 ATK_NO_OP_OBJECT_FACTORY_CLASS
124 ATK_IS_NO_OP_OBJECT_FACTORY_CLASS
125 ATK_NO_OP_OBJECT_FACTORY_GET_CLASS
126 </SECTION>
127
128 <SECTION>
129 <FILE>atkobject</FILE>
130 <TITLE>AtkObject</TITLE>
131 AtkRole
132 atk_role_register
133 AtkImplementor
134 AtkImplementorIface
135 AtkRelationSet
136 AtkStateSet
137 AtkPropertyValues
138 AtkPropertyChangeHandler
139 atk_implementor_ref_accessible
140 atk_object_get_name
141 atk_object_get_description
142 atk_object_get_parent
143 atk_object_get_n_accessible_children
144 atk_object_ref_accessible_child
145 atk_object_ref_relation_set
146 atk_object_get_role
147 atk_object_ref_state_set
148 atk_object_get_index_in_parent
149 atk_object_set_name
150 atk_object_set_description
151 atk_object_set_parent
152 atk_object_set_role
153 atk_object_connect_property_change_handler
154 atk_object_remove_property_change_handler
155 <SUBSECTION Standard>
156 ATK_OBJECT
157 ATK_IS_OBJECT
158 ATK_TYPE_OBJECT
159 ATK_IMPLEMENTOR_GET_IFACE
160 atk_object_get_type
161 ATK_OBJECT_CLASS
162 ATK_IS_OBJECT_CLASS
163 ATK_OBJECT_GET_CLASS
164 ATK_TYPE_IMPLEMENTOR
165 ATK_IS_IMPLEMENTOR
166 ATK_IMPLEMENTOR
167 atk_implementor_get_type
168 </SECTION>
169
170 <SECTION>
171 <FILE>atkobjectfactory</FILE>
172 <TITLE>AtkObjectFactory</TITLE>
173 atk_object_factory_create_accessible
174 atk_object_factory_invalidate
175 <SUBSECTION Standard>
176 ATK_OBJECT_FACTORY
177 ATK_IS_OBJECT_FACTORY
178 ATK_TYPE_OBJECT_FACTORY
179 atk_object_factory_get_type
180 ATK_OBJECT_FACTORY_CLASS
181 ATK_IS_OBJECT_FACTORY_CLASS
182 ATK_OBJECT_FACTORY_GET_CLASS
183 </SECTION>
184
185 <SECTION>
186 <FILE>atkregistry</FILE>
187 <TITLE>AtkRegistry</TITLE>
188 atk_registry_set_factory_type
189 atk_registry_get_factory_type
190 atk_registry_get_factory
191 atk_get_default_registry
192 <SUBSECTION Standard>
193 ATK_REGISTRY
194 ATK_IS_REGISTRY
195 ATK_TYPE_REGISTRY
196 ATK_REGISTRY_CLASS
197 ATK_IS_REGISTRY_CLASS
198 ATK_REGISTRY_GET_CLASS
199 </SECTION>
200
201 <SECTION>
202 <FILE>atkrelation</FILE>
203 <TITLE>AtkRelation</TITLE>
204 AtkRelationType
205 atk_relation_type_register
206 atk_relation_new
207 atk_relation_get_relation_type
208 atk_relation_get_target
209 <SUBSECTION Standard>
210 ATK_RELATION
211 ATK_IS_RELATION
212 ATK_TYPE_RELATION
213 atk_relation_get_type
214 ATK_RELATION_CLASS
215 ATK_IS_RELATION_CLASS
216 ATK_RELATION_GET_CLASS
217 </SECTION>
218
219 <SECTION>
220 <FILE>atkrelationset</FILE>
221 <TITLE>AtkRelationSet</TITLE>
222 atk_relation_set_new
223 atk_relation_set_contains
224 atk_relation_set_remove
225 atk_relation_set_add
226 atk_relation_set_get_n_relations
227 atk_relation_set_get_relation
228 atk_relation_set_get_relation_by_type
229 <SUBSECTION Standard>
230 ATK_RELATION_SET
231 ATK_IS_RELATION_SET
232 ATK_TYPE_RELATION_SET
233 atk_relation_set_get_type
234 ATK_RELATION_SET_CLASS
235 ATK_IS_RELATION_SET_CLASS
236 ATK_RELATION_SET_GET_CLASS
237 </SECTION>
238
239 <SECTION>
240 <FILE>atkselection</FILE>
241 <TITLE>AtkSelection</TITLE>
242 AtkSelection
243 AtkSelectionIface
244 atk_selection_add_selection
245 atk_selection_clear_selection
246 atk_selection_ref_selection
247 atk_selection_get_selection_count
248 atk_selection_is_child_selected
249 atk_selection_remove_selection
250 atk_selection_select_all_selection
251 <SUBSECTION Standard>
252 ATK_SELECTION
253 ATK_IS_SELECTION
254 ATK_TYPE_SELECTION
255 ATK_SELECTION_GET_IFACE
256 atk_selection_get_type
257 </SECTION>
258
259 <SECTION>
260 <FILE>atkstateset</FILE>
261 <TITLE>AtkStateSet</TITLE>
262 atk_state_set_new
263 atk_state_set_is_empty
264 atk_state_set_add_state
265 atk_state_set_add_states
266 atk_state_set_clear_states
267 atk_state_set_contains_state
268 atk_state_set_contains_states
269 atk_state_set_remove_state
270 atk_state_set_and_sets
271 atk_state_set_or_sets
272 atk_state_set_xor_sets
273 <SUBSECTION Standard>
274 ATK_STATE_SET
275 ATK_IS_STATE_SET
276 ATK_TYPE_STATE_SET
277 atk_state_set_get_type
278 ATK_STATE_SET_CLASS
279 ATK_IS_STATE_SET_CLASS
280 ATK_STATE_SET_GET_CLASS
281 </SECTION>
282
283 <SECTION>
284 <FILE>atktable</FILE>
285 <TITLE>AtkTable</TITLE>
286 AtkTable
287 AtkTableIface
288 atk_table_ref_at
289 atk_table_get_index_at
290 atk_table_get_row_at_index
291 atk_table_get_column_at_index
292 atk_table_get_caption
293 atk_table_get_n_columns
294 atk_table_get_column_description
295 atk_table_get_column_extent_at
296 atk_table_get_column_header
297 atk_table_get_n_rows
298 atk_table_get_row_description
299 atk_table_get_row_extent_at
300 atk_table_get_row_header
301 atk_table_get_summary
302 atk_table_get_selected_columns
303 atk_table_get_selected_rows
304 atk_table_is_column_selected
305 atk_table_is_row_selected
306 atk_table_is_selected
307 atk_table_set_caption
308 atk_table_set_column_description
309 atk_table_set_column_header
310 atk_table_set_row_description
311 atk_table_set_row_header
312 atk_table_set_summary
313 <SUBSECTION Standard>
314 ATK_TABLE
315 ATK_IS_TABLE
316 ATK_TYPE_TABLE
317 ATK_TABLE_GET_IFACE
318 atk_table_get_type
319 </SECTION>
320
321 <SECTION>
322 <FILE>atktext</FILE>
323 <TITLE>AtkText</TITLE>
324 AtkText
325 AtkTextIface
326 AtkTextBoundary
327 atk_text_get_text
328 atk_text_get_character_at_offset
329 atk_text_get_text_after_offset
330 atk_text_get_text_at_offset
331 atk_text_get_text_before_offset
332 atk_text_get_caret_offset
333 atk_text_get_character_extents
334 atk_text_ref_run_attributes
335 atk_text_get_character_count
336 atk_text_get_offset_at_point
337 atk_text_get_n_selections
338 atk_text_get_selection
339 atk_text_add_selection
340 atk_text_remove_selection
341 atk_text_set_selection
342 atk_text_set_caret_offset
343 <SUBSECTION Standard>
344 ATK_TEXT
345 ATK_IS_TEXT
346 ATK_TYPE_TEXT
347 ATK_TEXT_GET_IFACE
348 atk_text_get_type
349 </SECTION>
350
351 <SECTION>
352 <FILE>atkvalue</FILE>
353 <TITLE>AtkValue</TITLE>
354 AtkValue
355 AtkValueIface
356 atk_value_get_current_value
357 atk_value_get_maximum_value
358 atk_value_get_minimum_value
359 atk_value_set_current_value
360 <SUBSECTION Standard>
361 ATK_VALUE
362 ATK_IS_VALUE
363 ATK_TYPE_VALUE
364 ATK_VALUE_GET_IFACE
365 atk_value_get_type
366 </SECTION>
367
368 <SECTION>
369 <FILE>atkhyperlink</FILE>
370 <TITLE>AtkHyperlink</TITLE>
371 atk_hyperlink_get_uri
372 atk_hyperlink_get_object
373 atk_hyperlink_get_end_index
374 atk_hyperlink_get_start_index
375 atk_hyperlink_is_valid
376 atk_hyperlink_get_n_anchors
377 <SUBSECTION Standard>
378 ATK_HYPERLINK
379 ATK_IS_HYPERLINK
380 ATK_TYPE_HYPERLINK
381 atk_hyperlink_get_type
382 ATK_HYPERLINK_CLASS
383 ATK_IS_HYPERLINK_CLASS
384 ATK_HYPERLINK_GET_CLASS
385 </SECTION>
386
387 <SECTION>
388 <FILE>atkstate</FILE>
389 <TITLE>AtkState</TITLE>
390 AtkStateType
391 AtkState
392 atk_state_type_register
393 atk_state_type_get_name
394 atk_state_type_for_name
395 </SECTION>
396
397 <SECTION>
398 <FILE>atkutil</FILE>
399 <TITLE>AtkUtil</TITLE>
400 atk_add_focus_tracker
401 atk_remove_focus_tracker
402 atk_focus_tracker_init
403 atk_focus_tracker_notify
404 <SUBSECTION Standard>
405 AtkFocusTracker
406 AtkFocusTrackerInit
407 </SECTION>
408