2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2001, 2002 Sun Microsystems Inc.,
6 * Copyright 2001, 2002 Ximian, Inc.
7 * Copyright 2010, 2011 Novell, Inc.
9 * This library is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU Library General Public
11 * License as published by the Free Software Foundation; either
12 * version 2 of the License, or (at your option) any later version.
14 * This library is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17 * Library General Public License for more details.
19 * You should have received a copy of the GNU Library General Public
20 * License along with this library; if not, write to the
21 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22 * Boston, MA 02111-1307, USA.
25 #include "atspi-private.h"
26 #include "atspi-accessible-private.h"
29 static gboolean enable_caching = FALSE;
30 static guint quark_locale;
33 atspi_action_interface_init (AtspiAction *action)
38 atspi_collection_interface_init (AtspiCollection *component)
43 atspi_component_interface_init (AtspiComponent *component)
48 atspi_document_interface_init (AtspiDocument *document)
53 atspi_editable_text_interface_init (AtspiEditableText *editable_text)
58 atspi_hypertext_interface_init (AtspiHypertext *hypertext)
63 atspi_image_interface_init (AtspiImage *image)
68 atspi_selection_interface_init (AtspiSelection *selection)
73 atspi_table_interface_init (AtspiTable *table)
78 atspi_table_cell_interface_init (AtspiTableCell *cell)
83 atspi_text_interface_init (AtspiText *text)
88 atspi_value_interface_init (AtspiValue *value)
92 G_DEFINE_TYPE_WITH_CODE (AtspiAccessible, atspi_accessible, ATSPI_TYPE_OBJECT,
93 G_ADD_PRIVATE (AtspiAccessible)
94 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_ACTION, atspi_action_interface_init)
95 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_COLLECTION, atspi_collection_interface_init)
96 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_COMPONENT, atspi_component_interface_init)
97 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_DOCUMENT, atspi_document_interface_init)
98 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_EDITABLE_TEXT, atspi_editable_text_interface_init)
99 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_HYPERTEXT, atspi_hypertext_interface_init)
100 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_IMAGE, atspi_image_interface_init)
101 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_SELECTION, atspi_selection_interface_init)
102 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_TABLE, atspi_table_interface_init)
103 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_TABLE_CELL, atspi_table_cell_interface_init)
104 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_TEXT, atspi_text_interface_init)
105 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_VALUE, atspi_value_interface_init))
107 #ifdef DEBUG_REF_COUNTS
108 static gint accessible_count = 0;
112 atspi_accessible_init (AtspiAccessible *accessible)
114 #ifdef DEBUG_REF_COUNTS
116 g_hash_table_insert (_atspi_get_live_refs (), accessible, NULL);
117 g_print("at-spi: init: %d objects\n", accessible_count);
120 accessible->priv = atspi_accessible_get_instance_private (accessible);
124 atspi_accessible_dispose (GObject *object)
126 AtspiAccessible *accessible = ATSPI_ACCESSIBLE (object);
128 AtspiAccessible *parent;
132 /* TODO: Only fire if object not already marked defunct */
133 memset (&e, 0, sizeof (e));
134 e.type = "object:state-changed:defunct";
135 e.source = accessible;
138 _atspi_send_event (&e);
140 if (accessible->states)
142 g_object_unref (accessible->states);
143 accessible->states = NULL;
146 parent = accessible->accessible_parent;
147 if (parent && parent->children)
149 GList*ls = g_list_find (parent->children, accessible);
152 gboolean replace = (ls == parent->children);
153 ls = g_list_remove (ls, accessible);
155 parent->children = ls;
156 g_object_unref (object);
162 g_object_unref (parent);
163 accessible->accessible_parent = NULL;
166 children = accessible->children;
167 accessible->children = NULL;
168 for (l = children; l; l = l->next)
170 AtspiAccessible *child = l->data;
171 if (child && child->accessible_parent == accessible)
173 g_object_unref (accessible);
174 child->accessible_parent = NULL;
176 g_object_unref (child);
178 g_list_free (children);
180 G_OBJECT_CLASS (atspi_accessible_parent_class) ->dispose (object);
184 atspi_accessible_finalize (GObject *object)
186 AtspiAccessible *accessible = ATSPI_ACCESSIBLE (object);
188 g_free (accessible->description);
189 g_free (accessible->name);
190 if (accessible->attributes)
191 g_hash_table_unref (accessible->attributes);
193 if (accessible->priv->cache)
194 g_hash_table_destroy (accessible->priv->cache);
196 #ifdef DEBUG_REF_COUNTS
198 g_hash_table_remove (_atspi_get_live_refs (), accessible);
199 g_print ("at-spi: finalize: %d objects\n", accessible_count);
202 G_OBJECT_CLASS (atspi_accessible_parent_class)
207 atspi_accessible_class_init (AtspiAccessibleClass *klass)
209 GObjectClass *object_class = G_OBJECT_CLASS (klass);
211 object_class->dispose = atspi_accessible_dispose;
212 object_class->finalize = atspi_accessible_finalize;
214 quark_locale = g_quark_from_string ("accessible-locale");
218 * atspi_accessible_get_name:
219 * @obj: a pointer to the #AtspiAccessible object on which to operate.
221 * Gets the name of an #AtspiAccessible object.
223 * Returns: a UTF-8 string indicating the name of the #AtspiAccessible object
224 * or NULL on exception.
227 atspi_accessible_get_name (AtspiAccessible *obj, GError **error)
229 g_return_val_if_fail (obj != NULL, g_strdup (""));
230 if (!_atspi_accessible_test_cache (obj, ATSPI_CACHE_NAME))
232 if (!_atspi_dbus_get_property (obj, atspi_interface_accessible, "Name", error,
234 return g_strdup ("");
235 _atspi_accessible_add_cache (obj, ATSPI_CACHE_NAME);
237 return g_strdup (obj->name);
242 * atspi_accessible_get_unique_id:
243 * @obj: a pointer to the #AtspiAccessible object on which to operate.
245 * Gets the identificator, uniquely identifying object, or NULL if an error occured.
247 * Returns: a UTF-8 string describing the #AtspiAccessible object
248 * or NULL on exception or NULL object passed.
251 atspi_accessible_get_unique_id(AtspiAccessible *obj, GError **error)
254 g_set_error(error, ATSPI_ERROR, ATSPI_ERROR_IPC, "argument is null");
259 gchar *bus_name = atspi_accessible_get_bus_name(obj, error);
260 if (bus_name && bus_name[0]) {
261 gchar *path = atspi_accessible_get_path(obj, error);
263 id = g_strdup_printf("%s:%s", bus_name, path);
265 g_set_error(error, ATSPI_ERROR, ATSPI_ERROR_IPC, "failed to get path");
269 g_set_error(error, ATSPI_ERROR, ATSPI_ERROR_IPC, "failed to get bus name");
275 * atspi_accessible_get_bus_name:
276 * @obj: a pointer to the #AtspiAccessible object on which to operate.
278 * Gets the bus name, where object belongs.
280 * Returns: a UTF-8 string describing the #AtspiAccessible object's
281 * bus name or empty string on exception or NULL object passed.
284 atspi_accessible_get_bus_name(AtspiAccessible *obj, GError **error)
286 if (!obj || !obj->parent.app)
288 return g_strdup (obj->parent.app->bus_name);
292 * atspi_accessible_get_path:
293 * @obj: a pointer to the #AtspiAccessible object on which to operate.
295 * Gets the path, uniquely identifying object over its bus name.
297 * Returns: a UTF-8 string describing the #AtspiAccessible object
298 * or empty string on exception or NULL object passed.
301 atspi_accessible_get_path(AtspiAccessible *obj, GError **error)
303 static const char *prefix = "/org/a11y/atspi/accessible/";
304 static int prefix_len = 27;
308 AtspiObject *o = ATSPI_OBJECT (obj);
311 if (strncmp(o->path, prefix, prefix_len) == 0)
312 return g_strdup(o->path + prefix_len);
313 return g_strdup (o->path);
317 * atspi_accessible_get_navigable_at_point:
318 * @root: a pointer to the #AtspiAccessible to start search from.
319 * @x: a #gint specifying the x coordinate of the point in question.
320 * @y: a #gint specifying the y coordinate of the point in question.
321 * @ctype: the coordinate system of the point (@x, @y)
322 * (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
324 * Finds the accessible element closest to user (highest in z-order), at a given coordinate within an #AtspiAccessible.
325 * This should be the element, that should be picked, when doing mouse click or finger tap at given coordinates.
327 * Returns: (nullable) (transfer full): a pointer to an
328 * #AtspiAccessible descendant (of any depth) of the specified component which
329 * contains the point (@x, @y), or NULL if no descendant contains
333 atspi_accessible_get_navigable_at_point (AtspiAccessible *root,
336 AtspiCoordType ctype, GError **error)
338 dbus_int32_t d_x = x, d_y = y;
339 dbus_uint32_t d_ctype = ctype;
341 AtspiAccessible *return_value = NULL;
342 unsigned char recurse = 0;
343 DBusMessageIter iter;
344 AtspiAccessible *deputy = NULL;
346 g_return_val_if_fail (root != NULL, NULL);
348 reply = _atspi_dbus_call_partial (root, atspi_interface_accessible, "GetNavigableAtPoint", error, "iiu", d_x, d_y, d_ctype);
350 _ATSPI_DBUS_CHECK_SIG (reply, "(so)y(so)", NULL, NULL);
352 dbus_message_iter_init (reply, &iter);
353 AtspiAccessible *tmp = _atspi_dbus_return_accessible_from_iter (&iter);
355 unsigned char value = 0;
356 dbus_message_iter_get_basic (&iter, &value);
357 dbus_message_iter_next (&iter);
358 recurse = (value != 0);
360 /* keep deputy if tmp has deputy */
362 deputy = _atspi_dbus_return_accessible_from_iter (&iter);
364 dbus_message_unref(reply);
368 /* TODO: need to check deputy works for return value */
370 g_object_unref(return_value);
377 g_object_unref(return_value);
378 return_value = root = tmp;
384 * atspi_accessible_get_reading_material:
385 * @obj: a pointer to the #AtspiAccessible object on which to operate.
387 * Gets reading material
389 * Returns: reading material to be used screen-reader side. This is not stable.
390 * You have to handle all alocated memory as below on screen-reader side.
392 * AtspiAccessibleReadingMaterial *rm
393 * g_object_unref(rm->parent);
394 * g_object_unref(rm->described_by_accessible);
395 * g_hash_table_unref(rm->attributes);
397 * free(rm->labeled_by_name);
398 * free(rm->text_interface_name);
399 * free(rm->localized_role_name);
400 * free(rm->description);
403 AtspiAccessibleReadingMaterial *
404 atspi_accessible_get_reading_material (AtspiAccessible *obj, GError **error)
406 AtspiAccessible *parent;
407 AtspiAccessibleReadingMaterial *reading_material = NULL;
409 double current_value;
413 DBusMessageIter iter;
414 DBusMessageIter iter_array;
416 dbus_uint32_t *states;
417 dbus_int32_t index_in_parent;
418 dbus_int32_t child_count;
419 dbus_bool_t is_selected;
421 g_return_val_if_fail (obj != NULL, NULL);
423 reply = _atspi_dbus_call_partial (obj, atspi_interface_accessible, "GetReadingMaterial", error, "");
425 _ATSPI_DBUS_CHECK_SIG (reply, "a{ss}sssuausiddddsibbii(so)auiui(so)", NULL, NULL);
427 reading_material = calloc(1, sizeof(AtspiAccessibleReadingMaterial));
428 if (!reading_material)
430 return reading_material;
433 dbus_message_iter_init (reply, &iter);
436 reading_material->attributes = _atspi_dbus_hash_from_iter (&iter);
437 dbus_message_iter_next (&iter);
440 dbus_message_iter_get_basic (&iter, &name);
441 reading_material->name = g_strdup (name);
442 dbus_message_iter_next (&iter);
444 /* get name of relation LABELED_BY */
445 dbus_message_iter_get_basic (&iter, &name);
446 reading_material->labeled_by_name = g_strdup (name);
447 dbus_message_iter_next (&iter);
449 /* get name of text interface */
450 dbus_message_iter_get_basic (&iter, &name);
451 reading_material->text_interface_name = g_strdup (name);
452 dbus_message_iter_next (&iter);
455 dbus_message_iter_get_basic (&iter, &role);
456 reading_material->role = role;
457 dbus_message_iter_next (&iter);
460 dbus_message_iter_recurse (&iter, &iter_array);
461 dbus_message_iter_get_fixed_array (&iter_array, &states, &count);
462 val = ((guint64)states [1]) << 32;
464 reading_material->states = val;
465 dbus_message_iter_next (&iter);
467 /* get localized role name */
468 dbus_message_iter_get_basic (&iter, &name);
469 reading_material->localized_role_name = g_strdup (name);
470 dbus_message_iter_next (&iter);
472 /* get child count */
473 dbus_message_iter_get_basic (&iter, &child_count);
474 reading_material->child_count = child_count;
475 dbus_message_iter_next (&iter);
477 /* get current value */
478 dbus_message_iter_get_basic (&iter, ¤t_value);
479 reading_material->value = current_value;
480 dbus_message_iter_next (&iter);
482 /* get minimum increment */
483 dbus_message_iter_get_basic (&iter, ¤t_value);
484 reading_material->increment = current_value;
485 dbus_message_iter_next (&iter);
487 /* get maximum value */
488 dbus_message_iter_get_basic (&iter, ¤t_value);
489 reading_material->upper = current_value;
490 dbus_message_iter_next (&iter);
492 /* get minimum value */
493 dbus_message_iter_get_basic (&iter, ¤t_value);
494 reading_material->lower = current_value;
495 dbus_message_iter_next (&iter);
497 /* get description */
498 dbus_message_iter_get_basic (&iter, &name);
499 reading_material->description = g_strdup (name);
500 dbus_message_iter_next (&iter);
502 /* get index in parent */
503 dbus_message_iter_get_basic (&iter, &index_in_parent);
504 reading_material->index_in_parent = index_in_parent;
505 dbus_message_iter_next (&iter);
507 /* get selected in parent */
508 dbus_message_iter_get_basic (&iter, &is_selected);
509 reading_material->is_selected_in_parent = is_selected;
510 dbus_message_iter_next (&iter);
512 /* get has checkbox child */
513 dbus_message_iter_get_basic (&iter, &is_selected);
514 reading_material->has_checkbox_child = is_selected;
515 dbus_message_iter_next (&iter);
517 /* get list children count */
518 dbus_message_iter_get_basic (&iter, &child_count);
519 reading_material->list_children_count = child_count;
520 dbus_message_iter_next (&iter);
522 /* get first selected child index */
523 dbus_message_iter_get_basic (&iter, &index_in_parent);
524 reading_material->first_selected_child_index = index_in_parent;
525 dbus_message_iter_next (&iter);
529 parent = _atspi_dbus_return_accessible_from_iter (&iter);
530 reading_material->parent = parent;
533 dbus_message_iter_recurse (&iter, &iter_array);
534 dbus_message_iter_get_fixed_array (&iter_array, &states, &count);
535 val = ((guint64)states [1]) << 32;
537 reading_material->parent_states = val;
538 dbus_message_iter_next (&iter);
540 /* get parent child count */
541 dbus_message_iter_get_basic (&iter, &child_count);
542 reading_material->parent_child_count = child_count;
543 dbus_message_iter_next (&iter);
545 /* get parent role */
546 dbus_message_iter_get_basic (&iter, &role);
547 reading_material->parent_role = role;
548 dbus_message_iter_next (&iter);
550 /* get parent selected child count */
551 dbus_message_iter_get_basic (&iter, &child_count);
552 reading_material->parent_selected_child_count = child_count;
553 dbus_message_iter_next (&iter);
555 ////////////////////////////////////////
556 /* get relation object - DESCRIBED_BY */
557 parent = _atspi_dbus_return_accessible_from_iter (&iter);
558 reading_material->described_by_accessible = parent;
560 return reading_material;
563 static unsigned char are_objects_on_the_same_bus(AtspiAccessible *obj1, AtspiAccessible *obj2)
565 const char *bus_name_1 = obj1->parent.app->bus_name;
566 const char *bus_name_2 = obj2->parent.app->bus_name;
567 return strcmp(bus_name_1, bus_name_2) == 0;
570 static unsigned char object_is_valid(AtspiAccessible *obj)
574 AtspiStateSet *ss = atspi_accessible_get_state_set(obj);
577 unsigned char valid = atspi_state_set_contains(ss, ATSPI_STATE_DEFUNCT) == 0;
583 NEIGHBOR_SEARCH_MODE_NORMAL = 0,
584 NEIGHBOR_SEARCH_MODE_RECURSE_FROM_ROOT = 1,
585 NEIGHBOR_SEARCH_MODE_CONTINUE_AFTER_FAILED_RECURSING = 2,
586 NEIGHBOR_SEARCH_MODE_RECURSE_TO_OUTSIDE = 3,
587 } GetNeighborSearchMode;
589 * atspi_accessible_get_neighbor:
590 * @root: a pointer to a #AtspiAccessible, which represents current root of subtree to search
591 * @start: a pointer to the #AtspiAccessible to start search from (can be null, which means start from root)
592 * @direction: direction, in which search (forward or backward)
594 * Calculates next (or previous) accessible element in logical order or null if none found.
596 * Returns: (nullable) (transfer full): a pointer to an
597 * #AtspiAccessible element, which is next (previous) in logical order or null if none found.
600 atspi_accessible_get_neighbor (AtspiAccessible *root,
601 AtspiAccessible *start,
602 AtspiNeighborSearchDirection direction,
605 g_return_val_if_fail (object_is_valid(root), NULL);
606 if (!object_is_valid(start))
608 const char *root_path = ATSPI_OBJECT(root)->path;
609 AtspiAccessible *return_value = NULL;
611 unsigned char recurse;
612 GetNeighborSearchMode search_mode = NEIGHBOR_SEARCH_MODE_NORMAL;
613 GQueue *children_root_stack = g_queue_new();
614 DBusMessageIter iter;
617 const char *path = are_objects_on_the_same_bus(root, start) ? root_path : "";
618 DBusMessage *reply = _atspi_dbus_call_partial (start, atspi_interface_accessible, "GetNeighbor", error, "sii", path, (int)direction, (int)search_mode);
620 dbus_message_iter_init (reply, &iter);
621 AtspiAccessible *ret = _atspi_dbus_return_accessible_from_iter (&iter);
623 unsigned char value = 0;
624 dbus_message_iter_get_basic (&iter, &value);
625 dbus_message_iter_next (&iter);
626 recurse = (value != 0);
628 dbus_message_unref(reply);
630 // got return value and request for recursive search, it means ret is on another bridge, than start
631 // thus we're recursing. should the recurse failed to find anything it will end with
632 if (ret && recurse) {
633 g_object_unref(G_OBJECT(start));
636 if (are_objects_on_the_same_bus(root, ret))
638 search_mode = NEIGHBOR_SEARCH_MODE_RECURSE_TO_OUTSIDE;
642 g_queue_push_tail(children_root_stack, ret);
643 search_mode = NEIGHBOR_SEARCH_MODE_RECURSE_FROM_ROOT;
647 // found the one we've been looking for
649 g_object_unref(G_OBJECT(start));
654 // we've stepped into different bridges previously and now we're going back to the last one
655 // and continuing search where we left
656 if (!g_queue_is_empty(children_root_stack)) {
657 g_object_unref(G_OBJECT(start));
658 start = g_queue_pop_tail(children_root_stack);
660 search_mode = NEIGHBOR_SEARCH_MODE_CONTINUE_AFTER_FAILED_RECURSING;
663 // there's no more bridges to check, but we might have started from one
664 // in that case there might be bridges "below" start, which we yet have to visit
665 if (!are_objects_on_the_same_bus(root, start)) {
666 unsigned char continue_loop = 1;
667 while(continue_loop) {
668 AtspiAccessible *parent = atspi_accessible_get_parent(start, NULL);
669 continue_loop = parent ? are_objects_on_the_same_bus(start, parent) : 0;
670 g_object_unref(G_OBJECT(start));
674 // going up thru parents put us in weird place (we didnt meet root on the way)
679 // start object now points to different bridge and must be treated as "resume after recursing"
680 search_mode = NEIGHBOR_SEARCH_MODE_CONTINUE_AFTER_FAILED_RECURSING;
685 g_object_unref(start);
689 while(!g_queue_is_empty(children_root_stack))
690 g_object_unref(g_queue_pop_tail(children_root_stack));
691 g_queue_free(children_root_stack);
697 * atspi_accessible_get_description:
698 * @obj: a pointer to the #AtspiAccessible object on which to operate.
700 * Gets the description of an #AtspiAccessible object.
702 * Returns: a UTF-8 string describing the #AtspiAccessible object
703 * or NULL on exception.
706 atspi_accessible_get_description (AtspiAccessible *obj, GError **error)
708 g_return_val_if_fail (obj != NULL, g_strdup (""));
710 if (!_atspi_accessible_test_cache (obj, ATSPI_CACHE_DESCRIPTION))
712 if (!_atspi_dbus_get_property (obj, atspi_interface_accessible,
713 "Description", error, "s",
715 return g_strdup ("");
716 _atspi_accessible_add_cache (obj, ATSPI_CACHE_DESCRIPTION);
718 return g_strdup (obj->description);
721 const char *str_parent = "Parent";
724 * atspi_accessible_get_parent:
725 * @obj: a pointer to the #AtspiAccessible object to query.
727 * Gets an #AtspiAccessible object's parent container.
729 * Returns: (nullable) (transfer full): a pointer to the
730 * #AtspiAccessible object which contains the given
731 * #AtspiAccessible instance, or NULL if the @obj has no
736 atspi_accessible_get_parent (AtspiAccessible *obj, GError **error)
738 g_return_val_if_fail (obj != NULL, NULL);
740 if (obj->parent.app &&
741 !_atspi_accessible_test_cache (obj, ATSPI_CACHE_PARENT))
743 DBusMessage *message, *reply;
744 DBusMessageIter iter, iter_variant;
745 message = dbus_message_new_method_call (obj->parent.app->bus_name,
747 DBUS_INTERFACE_PROPERTIES, "Get");
750 dbus_message_append_args (message, DBUS_TYPE_STRING, &atspi_interface_accessible,
751 DBUS_TYPE_STRING, &str_parent,
753 reply = _atspi_dbus_send_with_reply_and_block (message, error);
756 if (strcmp (dbus_message_get_signature (reply), "v") != 0)
758 dbus_message_unref (reply);
761 dbus_message_iter_init (reply, &iter);
762 dbus_message_iter_recurse (&iter, &iter_variant);
763 obj->accessible_parent = _atspi_dbus_return_accessible_from_iter (&iter_variant);
764 dbus_message_unref (reply);
765 _atspi_accessible_add_cache (obj, ATSPI_CACHE_PARENT);
767 if (!obj->accessible_parent)
769 return g_object_ref (obj->accessible_parent);
773 * atspi_accessible_get_child_count:
774 * @obj: a pointer to the #AtspiAccessible object on which to operate.
776 * Gets the number of children contained by an #AtspiAccessible object.
778 * Returns: a #long indicating the number of #AtspiAccessible children
779 * contained by an #AtspiAccessible object or -1 on exception.
783 atspi_accessible_get_child_count (AtspiAccessible *obj, GError **error)
785 g_return_val_if_fail (obj != NULL, -1);
787 if (!_atspi_accessible_test_cache (obj, ATSPI_CACHE_CHILDREN))
790 if (!_atspi_dbus_get_property (obj, atspi_interface_accessible,
791 "ChildCount", error, "i", &ret))
796 return g_list_length (obj->children);
800 * atspi_accessible_get_child_at_index:
801 * @obj: a pointer to the #AtspiAccessible object on which to operate.
802 * @child_index: a #long indicating which child is specified.
804 * Gets the #AtspiAccessible child of an #AtspiAccessible object at a given index.
806 * Returns: (transfer full): a pointer to the #AtspiAccessible child object at
807 * index @child_index or NULL on exception.
810 atspi_accessible_get_child_at_index (AtspiAccessible *obj,
814 AtspiAccessible *child;
816 g_return_val_if_fail (obj != NULL, NULL);
818 if (!_atspi_accessible_test_cache (obj, ATSPI_CACHE_CHILDREN))
821 reply = _atspi_dbus_call_partial (obj, atspi_interface_accessible,
822 "GetChildAtIndex", error, "i",
824 return _atspi_dbus_return_accessible_from_message (reply);
827 child = g_list_nth_data (obj->children, child_index);
830 return g_object_ref (child);
834 * atspi_accessible_get_index_in_parent:
835 * @obj: a pointer to the #AtspiAccessible object on which to operate.
837 * Gets the index of an #AtspiAccessible object within its parent's
838 * #AtspiAccessible children list.
840 * Returns: a #glong indicating the index of the #AtspiAccessible object
842 * or -1 if @obj has no containing parent or on exception.
845 atspi_accessible_get_index_in_parent (AtspiAccessible *obj, GError **error)
850 g_return_val_if_fail (obj != NULL, -1);
851 if (_atspi_accessible_test_cache (obj, ATSPI_CACHE_PARENT) &&
852 !obj->accessible_parent)
854 if (!obj->accessible_parent ||
855 !_atspi_accessible_test_cache (obj->accessible_parent,
856 ATSPI_CACHE_CHILDREN))
858 dbus_int32_t ret = -1;
859 _atspi_dbus_call (obj, atspi_interface_accessible,
860 "GetIndexInParent", NULL, "=>i", &ret);
864 l = obj->accessible_parent->children;
867 if (l->data == obj) return i;
878 } Accessibility_Relation;
881 * atspi_accessible_get_relation_set:
882 * @obj: a pointer to the #AtspiAccessible object on which to operate.
884 * Gets the set of #AtspiRelation objects which describes this #AtspiAccessible object's
885 * relationships with other #AtspiAccessible objects.
887 * Returns: (element-type AtspiRelation*) (transfer full): a #GArray of
888 * #AtspiRelation pointers or NULL on exception.
891 atspi_accessible_get_relation_set (AtspiAccessible *obj, GError **error)
894 DBusMessageIter iter, iter_array;
897 g_return_val_if_fail (obj != NULL, NULL);
899 reply = _atspi_dbus_call_partial (obj, atspi_interface_accessible, "GetRelationSet", error, "");
902 _ATSPI_DBUS_CHECK_SIG (reply, "a(ua(so))", error, NULL);
904 ret = g_array_new (TRUE, TRUE, sizeof (AtspiRelation *));
905 dbus_message_iter_init (reply, &iter);
906 dbus_message_iter_recurse (&iter, &iter_array);
907 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
909 AtspiRelation *relation;
910 relation = _atspi_relation_new_from_iter (&iter_array);
911 ret = g_array_append_val (ret, relation);
912 dbus_message_iter_next (&iter_array);
914 dbus_message_unref (reply);
919 * atspi_accessible_get_role:
920 * @obj: a pointer to the #AtspiAccessible object on which to operate.
922 * Gets the UI role played by an #AtspiAccessible object.
923 * This role's name can be obtained via atspi_accessible_get_role_name ().
925 * Returns: the #AtspiRole of an #AtspiAccessible object.
929 atspi_accessible_get_role (AtspiAccessible *obj, GError **error)
931 g_return_val_if_fail (obj != NULL, ATSPI_ROLE_INVALID);
933 if (!_atspi_accessible_test_cache (obj, ATSPI_CACHE_ROLE))
936 /* TODO: Make this a property */
937 if (_atspi_dbus_call (obj, atspi_interface_accessible, "GetRole", error, "=>u", &role))
940 _atspi_accessible_add_cache (obj, ATSPI_CACHE_ROLE);
947 * atspi_accessible_get_role_name:
948 * @obj: a pointer to the #AtspiAccessible object on which to operate.
950 * Gets a UTF-8 string corresponding to the name of the role played by an object.
951 * This method will return useful values for roles that fall outside the
952 * enumeration used in atspi_accessible_get_role ().
954 * Returns: a UTF-8 string specifying the type of UI role played by an
955 * #AtspiAccessible object.
959 atspi_accessible_get_role_name (AtspiAccessible *obj, GError **error)
961 gchar *retval = NULL;
964 g_return_val_if_fail (obj != NULL, NULL);
966 role = atspi_accessible_get_role (obj, error);
967 if (role >= 0 && role < ATSPI_ROLE_COUNT && role != ATSPI_ROLE_EXTENDED)
968 return atspi_role_get_name (role);
970 _atspi_dbus_call (obj, atspi_interface_accessible, "GetRoleName", error, "=>s", &retval);
973 retval = g_strdup ("");
979 * atspi_accessible_get_localized_role_name:
980 * @obj: a pointer to the #AtspiAccessible object on which to operate.
982 * Gets a UTF-8 string corresponding to the name of the role played by an
983 * object, translated to the current locale.
984 * This method will return useful values for roles that fall outside the
985 * enumeration used in atspi_accessible_getRole ().
987 * Returns: a localized, UTF-8 string specifying the type of UI role played
988 * by an #AtspiAccessible object.
992 atspi_accessible_get_localized_role_name (AtspiAccessible *obj, GError **error)
996 g_return_val_if_fail (obj != NULL, NULL);
998 _atspi_dbus_call (obj, atspi_interface_accessible, "GetLocalizedRoleName", error, "=>s", &retval);
1001 return g_strdup ("");
1006 static AtspiStateSet *
1009 AtspiStateSet *set = atspi_state_set_new (NULL);
1010 atspi_state_set_add (set, ATSPI_STATE_DEFUNCT);
1015 * atspi_accessible_get_state_set:
1016 * @obj: a pointer to the #AtspiAccessible object on which to operate.
1018 * Gets the states currently held by an object.
1020 * Returns: (transfer full): a pointer to an #AtspiStateSet representing an
1021 * object's current state set.
1024 atspi_accessible_get_state_set (AtspiAccessible *obj)
1026 /* TODO: Should take a GError **, but would be an API break */
1027 if (!obj->parent.app || !obj->parent.app->bus)
1028 return defunct_set ();
1030 if (!_atspi_accessible_test_cache (obj, ATSPI_CACHE_STATES))
1033 DBusMessageIter iter;
1034 reply = _atspi_dbus_call_partial (obj, atspi_interface_accessible,
1035 "GetState", NULL, "");
1036 _ATSPI_DBUS_CHECK_SIG (reply, "au", NULL, defunct_set ());
1037 dbus_message_iter_init (reply, &iter);
1038 _atspi_dbus_set_state (obj, &iter);
1039 dbus_message_unref (reply);
1040 _atspi_accessible_add_cache (obj, ATSPI_CACHE_STATES);
1042 return g_object_ref (obj->states);
1046 * atspi_accessible_get_attributes:
1047 * @obj: The #AtspiAccessible being queried.
1049 * Gets the #AttributeSet representing any assigned
1050 * name-value pair attributes or annotations for this object.
1051 * For typographic, textual, or textually-semantic attributes, see
1052 * atspi_text_get_attributes instead.
1054 * Returns: (element-type gchar* gchar*) (transfer full): The name-value-pair
1055 * attributes assigned to this object.
1058 atspi_accessible_get_attributes (AtspiAccessible *obj, GError **error)
1060 DBusMessage *message;
1062 g_return_val_if_fail (obj != NULL, NULL);
1064 if (obj->priv->cache)
1066 GValue *val = g_hash_table_lookup (obj->priv->cache, "Attributes");
1068 return g_value_dup_boxed (val);
1071 if (!_atspi_accessible_test_cache (obj, ATSPI_CACHE_ATTRIBUTES))
1073 message = _atspi_dbus_call_partial (obj, atspi_interface_accessible,
1074 "GetAttributes", error, "");
1075 obj->attributes = _atspi_dbus_return_hash_from_message (message);
1076 _atspi_accessible_add_cache (obj, ATSPI_CACHE_ATTRIBUTES);
1079 if (!obj->attributes)
1081 return g_hash_table_ref (obj->attributes);
1085 add_to_attribute_array (gpointer key, gpointer value, gpointer data)
1087 GArray **array = (GArray **)data;
1088 gchar *str = g_strconcat (key, ":", value, NULL);
1089 *array = g_array_append_val (*array, str);
1093 * atspi_accessible_get_attributes_as_array:
1094 * @obj: The #AtspiAccessible being queried.
1096 * Gets a #GArray representing any assigned
1097 * name-value pair attributes or annotations for this object.
1098 * For typographic, textual, or textually-semantic attributes, see
1099 * atspi_text_get_attributes_as_array instead.
1101 * Returns: (element-type gchar*) (transfer full): The name-value-pair
1102 * attributes assigned to this object.
1105 atspi_accessible_get_attributes_as_array (AtspiAccessible *obj, GError **error)
1107 DBusMessage *message;
1109 g_return_val_if_fail (obj != NULL, NULL);
1111 if (obj->priv->cache)
1113 GValue *val = g_hash_table_lookup (obj->priv->cache, "Attributes");
1116 GArray *array = g_array_new (TRUE, TRUE, sizeof (gchar *));
1117 GHashTable *attributes = g_value_get_boxed (val);
1118 g_hash_table_foreach (attributes, add_to_attribute_array, &array);
1123 message = _atspi_dbus_call_partial (obj, atspi_interface_accessible, "GetAttributes", error, "");
1124 return _atspi_dbus_return_attribute_array_from_message (message);
1128 * atspi_accessible_get_application:
1129 * @obj: The #AtspiAccessible being queried.
1131 * Gets the containing #AtspiApplication for an object.
1133 * Returns: (transfer full): the containing #AtspiApplication instance for
1137 atspi_accessible_get_application (AtspiAccessible *obj, GError **error)
1139 AtspiAccessible *parent;
1144 parent = atspi_accessible_get_parent (obj, NULL);
1145 if (!parent && obj->parent.app &&
1146 atspi_accessible_get_role (obj, NULL) != ATSPI_ROLE_APPLICATION)
1148 AtspiAccessible *root = g_object_ref (obj->parent.app->root);
1151 g_object_unref (obj);
1152 if (atspi_accessible_get_role (root, NULL) == ATSPI_ROLE_DESKTOP_FRAME)
1154 g_object_unref (root);
1160 if (!parent || parent == obj ||
1161 atspi_accessible_get_role (parent, NULL) == ATSPI_ROLE_DESKTOP_FRAME)
1164 g_object_unref (parent);
1167 g_object_unref (obj);
1172 /* Application-specific methods */
1175 * atspi_accessible_get_toolkit_name:
1176 * @obj: a pointer to the #AtspiAccessible object on which to operate.
1178 * Gets the toolkit name for an #AtspiAccessible object.
1179 * Only works on application root objects.
1181 * Returns: a UTF-8 string indicating the toolkit name for the #AtspiAccessible object or NULL on exception.
1184 atspi_accessible_get_toolkit_name (AtspiAccessible *obj, GError **error)
1186 g_return_val_if_fail (obj != NULL, NULL);
1188 if (!obj->parent.app)
1191 if (!obj->parent.app->toolkit_name)
1192 _atspi_dbus_get_property (obj, atspi_interface_application, "ToolkitName",
1193 error, "s", &obj->parent.app->toolkit_name);
1195 return g_strdup (obj->parent.app->toolkit_name);
1199 * atspi_accessible_get_toolkit_version:
1200 * @obj: a pointer to the #AtspiAccessible object on which to operate.
1202 * Gets the toolkit version for an #AtspiAccessible object.
1203 * Only works on application root objects.
1205 * Returns: a UTF-8 string indicating the toolkit version for the #AtspiAccessible object or NULL on exception.
1208 atspi_accessible_get_toolkit_version (AtspiAccessible *obj, GError **error)
1210 g_return_val_if_fail (obj != NULL, NULL);
1212 if (!obj->parent.app)
1215 if (!obj->parent.app->toolkit_version)
1216 _atspi_dbus_get_property (obj, atspi_interface_application, "Version",
1217 error, "s", &obj->parent.app->toolkit_version);
1219 return g_strdup (obj->parent.app->toolkit_version);
1223 * atspi_accessible_get_atspi_version:
1224 * @obj: a pointer to the #AtspiAccessible object on which to operate.
1226 * Gets the AT-SPI IPC specification version supported by the application
1227 * pointed to by the #AtspiAccessible object.
1228 * Only works on application root objects.
1230 * Returns: a UTF-8 string indicating the AT-SPI version for the #AtspiAccessible object or NULL on exception.
1233 atspi_accessible_get_atspi_version (AtspiAccessible *obj, GError **error)
1235 g_return_val_if_fail (obj != NULL, NULL);
1237 if (!obj->parent.app)
1240 if (!obj->parent.app->atspi_version)
1241 _atspi_dbus_get_property (obj, atspi_interface_application, "AtspiVersion",
1242 error, "s", &obj->parent.app->atspi_version);
1244 return g_strdup (obj->parent.app->atspi_version);
1248 * atspi_accessible_get_id:
1249 * @obj: a pointer to the #AtspiAccessible object on which to operate.
1251 * Gets the application id for a #AtspiAccessible object.
1252 * Only works on application root objects.
1254 * Returns: a positive #gint indicating the id for the #AtspiAccessible object
1255 * or -1 on exception.
1258 atspi_accessible_get_id (AtspiAccessible *obj, GError **error)
1262 g_return_val_if_fail (obj != NULL, -1);
1264 if (!_atspi_dbus_get_property (obj, atspi_interface_application, "Id", error, "i", &ret))
1270 /* Interface query methods */
1273 _atspi_accessible_is_a (AtspiAccessible *accessible,
1274 const char *interface_name)
1278 if (accessible == NULL)
1283 if (!_atspi_accessible_test_cache (accessible, ATSPI_CACHE_INTERFACES))
1286 DBusMessageIter iter;
1287 reply = _atspi_dbus_call_partial (accessible, atspi_interface_accessible,
1288 "GetInterfaces", NULL, "");
1289 _ATSPI_DBUS_CHECK_SIG (reply, "as", NULL, FALSE);
1290 dbus_message_iter_init (reply, &iter);
1291 _atspi_dbus_set_interfaces (accessible, &iter);
1292 dbus_message_unref (reply);
1293 _atspi_accessible_add_cache (accessible, ATSPI_CACHE_INTERFACES);
1296 n = _atspi_get_iface_num (interface_name);
1297 if (n == -1) return FALSE;
1298 return (gboolean) ((accessible->interfaces & (1 << n))? TRUE: FALSE);
1302 * atspi_accessible_is_action:
1303 * @obj: a pointer to the #AtspiAccessible instance to query.
1305 * Query whether the specified #AtspiAccessible implements the
1306 * #AtspiAction interface.
1308 * Returns: #TRUE if @obj implements the #AtspiAction interface,
1312 atspi_accessible_is_action (AtspiAccessible *obj)
1314 return _atspi_accessible_is_a (obj,
1315 atspi_interface_action);
1319 * atspi_accessible_is_application:
1320 * @obj: a pointer to the #AtspiAccessible instance to query.
1322 * Query whether the specified #AtspiAccessible implements the
1323 * #AtspiApplication interface.
1325 * Returns: #TRUE if @obj implements the #AtspiApplication interface,
1329 atspi_accessible_is_application (AtspiAccessible *obj)
1331 return _atspi_accessible_is_a (obj,
1332 atspi_interface_application);
1336 * atspi_accessible_is_collection:
1337 * @obj: a pointer to the #AtspiAccessible instance to query.
1339 * Query whether the specified #AtspiAccessible implements the
1340 * #AtspiCollection interface.
1342 * Returns: #TRUE if @obj implements the #AtspiCollection interface,
1346 atspi_accessible_is_collection (AtspiAccessible *obj)
1348 return _atspi_accessible_is_a (obj,
1349 atspi_interface_collection);
1353 * atspi_accessible_is_component:
1354 * @obj: a pointer to the #AtspiAccessible instance to query.
1356 * Query whether the specified #AtspiAccessible implements #AtspiComponent.
1358 * Returns: #TRUE if @obj implements the #AtspiComponent interface,
1362 atspi_accessible_is_component (AtspiAccessible *obj)
1364 return _atspi_accessible_is_a (obj,
1365 atspi_interface_component);
1369 * atspi_accessible_is_document:
1370 * @obj: a pointer to the #AtspiAccessible instance to query.
1372 * Query whether the specified #AtspiAccessible implements the
1373 * #AtspiDocument interface.
1375 * Returns: #TRUE if @obj implements the #AtspiDocument interface,
1379 atspi_accessible_is_document (AtspiAccessible *obj)
1381 return _atspi_accessible_is_a (obj,
1382 atspi_interface_document);
1386 * atspi_accessible_is_editable_text:
1387 * @obj: a pointer to the #AtspiAccessible instance to query.
1389 * Query whether the specified #AtspiAccessible implements the
1390 * #AtspiEditableText interface.
1392 * Returns: #TRUE if @obj implements the #AtspiEditableText interface,
1396 atspi_accessible_is_editable_text (AtspiAccessible *obj)
1398 return _atspi_accessible_is_a (obj,
1399 atspi_interface_editable_text);
1403 * atspi_accessible_is_hypertext:
1404 * @obj: a pointer to the #AtspiAccessible instance to query.
1406 * Query whether the specified #AtspiAccessible implements the
1407 * #AtspiHypertext interface.
1409 * Returns: #TRUE if @obj implements the #AtspiHypertext interface,
1413 atspi_accessible_is_hypertext (AtspiAccessible *obj)
1415 return _atspi_accessible_is_a (obj,
1416 atspi_interface_hypertext);
1420 * atspi_accessible_is_hyperlink:
1421 * @obj: a pointer to the #AtspiAccessible instance to query.
1423 * Query whether the specified #AtspiAccessible implements the
1424 * #AtspiHyperlink interface.
1426 * Returns: #TRUE if @obj implements the #AtspiHypertext interface,
1430 atspi_accessible_is_hyperlink (AtspiAccessible *obj)
1432 return _atspi_accessible_is_a (obj,
1433 atspi_interface_hyperlink);
1437 * atspi_accessible_is_image:
1438 * @obj: a pointer to the #AtspiAccessible instance to query.
1440 * Query whether the specified #AtspiAccessible implements the
1441 * #AtspiImage interface.
1443 * Returns: #TRUE if @obj implements the #AtspiImage interface,
1447 atspi_accessible_is_image (AtspiAccessible *obj)
1449 return _atspi_accessible_is_a (obj,
1450 atspi_interface_image);
1454 * atspi_accessible_is_selection:
1455 * @obj: a pointer to the #AtspiAccessible instance to query.
1457 * Query whether the specified #AtspiAccessible implements the
1458 * #AtspiSelection interface.
1460 * Returns: #TRUE if @obj implements the #AtspiSelection interface,
1464 atspi_accessible_is_selection (AtspiAccessible *obj)
1466 return _atspi_accessible_is_a (obj,
1467 atspi_interface_selection);
1471 * atspi_accessible_is_table:
1472 * @obj: a pointer to the #AtspiAccessible instance to query.
1474 * Query whether the specified #AtspiAccessible implements the
1475 * #AtspiTable interface.
1477 * Returns: #TRUE if @obj implements the #AtspiTable interface,
1481 atspi_accessible_is_table (AtspiAccessible *obj)
1483 return _atspi_accessible_is_a (obj,
1484 atspi_interface_table);
1488 * atspi_accessible_is_table_cell:
1489 * @obj: a pointer to the #AtspiAccessible instance to query.
1491 * Query whether the specified #AtspiAccessible implements the
1492 * #AtspiTableCell interface.
1494 * Returns: #TRUE if @obj implements the #AtspiTable interface,
1498 atspi_accessible_is_table_cell (AtspiAccessible *obj)
1500 return _atspi_accessible_is_a (obj,
1501 atspi_interface_table_cell);
1505 * atspi_accessible_is_streamable_content:
1506 * @obj: a pointer to the #AtspiAccessible instance to query.
1508 * Query whether the specified #AtspiAccessible implements the
1509 * #AtspiStreamableContent interface.
1511 * Returns: #TRUE if @obj implements the #AtspiStreamableContent interface,
1515 atspi_accessible_is_streamable_content (AtspiAccessible *obj)
1518 return _atspi_accessible_is_a (obj,
1519 atspi_interface_streamable_content);
1521 g_warning ("Streamable content not implemented");
1527 * atspi_accessible_is_text:
1528 * @obj: a pointer to the #AtspiAccessible instance to query.
1530 * Query whether the specified #AtspiAccessible implements the
1531 * #AtspiText interface.
1533 * Returns: #TRUE if @obj implements the #AtspiText interface,
1537 atspi_accessible_is_text (AtspiAccessible *obj)
1539 return _atspi_accessible_is_a (obj,
1540 atspi_interface_text);
1544 * atspi_accessible_is_value:
1545 * @obj: a pointer to the #AtspiAccessible instance to query.
1547 * Query whether the specified #AtspiAccessible implements the
1548 * #AtspiValue interface.
1550 * Returns: #TRUE if @obj implements the #AtspiValue interface,
1554 atspi_accessible_is_value (AtspiAccessible *obj)
1556 return _atspi_accessible_is_a (obj,
1557 atspi_interface_value);
1561 * atspi_accessible_get_action: (rename-to atspi_accessible_get_action_iface)
1562 * @obj: a pointer to the #AtspiAccessible instance to query.
1564 * Gets the #AtspiAction interface for an #AtspiAccessible.
1566 * Returns: (transfer full): a pointer to an #AtspiAction interface
1567 * instance, or NULL if @obj does not implement #AtspiAction.
1569 * Deprecated: 2.10: Use atspi_accessible_get_action_iface instead.
1572 atspi_accessible_get_action (AtspiAccessible *accessible)
1574 return (_atspi_accessible_is_a (accessible, atspi_interface_action) ?
1575 g_object_ref (ATSPI_ACTION (accessible)) : NULL);
1579 * atspi_accessible_get_action_iface:
1580 * @obj: a pointer to the #AtspiAccessible instance to query.
1582 * Gets the #AtspiAction interface for an #AtspiAccessible.
1584 * Returns: (transfer full): a pointer to an #AtspiAction interface
1585 * instance, or NULL if @obj does not implement #AtspiAction.
1588 atspi_accessible_get_action_iface (AtspiAccessible *accessible)
1590 return (_atspi_accessible_is_a (accessible, atspi_interface_action) ?
1591 g_object_ref (ATSPI_ACTION (accessible)) : NULL);
1595 * atspi_accessible_get_collection: (rename-to atspi_accessible_get_collection_iface)
1596 * @obj: a pointer to the #AtspiAccessible instance to query.
1598 * Gets the #AtspiCollection interface for an #AtspiAccessible.
1600 * Returns: (transfer full): a pointer to an #AtspiCollection interface
1601 * instance, or NULL if @obj does not implement #AtspiCollection.
1603 * Deprecated: 2.10: Use atspi_accessible_get_collection_iface instead.
1606 atspi_accessible_get_collection (AtspiAccessible *accessible)
1608 return (_atspi_accessible_is_a (accessible, atspi_interface_collection) ?
1609 g_object_ref (ATSPI_COLLECTION (accessible)) : NULL);
1613 * atspi_accessible_get_collection_iface:
1614 * @obj: a pointer to the #AtspiAccessible instance to query.
1616 * Gets the #AtspiCollection interface for an #AtspiAccessible.
1618 * Returns: (transfer full): a pointer to an #AtspiCollection interface
1619 * instance, or NULL if @obj does not implement #AtspiCollection.
1622 atspi_accessible_get_collection_iface (AtspiAccessible *accessible)
1624 return (_atspi_accessible_is_a (accessible, atspi_interface_collection) ?
1625 g_object_ref (ATSPI_COLLECTION (accessible)) : NULL);
1629 * atspi_accessible_get_component: (rename-to atspi_accessible_get_component_iface)
1630 * @obj: a pointer to the #AtspiAccessible instance to query.
1632 * Gets the #AtspiComponent interface for an #AtspiAccessible.
1634 * Returns: (transfer full): a pointer to an #AtspiComponent interface
1635 * instance, or NULL if @obj does not implement #AtspiComponent.
1637 * Deprecated: 2.10: Use atspi_accessible_get_component_iface instead.
1640 atspi_accessible_get_component (AtspiAccessible *obj)
1642 return (_atspi_accessible_is_a (obj, atspi_interface_component) ?
1643 g_object_ref (ATSPI_COMPONENT (obj)) : NULL);
1647 * atspi_accessible_get_component_iface:
1648 * @obj: a pointer to the #AtspiAccessible instance to query.
1650 * Gets the #AtspiComponent interface for an #AtspiAccessible.
1652 * Returns: (transfer full): a pointer to an #AtspiComponent interface
1653 * instance, or NULL if @obj does not implement #AtspiComponent.
1656 atspi_accessible_get_component_iface (AtspiAccessible *obj)
1658 return (_atspi_accessible_is_a (obj, atspi_interface_component) ?
1659 g_object_ref (ATSPI_COMPONENT (obj)) : NULL);
1663 * atspi_accessible_get_document: (rename-to atspi_accessible_get_document_iface)
1664 * @obj: a pointer to the #AtspiAccessible instance to query.
1666 * Gets the #AtspiDocument interface for an #AtspiAccessible.
1668 * Returns: (transfer full): a pointer to an #AtspiDocument interface
1669 * instance, or NULL if @obj does not implement #AtspiDocument.
1671 * Deprecated: 2.10: Use atspi_accessible_get_document_iface instead.
1674 atspi_accessible_get_document (AtspiAccessible *accessible)
1676 return (_atspi_accessible_is_a (accessible, atspi_interface_document) ?
1677 g_object_ref (ATSPI_DOCUMENT (accessible)) : NULL);
1681 * atspi_accessible_get_document_iface:
1682 * @obj: a pointer to the #AtspiAccessible instance to query.
1684 * Gets the #AtspiDocument interface for an #AtspiAccessible.
1686 * Returns: (transfer full): a pointer to an #AtspiDocument interface
1687 * instance, or NULL if @obj does not implement #AtspiDocument.
1690 atspi_accessible_get_document_iface (AtspiAccessible *accessible)
1692 return (_atspi_accessible_is_a (accessible, atspi_interface_document) ?
1693 g_object_ref (ATSPI_DOCUMENT (accessible)) : NULL);
1697 * atspi_accessible_get_editable_text: (rename-to atspi_accessible_get_editable_text_iface)
1698 * @obj: a pointer to the #AtspiAccessible instance to query.
1700 * Gets the #AtspiEditableText interface for an #AtspiAccessible.
1702 * Returns: (transfer full): a pointer to an #AtspiEditableText interface
1703 * instance, or NULL if @obj does not implement #AtspiEditableText.
1705 * Deprecated: 2.10: Use atspi_accessible_get_editable_text_iface instead.
1708 atspi_accessible_get_editable_text (AtspiAccessible *accessible)
1710 return (_atspi_accessible_is_a (accessible, atspi_interface_editable_text) ?
1711 g_object_ref (ATSPI_EDITABLE_TEXT (accessible)) : NULL);
1715 * atspi_accessible_get_editable_text_iface:
1716 * @obj: a pointer to the #AtspiAccessible instance to query.
1718 * Gets the #AtspiEditableText interface for an #AtspiAccessible.
1720 * Returns: (transfer full): a pointer to an #AtspiEditableText interface
1721 * instance, or NULL if @obj does not implement #AtspiEditableText.
1724 atspi_accessible_get_editable_text_iface (AtspiAccessible *accessible)
1726 return (_atspi_accessible_is_a (accessible, atspi_interface_editable_text) ?
1727 g_object_ref (ATSPI_EDITABLE_TEXT (accessible)) : NULL);
1731 * atspi_accessible_get_hyperlink:
1732 * @obj: a pointer to the #AtspiAccessible object on which to operate.
1734 * Gets the #AtspiHyperlink interface for an #AtspiAccessible.
1736 * Returns: (transfer full): the #AtspiHyperlink object associated with
1737 * the given #AtspiAccessible, or NULL if not supported.
1740 atspi_accessible_get_hyperlink (AtspiAccessible *accessible)
1742 return (_atspi_accessible_is_a (accessible, atspi_interface_hyperlink) ?
1743 _atspi_hyperlink_new (accessible->parent.app, accessible->parent.path) : NULL);
1747 * atspi_accessible_get_hypertext: (rename-to atspi_accessible_get_hypertext_iface)
1748 * @obj: a pointer to the #AtspiAccessible instance to query.
1750 * Gets the #AtspiHypertext interface for an #AtspiAccessible.
1752 * Returns: (transfer full): a pointer to an #AtspiHypertext interface
1753 * instance, or NULL if @obj does not implement #AtspiHypertext.
1755 * Deprecated: 2.10: Use atspi_accessible_get_hypertext_iface instead.
1758 atspi_accessible_get_hypertext (AtspiAccessible *accessible)
1760 return (_atspi_accessible_is_a (accessible, atspi_interface_hypertext) ?
1761 g_object_ref (ATSPI_HYPERTEXT (accessible)) : NULL);
1765 * atspi_accessible_get_hypertext_iface:
1766 * @obj: a pointer to the #AtspiAccessible instance to query.
1768 * Gets the #AtspiHypertext interface for an #AtspiAccessible.
1770 * Returns: (transfer full): a pointer to an #AtspiHypertext interface
1771 * instance, or NULL if @obj does not implement #AtspiHypertext.
1774 atspi_accessible_get_hypertext_iface (AtspiAccessible *accessible)
1776 return (_atspi_accessible_is_a (accessible, atspi_interface_hypertext) ?
1777 g_object_ref (ATSPI_HYPERTEXT (accessible)) : NULL);
1781 * atspi_accessible_get_image: (rename-to atspi_accessible_get_image_iface)
1782 * @obj: a pointer to the #AtspiAccessible instance to query.
1784 * Gets the #AtspiImage interface for an #AtspiAccessible.
1786 * Returns: (transfer full): a pointer to an #AtspiImage interface instance, or
1787 * NULL if @obj does not implement #AtspiImage.
1789 * Deprecated: 2.10: Use atspi_accessible_get_image_iface instead.
1792 atspi_accessible_get_image (AtspiAccessible *accessible)
1794 return (_atspi_accessible_is_a (accessible, atspi_interface_image) ?
1795 g_object_ref (ATSPI_IMAGE (accessible)) : NULL);
1799 * atspi_accessible_get_image_iface:
1800 * @obj: a pointer to the #AtspiAccessible instance to query.
1802 * Gets the #AtspiImage interface for an #AtspiAccessible.
1804 * Returns: (transfer full): a pointer to an #AtspiImage interface instance, or
1805 * NULL if @obj does not implement #AtspiImage.
1808 atspi_accessible_get_image_iface (AtspiAccessible *accessible)
1810 return (_atspi_accessible_is_a (accessible, atspi_interface_image) ?
1811 g_object_ref (ATSPI_IMAGE (accessible)) : NULL);
1815 * atspi_accessible_get_selection: (rename-to atspi_accessible_get_selection_iface)
1816 * @obj: a pointer to the #AtspiAccessible instance to query.
1818 * Gets the #AtspiSelection interface for an #AtspiAccessible.
1820 * Returns: (transfer full): a pointer to an #AtspiSelection interface
1821 * instance, or NULL if @obj does not implement #AtspiSelection.
1823 * Deprecated: 2.10: Use atspi_accessible_get_selection_iface instead.
1826 atspi_accessible_get_selection (AtspiAccessible *accessible)
1828 return (_atspi_accessible_is_a (accessible, atspi_interface_selection) ?
1829 g_object_ref (ATSPI_SELECTION (accessible)) : NULL);
1833 * atspi_accessible_get_selection_iface:
1834 * @obj: a pointer to the #AtspiAccessible instance to query.
1836 * Gets the #AtspiSelection interface for an #AtspiAccessible.
1838 * Returns: (transfer full): a pointer to an #AtspiSelection interface
1839 * instance, or NULL if @obj does not implement #AtspiSelection.
1842 atspi_accessible_get_selection_iface (AtspiAccessible *accessible)
1844 return (_atspi_accessible_is_a (accessible, atspi_interface_selection) ?
1845 g_object_ref (ATSPI_SELECTION (accessible)) : NULL);
1850 * atspi_accessible_get_streamable_content:
1851 * @obj: a pointer to the #AtspiAccessible instance to query.
1853 * Gets the #AtspiStreamableContent interface for an #AtspiAccessible.
1855 * Returns: (transfer full): a pointer to an #AtspiStreamableContent interface
1856 * instance, or NULL if @obj does not implement #AtspiStreamableContent.
1858 AtspiStreamableContent *
1859 atspi_accessible_get_streamable_content (AtspiAccessible *accessible)
1861 return (_atspi_accessible_is_a (accessible, atspi_interface_streamable_content) ?
1867 * atspi_accessible_get_table: (rename-to atspi_accessible_get_table_iface)
1868 * @obj: a pointer to the #AtspiAccessible instance to query.
1870 * Gets the #AtspiTable interface for an #AtspiAccessible.
1872 * Returns: (transfer full): a pointer to an #AtspiTable interface instance, or
1873 * NULL if @obj does not implement #AtspiTable.
1875 * Deprecated: 2.10: Use atspi_accessible_get_table_iface instead.
1878 atspi_accessible_get_table (AtspiAccessible *obj)
1880 return (_atspi_accessible_is_a (obj, atspi_interface_table) ?
1881 g_object_ref (ATSPI_TABLE (obj)) : NULL);
1885 * atspi_accessible_get_table_iface:
1886 * @obj: a pointer to the #AtspiAccessible instance to query.
1888 * Gets the #AtspiTable interface for an #AtspiAccessible.
1890 * Returns: (transfer full): a pointer to an #AtspiTable interface instance, or
1891 * NULL if @obj does not implement #AtspiTable.
1894 atspi_accessible_get_table_iface (AtspiAccessible *obj)
1896 return (_atspi_accessible_is_a (obj, atspi_interface_table) ?
1897 g_object_ref (ATSPI_TABLE (obj)) : NULL);
1901 * atspi_accessible_get_table_cell:
1902 * @obj: a pointer to the #AtspiAccessible instance to query.
1904 * Gets the #AtspiTableCell interface for an #AtspiAccessible.
1906 * Returns: (transfer full): a pointer to an #AtspiTableCell interface instance,
1907 * or NULL if @obj does not implement #AtspiTable.
1910 atspi_accessible_get_table_cell (AtspiAccessible *obj)
1912 return (_atspi_accessible_is_a (obj, atspi_interface_table_cell) ?
1913 g_object_ref (ATSPI_TABLE_CELL (obj)) : NULL);
1917 * atspi_accessible_get_text: (rename-to atspi_accessible_get_text_iface)
1918 * @obj: a pointer to the #AtspiAccessible instance to query.
1920 * Gets the #AtspiTable interface for an #AtspiAccessible.
1922 * Returns: (transfer full): a pointer to an #AtspiText interface instance, or
1923 * NULL if @obj does not implement #AtspiText.
1925 * Deprecated: 2.10: Use atspi_accessible_get_text_iface instead.
1928 atspi_accessible_get_text (AtspiAccessible *obj)
1930 return (_atspi_accessible_is_a (obj, atspi_interface_text) ?
1931 g_object_ref (ATSPI_TEXT (obj)) : NULL);
1935 * atspi_accessible_get_text_iface:
1936 * @obj: a pointer to the #AtspiAccessible instance to query.
1938 * Gets the #AtspiTable interface for an #AtspiAccessible.
1940 * Returns: (transfer full): a pointer to an #AtspiText interface instance, or
1941 * NULL if @obj does not implement #AtspiText.
1944 atspi_accessible_get_text_iface (AtspiAccessible *obj)
1946 return (_atspi_accessible_is_a (obj, atspi_interface_text) ?
1947 g_object_ref (ATSPI_TEXT (obj)) : NULL);
1951 * atspi_accessible_get_value: (rename-to atspi_accessible_get_value_iface)
1952 * @obj: a pointer to the #AtspiAccessible instance to query.
1954 * Gets the #AtspiTable interface for an #AtspiAccessible.
1956 * Returns: (transfer full): a pointer to an #AtspiValue interface instance, or
1957 * NULL if @obj does not implement #AtspiValue.
1959 * Deprecated: 2.10: Use atspi_accessible_get_value_iface instead.
1962 atspi_accessible_get_value (AtspiAccessible *accessible)
1964 return (_atspi_accessible_is_a (accessible, atspi_interface_value) ?
1965 g_object_ref (ATSPI_VALUE (accessible)) : NULL);
1969 * atspi_accessible_get_value_iface:
1970 * @obj: a pointer to the #AtspiAccessible instance to query.
1972 * Gets the #AtspiTable interface for an #AtspiAccessible.
1974 * Returns: (transfer full): a pointer to an #AtspiValue interface instance, or
1975 * NULL if @obj does not implement #AtspiValue.
1978 atspi_accessible_get_value_iface (AtspiAccessible *accessible)
1980 return (_atspi_accessible_is_a (accessible, atspi_interface_value) ?
1981 g_object_ref (ATSPI_VALUE (accessible)) : NULL);
1985 append_const_val (GArray *array, const gchar *val)
1987 gchar *dup = g_strdup (val);
1990 g_array_append_val (array, dup);
1994 * atspi_accessible_get_interfaces:
1995 * @obj: The #AtspiAccessible to query.
1997 * A set of pointers to all interfaces supported by an #AtspiAccessible.
1999 * Returns: (element-type gchar*) (transfer full): A #GArray of strings
2000 * describing the interfaces supported by the object. Interfaces are
2001 * denoted in short-hand (i.e. "Component", "Text" etc.).
2004 atspi_accessible_get_interfaces (AtspiAccessible *obj)
2006 GArray *ret = g_array_new (TRUE, TRUE, sizeof (gchar *));
2008 g_return_val_if_fail (obj != NULL, NULL);
2010 append_const_val (ret, "Accessible");
2011 if (atspi_accessible_is_action (obj))
2012 append_const_val (ret, "Action");
2013 if (atspi_accessible_is_collection (obj))
2014 append_const_val (ret, "Collection");
2015 if (atspi_accessible_is_component (obj))
2016 append_const_val (ret, "Component");
2017 if (atspi_accessible_is_document (obj))
2018 append_const_val (ret, "Document");
2019 if (atspi_accessible_is_editable_text (obj))
2020 append_const_val (ret, "EditableText");
2021 if (atspi_accessible_is_hypertext (obj))
2022 append_const_val (ret, "Hypertext");
2023 if (atspi_accessible_is_hyperlink (obj))
2024 append_const_val (ret, "Hyperlink");
2025 if (atspi_accessible_is_image (obj))
2026 append_const_val (ret, "Image");
2027 if (atspi_accessible_is_selection (obj))
2028 append_const_val (ret, "Selection");
2029 if (atspi_accessible_is_table (obj))
2030 append_const_val (ret, "Table");
2031 if (atspi_accessible_is_table_cell (obj))
2032 append_const_val (ret, "TableCell");
2033 if (atspi_accessible_is_text (obj))
2034 append_const_val (ret, "Text");
2035 if (atspi_accessible_is_value (obj))
2036 append_const_val (ret, "Value");
2042 _atspi_accessible_new (AtspiApplication *app, const gchar *path)
2044 AtspiAccessible *accessible;
2046 accessible = g_object_new (ATSPI_TYPE_ACCESSIBLE, NULL);
2047 g_return_val_if_fail (accessible != NULL, NULL);
2049 accessible->parent.app = g_object_ref (app);
2050 accessible->parent.path = g_strdup (path);
2056 * atspi_accessible_set_cache_mask:
2057 * @accessible: The #AtspiAccessible to operate on. Must be the desktop or
2058 * the root of an application.
2059 * @mask: An #AtspiCache specifying a bit mask of the types of data to cache.
2061 * Sets the type of data to cache for accessibles.
2062 * If this is not set for an application or is reset to ATSPI_CACHE_UNDEFINED,
2063 * then the desktop's cache flag will be used.
2064 * If the desktop's cache flag is also undefined, then all possible data will
2066 * This function is intended to work around bugs in toolkits where the proper
2067 * events are not raised / to aid in testing for such bugs.
2070 atspi_accessible_set_cache_mask (AtspiAccessible *accessible, AtspiCache mask)
2072 g_return_if_fail (accessible != NULL);
2073 g_return_if_fail (accessible->parent.app != NULL);
2074 g_return_if_fail (accessible == accessible->parent.app->root);
2075 accessible->parent.app->cache = mask;
2076 enable_caching = TRUE;
2080 * atspi_accessible_clear_cache:
2081 * @accessible: The #AtspiAccessible whose cache to clear.
2083 * Clears the cached information for the given accessible and all of its
2087 atspi_accessible_clear_cache (AtspiAccessible *accessible)
2093 accessible->cached_properties = ATSPI_CACHE_NONE;
2094 for (l = accessible->children; l; l = l->next)
2095 atspi_accessible_clear_cache (l->data);
2100 * atspi_accessible_get_process_id:
2101 * @accessible: The #AtspiAccessible to query.
2102 * @error: a pointer to a %NULL #GError pointer
2104 * Returns the process id associated with the given accessible. Mainly
2105 * added for debugging; it is a shortcut to explicitly querying the
2106 * accessible's app->bus_name and then calling GetConnectionUnixProcessID.
2108 * Returns: The process ID or undetermined value if @error is set.
2111 atspi_accessible_get_process_id (AtspiAccessible *accessible, GError **error)
2113 DBusMessage *message, *reply;
2114 DBusConnection *bus = _atspi_bus ();
2115 dbus_uint32_t pid = -1;
2118 if (!accessible->parent.app || !accessible->parent.app->bus_name)
2120 g_set_error_literal(error, ATSPI_ERROR, ATSPI_ERROR_IPC, "Process is defunct");
2124 message = dbus_message_new_method_call ("org.freedesktop.DBus",
2125 "/org/freedesktop/DBus",
2126 "org.freedesktop.DBus",
2127 "GetConnectionUnixProcessID");
2128 dbus_message_append_args (message, DBUS_TYPE_STRING,
2129 &accessible->parent.app->bus_name,
2131 dbus_error_init (&d_error);
2132 reply = dbus_connection_send_with_reply_and_block (bus, message, -1, &d_error);
2133 dbus_message_unref (message);
2136 if (!strcmp (dbus_message_get_signature (reply), "u"))
2137 dbus_message_get_args (reply, NULL, DBUS_TYPE_UINT32, &pid, DBUS_TYPE_INVALID);
2138 dbus_message_unref (reply);
2140 if (dbus_error_is_set (&d_error))
2142 g_set_error_literal(error, ATSPI_ERROR, ATSPI_ERROR_IPC, "Process is defunct");
2143 dbus_error_free (&d_error);
2149 _atspi_accessible_get_cache_mask (AtspiAccessible *accessible)
2153 if (!accessible->parent.app)
2154 return ATSPI_CACHE_NONE;
2156 mask = accessible->parent.app->cache;
2157 if (mask == ATSPI_CACHE_UNDEFINED &&
2158 accessible->parent.app->root &&
2159 accessible->parent.app->root->accessible_parent)
2161 AtspiAccessible *desktop = atspi_get_desktop (0);
2162 mask = desktop->parent.app->cache;
2163 g_object_unref (desktop);
2166 if (mask == ATSPI_CACHE_UNDEFINED)
2167 mask = ATSPI_CACHE_DEFAULT;
2173 _atspi_accessible_test_cache (AtspiAccessible *accessible, AtspiCache flag)
2175 AtspiCache mask = _atspi_accessible_get_cache_mask (accessible);
2176 AtspiCache result = accessible->cached_properties & mask & flag;
2177 if (accessible->states && atspi_state_set_contains (accessible->states, ATSPI_STATE_TRANSIENT))
2179 return (result != 0 && (atspi_main_loop || enable_caching ||
2180 flag == ATSPI_CACHE_INTERFACES) &&
2185 _atspi_accessible_add_cache (AtspiAccessible *accessible, AtspiCache flag)
2187 AtspiCache mask = _atspi_accessible_get_cache_mask (accessible);
2189 accessible->cached_properties |= flag & mask;
2193 * atspi_accessible_get_locale:
2194 * @accessible: an #AtspiAccessible
2196 * Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale
2201 * Returns: a UTF-8 string indicating the POSIX-style LC_MESSAGES
2202 * locale of @accessible.
2205 atspi_accessible_get_object_locale (AtspiAccessible *accessible, GError **error)
2209 g_return_val_if_fail (accessible != NULL, NULL);
2211 locale = g_object_get_qdata (G_OBJECT (accessible), quark_locale);
2214 if (!_atspi_dbus_get_property (accessible, atspi_interface_accessible,
2215 "Locale", error, "s", &locale))
2218 g_object_set_qdata_full (G_OBJECT (accessible), quark_locale, locale,
2225 free_value (gpointer data)
2227 GValue *value = data;
2229 g_value_unset (value);
2234 _atspi_accessible_ref_cache (AtspiAccessible *accessible)
2236 AtspiAccessiblePrivate *priv = accessible->priv;
2238 priv->cache_ref_count++;
2240 return g_hash_table_ref (priv->cache);
2241 priv->cache = g_hash_table_new_full (g_str_hash, g_str_equal, g_free,
2247 _atspi_accessible_unref_cache (AtspiAccessible *accessible)
2249 AtspiAccessiblePrivate *priv = accessible->priv;
2253 g_hash_table_unref (priv->cache);
2254 if (--priv->cache_ref_count == 0)