4 * Accessible function prototypes
10 * @obj: a pointer to the #Accessible object on which to operate.
12 * Increment the reference count for an #Accessible object.
14 * Returns: (no return code implemented yet).
18 Accessible_ref (Accessible *obj)
20 Accessibility_Accessible_ref (*obj, &ev);
27 * @obj: a pointer to the #Accessible object on which to operate.
29 * Decrement the reference count for an #Accessible object.
31 * Returns: (no return code implemented yet).
35 Accessible_unref (Accessible *obj)
37 Accessibility_Accessible_unref (*obj, &ev);
43 * @obj: a pointer to the #Accessible object on which to operate.
45 * Get the name of an #Accessible object.
47 * Returns: a UTF-8 string indicating the name of the #Accessible object.
51 Accessible_getName (Accessible *obj)
53 return Accessibility_Accessible__get_name (*obj, &ev);
57 * Accessible_getDescription:
58 * @obj: a pointer to the #Accessible object on which to operate.
60 * Get the description of an #Accessible object.
62 * Returns: a UTF-8 string describing the #Accessible object.
66 Accessible_getDescription (Accessible *obj)
68 return Accessibility_Accessible__get_description (*obj, &ev);
72 * Accessible_getParent:
73 * @obj: a pointer to the #Accessible object to query.
75 * Get an #Accessible object's parent container.
77 * Returns: a pointer to the #Accessible object which contains the given
78 * #Accessible instance, or NULL if the @obj has no parent container.
82 Accessible_getParent (Accessible *obj)
84 return Obj_Add (Accessibility_Accessible__get_parent (*obj, &ev));
88 * Accessible_getChildCount:
90 * @obj: a pointer to the #Accessible object on which to operate.
92 * Get the number of children contained by an #Accessible object.
94 * Returns: a #long indicating the number of #Accessible children
95 * contained by an #Accessible object.
99 Accessible_getChildCount (Accessible *obj)
101 return Accessibility_Accessible__get_childCount (*obj, &ev);
105 * Accessible_getChildAtIndex:
107 * @obj: a pointer to the #Accessible object on which to operate.
108 * @childIndex: a #long indicating which child is specified.
110 * Get the #Accessible child of an #Accessible object at a given index.
112 * Returns: a pointer to the #Accessible child object at index
117 Accessible_getChildAtIndex (Accessible *obj,
120 return Obj_Add (Accessibility_Accessible_getChildAtIndex (*obj, childIndex, &ev));
124 * Accessible_getIndexInParent:
126 * @obj: a pointer to the #Accessible object on which to operate.
128 * Get the index of an #Accessible object in its containing #Accessible.
130 * Returns: a #long indicating the index of the #Accessible object
131 * in its parent (i.e. containing) #Accessible instance,
132 * or -1 if @obj has no containing parent.
136 Accessible_getIndexInParent (Accessible *obj)
138 return Accessibility_Accessible_getIndexInParent (*obj, &ev);
142 * Accessible_getRelationSet:
144 * Not Yet Implemented.
146 * Returns: a pointer to an array of #AccessibleRelations.
149 AccessibleRelation **
150 Accessible_getRelationSet (Accessible *obj)
156 * Accessible_getRole:
157 * @obj: a pointer to the #Accessible object on which to operate.
159 * Get the UI role of an #Accessible object.
161 * Returns: a UTF-8 string indicating the UI role of the #Accessible object.
165 Accessible_getRole (Accessible *obj)
171 * Accessible_getStateSet:
173 * Not Yet Implemented.
175 * Returns: a pointer to an #AccessibleStateSet representing the object's current state.
178 Accessible_getStateSet (Accessible *obj)
183 /* Interface query methods */
186 * Accessible_isAction:
187 * @obj: a pointer to the #Accessible instance to query.
189 * Query whether the specified #Accessible implements #AccessibleAction.
190 * Not Yet Implemented.
192 * Returns: #TRUE if @obj implements the #AccessibleAction interface,
196 Accessible_isAction (Accessible *obj)
198 Bonobo_Unknown iface =
199 Accessibility_Accessible_queryInterface (*obj,
200 "IDL:Accessibility/Action:1.0",
202 return (iface != NULL) ? TRUE : FALSE;
206 * Accessible_isComponent:
207 * @obj: a pointer to the #Accessible instance to query.
209 * Query whether the specified #Accessible implements #AccessibleComponent.
211 * Returns: #TRUE if @obj implements the #AccessibleComponent interface,
215 Accessible_isComponent (Accessible *obj)
217 Bonobo_Unknown iface =
218 Accessibility_Accessible_queryInterface (*obj,
219 "IDL:Accessibility/Component:1.0",
221 return (iface != NULL) ? TRUE : FALSE;
225 * Accessible_isEditableText:
226 * @obj: a pointer to the #Accessible instance to query.
228 * Query whether the specified #Accessible implements #AccessibleEditableText.
229 * Not Yet Implemented.
231 * Returns: #TRUE if @obj implements the #AccessibleEditableText interface,
235 Accessible_isEditableText (Accessible *obj)
237 Bonobo_Unknown iface =
238 Accessibility_Accessible_queryInterface (*obj,
239 "IDL:Accessibility/EditableText:1.0",
241 return (iface != NULL) ? TRUE : FALSE;
245 * Accessible_isHypertext:
246 * @obj: a pointer to the #Accessible instance to query.
248 * Query whether the specified #Accessible implements #AccessibleHypertext.
249 * Not Yet Implemented.
251 * Returns: #TRUE if @obj implements the #AccessibleHypertext interface,
255 Accessible_isHypertext (Accessible *obj)
257 Bonobo_Unknown iface =
258 Accessibility_Accessible_queryInterface (*obj,
259 "IDL:Accessibility/Hypertext:1.0",
261 return (iface != NULL) ? TRUE : FALSE;
265 * Accessible_isImage:
266 * @obj: a pointer to the #Accessible instance to query.
268 * Query whether the specified #Accessible implements #AccessibleImage.
269 * Not Yet Implemented.
271 * Returns: #TRUE if @obj implements the #AccessibleImage interface,
275 Accessible_isImage (Accessible *obj)
277 Bonobo_Unknown iface =
278 Accessibility_Accessible_queryInterface (*obj,
279 "IDL:Accessibility/Image:1.0",
281 return (iface != NULL) ? TRUE : FALSE;
285 * Accessible_isSelection:
286 * @obj: a pointer to the #Accessible instance to query.
288 * Query whether the specified #Accessible implements #AccessibleSelection.
289 * Not Yet Implemented.
291 * Returns: #TRUE if @obj implements the #AccessibleSelection interface,
295 Accessible_isSelection (Accessible *obj)
297 Bonobo_Unknown iface =
298 Accessibility_Accessible_queryInterface (*obj,
299 "IDL:Accessibility/Selection:1.0",
301 return (iface != NULL) ? TRUE : FALSE;
305 * Accessible_isTable:
306 * @obj: a pointer to the #Accessible instance to query.
308 * Query whether the specified #Accessible implements #AccessibleTable.
309 * Not Yet Implemented.
311 * Returns: #TRUE if @obj implements the #AccessibleTable interface,
315 Accessible_isTable (Accessible *obj)
317 Bonobo_Unknown iface =
318 Accessibility_Accessible_queryInterface (*obj,
319 "IDL:Accessibility/Table:1.0",
321 return (iface != NULL) ? TRUE : FALSE;
326 * @obj: a pointer to the #Accessible instance to query.
328 * Query whether the specified #Accessible implements #AccessibleText.
329 * Not Yet Implemented.
331 * Returns: #TRUE if @obj implements the #AccessibleText interface,
335 Accessible_isText (Accessible *obj)
337 Bonobo_Unknown iface =
338 Accessibility_Accessible_queryInterface (*obj,
339 "IDL:Accessibility/Text:1.0",
341 return (iface != NULL) ? TRUE : FALSE;
345 * Accessible_getAction:
347 * Not Yet Implemented.
351 Accessible_getAction (Accessible *obj)
353 AccessibleComponent iface =
354 Accessibility_Accessible_queryInterface (*obj,
355 "IDL:Accessibility/Action:1.0",
357 return Obj_Add (iface);
361 * Accessible_getComponent:
362 * @obj: a pointer to the #Accessible instance to query.
364 * Get the #AccessibleComponent interface for an #Accessible.
366 * Returns: a pointer to an #AccessibleComponent interface instance, or
367 * NULL if @obj does not implement #AccessibleComponent.
369 AccessibleComponent *
370 Accessible_getComponent (Accessible *obj)
372 AccessibleComponent iface =
373 Accessibility_Accessible_queryInterface (*obj,
374 "IDL:Accessibility/Component:1.0",
376 return Obj_Add (iface);
379 AccessibleEditableText *
380 Accessible_getEditableText (Accessible *obj)
382 AccessibleComponent iface =
383 Accessibility_Accessible_queryInterface (*obj,
384 "IDL:Accessibility/EditableText:1.0",
386 return Obj_Add (iface);
391 AccessibleHypertext *
392 Accessible_getHypertext (Accessible *obj)
394 AccessibleComponent iface =
395 Accessibility_Accessible_queryInterface (*obj,
396 "IDL:Accessibility/Hypertext:1.0",
398 return Obj_Add (iface);
404 Accessible_getImage (Accessible *obj)
406 AccessibleComponent iface =
407 Accessibility_Accessible_queryInterface (*obj,
408 "IDL:Accessibility/Image:1.0",
410 return Obj_Add (iface);
415 AccessibleSelection *
416 Accessible_getSelection (Accessible *obj)
418 AccessibleComponent iface =
419 Accessibility_Accessible_queryInterface (*obj,
420 "IDL:Accessibility/Selection:1.0",
422 return Obj_Add (iface);
428 Accessible_getTable (Accessible *obj)
430 AccessibleComponent iface =
431 Accessibility_Accessible_queryInterface (*obj,
432 "IDL:Accessibility/Table:1.0",
434 return Obj_Add (iface);
440 Accessible_getText (Accessible *obj)
442 AccessibleComponent iface =
443 Accessibility_Accessible_queryInterface (*obj,
444 "IDL:Accessibility/Text:1.0",
446 return Obj_Add (iface);
452 Accessible_getValue (Accessible *obj)
454 AccessibleComponent iface =
455 Accessibility_Accessible_queryInterface (*obj,
456 "IDL:Accessibility/Value:1.0",
458 return Obj_Add (iface);
464 * Accessible_queryInterface:
465 * @obj: a pointer to the #Accessible instance to query.
466 * @interface_name: a UTF-8 character string specifiying the requested interface.
468 * Query an #Accessible object to for a named interface.
470 * Returns: an instance of the named interface object, if it is implemented
471 * by @obj, or NULL otherwise.
475 Accessible_queryInterface (Accessible *obj, char *interface_name)
477 GenericInterface iface;
478 iface = Accessibility_Accessible_queryInterface (*obj,
481 return (iface != NULL) ? Obj_Add (iface) : NULL;