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"
29 atspi_action_interface_init (AtspiAction *action)
34 atspi_collection_interface_init (AtspiCollection *component)
39 atspi_component_interface_init (AtspiComponent *component)
44 atspi_document_interface_init (AtspiDocument *document)
49 atspi_editable_text_interface_init (AtspiEditableText *editable_text)
54 atspi_hypertext_interface_init (AtspiHypertext *hypertext)
59 atspi_image_interface_init (AtspiImage *image)
64 atspi_selection_interface_init (AtspiSelection *selection)
69 atspi_table_interface_init (AtspiTable *table)
74 atspi_text_interface_init (AtspiText *text)
79 atspi_value_interface_init (AtspiValue *value)
83 G_DEFINE_TYPE_WITH_CODE (AtspiAccessible, atspi_accessible, ATSPI_TYPE_OBJECT,
84 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_ACTION, atspi_action_interface_init)
85 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_COLLECTION, atspi_collection_interface_init)
86 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_COMPONENT, atspi_component_interface_init)
87 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_DOCUMENT, atspi_document_interface_init)
88 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_EDITABLE_TEXT, atspi_editable_text_interface_init)
89 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_HYPERTEXT, atspi_hypertext_interface_init)
90 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_IMAGE, atspi_image_interface_init)
91 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_SELECTION, atspi_selection_interface_init)
92 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_TABLE, atspi_table_interface_init)
93 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_TEXT, atspi_text_interface_init)
94 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_VALUE, atspi_value_interface_init))
96 #ifdef DEBUG_REF_COUNTS
97 static gint accessible_count = 0;
101 atspi_accessible_init (AtspiAccessible *accessible)
103 #ifdef DEBUG_REF_COUNTS
105 printf("at-spi: init: %d objects\n", accessible_count);
110 atspi_accessible_dispose (GObject *object)
112 AtspiAccessible *accessible = ATSPI_ACCESSIBLE (object);
114 AtspiAccessible *parent;
116 /* TODO: Only fire if object not already marked defunct */
117 memset (&e, 0, sizeof (e));
118 e.type = "object:state-change:defunct";
119 e.source = accessible;
122 _atspi_send_event (&e);
124 if (accessible->states)
126 g_object_unref (accessible->states);
127 accessible->states = NULL;
130 parent = accessible->accessible_parent;
131 if (parent && parent->children)
133 GList*ls = g_list_find (parent->children, accessible);
136 gboolean replace = (ls == parent->children);
137 ls = g_list_remove (ls, accessible);
139 parent->children = ls;
140 g_object_unref (object);
146 g_object_unref (parent);
147 accessible->accessible_parent = NULL;
150 G_OBJECT_CLASS (atspi_accessible_parent_class) ->dispose (object);
154 atspi_accessible_finalize (GObject *object)
156 AtspiAccessible *accessible = ATSPI_ACCESSIBLE (object);
158 g_free (accessible->description);
159 g_free (accessible->name);
160 if (accessible->attributes)
161 g_hash_table_unref (accessible->attributes);
163 #ifdef DEBUG_REF_COUNTS
165 g_print ("at-spi: finalize: %d objects\n", accessible_count);
168 G_OBJECT_CLASS (atspi_accessible_parent_class)
173 atspi_accessible_class_init (AtspiAccessibleClass *klass)
175 GObjectClass *object_class = G_OBJECT_CLASS (klass);
177 object_class->dispose = atspi_accessible_dispose;
178 object_class->finalize = atspi_accessible_finalize;
181 /* TODO: Generate following from spec? */
182 static const char *role_names [] =
241 "table column header",
243 "tear off menu item",
262 "embedded component",
273 "input method window",
276 "document spreadsheet",
277 "document presentation",
289 #define MAX_ROLES (sizeof (role_names) / sizeof (char *))
292 * atspi_role_get_name:
293 * @role: an #AtspiRole object to query.
295 * Gets a localizable string that indicates the name of an #AtspiRole.
296 * <em>DEPRECATED.</em>
298 * Returns: a localizable string name for an #AtspiRole enumerated type.
301 atspi_role_get_name (AtspiRole role)
303 if (role < MAX_ROLES && role_names [(int) role])
305 return g_strdup (role_names [(int) role]);
309 return g_strdup ("");
314 * atspi_accessible_get_name:
315 * @obj: a pointer to the #AtspiAccessible object on which to operate.
317 * Gets the name of an #AtspiAccessible object.
319 * Returns: a UTF-8 string indicating the name of the #AtspiAccessible object
320 * or NULL on exception.
323 atspi_accessible_get_name (AtspiAccessible *obj, GError **error)
325 g_return_val_if_fail (obj != NULL, g_strdup (""));
326 if (!_atspi_accessible_test_cache (obj, ATSPI_CACHE_NAME))
328 if (!_atspi_dbus_get_property (obj, atspi_interface_accessible, "Name", error,
330 return g_strdup ("");
331 _atspi_accessible_add_cache (obj, ATSPI_CACHE_NAME);
333 return g_strdup (obj->name);
337 * atspi_accessible_get_description:
338 * @obj: a pointer to the #AtspiAccessible object on which to operate.
340 * Gets the description of an #AtspiAccessible object.
342 * Returns: a UTF-8 string describing the #AtspiAccessible object
343 * or NULL on exception.
346 atspi_accessible_get_description (AtspiAccessible *obj, GError **error)
348 g_return_val_if_fail (obj != NULL, g_strdup (""));
350 if (!_atspi_accessible_test_cache (obj, ATSPI_CACHE_DESCRIPTION))
352 if (!_atspi_dbus_get_property (obj, atspi_interface_accessible,
353 "Description", error, "s",
355 return g_strdup ("");
356 _atspi_accessible_add_cache (obj, ATSPI_CACHE_DESCRIPTION);
358 return g_strdup (obj->description);
361 const char *str_parent = "Parent";
364 * atspi_accessible_get_parent:
365 * @obj: a pointer to the #AtspiAccessible object to query.
367 * Gets an #AtspiAccessible object's parent container.
369 * Returns: (transfer full): a pointer to the #AtspiAccessible object which
370 * contains the given #AtspiAccessible instance, or NULL if the @obj
371 * has no parent container.
375 atspi_accessible_get_parent (AtspiAccessible *obj, GError **error)
377 g_return_val_if_fail (obj != NULL, NULL);
379 if (obj->parent.app &&
380 !_atspi_accessible_test_cache (obj, ATSPI_CACHE_PARENT))
382 DBusMessage *message, *reply;
383 DBusMessageIter iter, iter_variant;
384 message = dbus_message_new_method_call (obj->parent.app->bus_name,
386 DBUS_INTERFACE_PROPERTIES, "Get");
389 dbus_message_append_args (message, DBUS_TYPE_STRING, &atspi_interface_accessible,
390 DBUS_TYPE_STRING, &str_parent,
392 reply = _atspi_dbus_send_with_reply_and_block (message, error);
395 if (strcmp (dbus_message_get_signature (reply), "v") != 0)
397 dbus_message_unref (reply);
400 dbus_message_iter_init (reply, &iter);
401 dbus_message_iter_recurse (&iter, &iter_variant);
402 obj->accessible_parent = _atspi_dbus_return_accessible_from_iter (&iter_variant);
403 dbus_message_unref (reply);
404 _atspi_accessible_add_cache (obj, ATSPI_CACHE_PARENT);
406 if (!obj->accessible_parent)
408 return g_object_ref (obj->accessible_parent);
412 * atspi_accessible_get_child_count:
413 * @obj: a pointer to the #AtspiAccessible object on which to operate.
415 * Gets the number of children contained by an #AtspiAccessible object.
417 * Returns: a #long indicating the number of #AtspiAccessible children
418 * contained by an #AtspiAccessible object or -1 on exception.
422 atspi_accessible_get_child_count (AtspiAccessible *obj, GError **error)
424 g_return_val_if_fail (obj != NULL, -1);
426 if (!_atspi_accessible_test_cache (obj, ATSPI_CACHE_CHILDREN))
429 if (!_atspi_dbus_get_property (obj, atspi_interface_accessible,
430 "ChildCount", error, "i", &ret))
435 return g_list_length (obj->children);
439 * atspi_accessible_get_child_at_index:
440 * @obj: a pointer to the #AtspiAccessible object on which to operate.
441 * @child_index: a #long indicating which child is specified.
443 * Gets the #AtspiAccessible child of an #AtspiAccessible object at a given index.
445 * Returns: (transfer full): a pointer to the #AtspiAccessible child object at
446 * index @child_index or NULL on exception.
449 atspi_accessible_get_child_at_index (AtspiAccessible *obj,
453 AtspiAccessible *child;
455 g_return_val_if_fail (obj != NULL, NULL);
457 if (!_atspi_accessible_test_cache (obj, ATSPI_CACHE_CHILDREN))
460 reply = _atspi_dbus_call_partial (obj, atspi_interface_accessible,
461 "GetChildAtIndex", error, "i",
463 return _atspi_dbus_return_accessible_from_message (reply);
466 child = g_list_nth_data (obj->children, child_index);
469 return g_object_ref (child);
473 * atspi_accessible_get_index_in_parent:
474 * @obj: a pointer to the #AtspiAccessible object on which to operate.
476 * Gets the index of an #AtspiAccessible object within its parent's
477 * #AtspiAccessible children list.
479 * Returns: a #glong indicating the index of the #AtspiAccessible object
481 * or -1 if @obj has no containing parent or on exception.
484 atspi_accessible_get_index_in_parent (AtspiAccessible *obj, GError **error)
489 g_return_val_if_fail (obj != NULL, -1);
490 if (!obj->accessible_parent) return -1;
491 if (!_atspi_accessible_test_cache (obj->accessible_parent,
492 ATSPI_CACHE_CHILDREN))
494 dbus_int32_t ret = -1;
495 _atspi_dbus_call (obj, atspi_interface_accessible,
496 "GetIndexInParent", NULL, "=>i", &ret);
500 l = obj->accessible_parent->children;
503 if (l->data == obj) return i;
514 } Accessibility_Relation;
517 * atspi_accessible_get_relation_set:
518 * @obj: a pointer to the #AtspiAccessible object on which to operate.
520 * Gets the set of #AtspiRelation objects which describes this #AtspiAccessible object's
521 * relationships with other #AtspiAccessible objects.
523 * Returns: (element-type AtspiAccessible*) (transfer full): a #GArray of
524 * #AtspiRelation pointers or NULL on exception.
527 atspi_accessible_get_relation_set (AtspiAccessible *obj, GError **error)
530 DBusMessageIter iter, iter_array;
533 g_return_val_if_fail (obj != NULL, NULL);
535 reply = _atspi_dbus_call_partial (obj, atspi_interface_accessible, "GetRelationSet", error, "");
538 _ATSPI_DBUS_CHECK_SIG (reply, "a(ua(so))", error, NULL);
540 ret = g_array_new (TRUE, TRUE, sizeof (AtspiRelation *));
541 dbus_message_iter_init (reply, &iter);
542 dbus_message_iter_recurse (&iter, &iter_array);
543 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
545 AtspiRelation *relation;
546 relation = _atspi_relation_new_from_iter (&iter_array);
547 ret = g_array_append_val (ret, relation);
548 dbus_message_iter_next (&iter_array);
550 dbus_message_unref (reply);
555 * atspi_accessible_get_role:
556 * @obj: a pointer to the #AtspiAccessible object on which to operate.
558 * Gets the UI role played by an #AtspiAccessible object.
559 * This role's name can be obtained via atspi_accessible_get_role_name ().
561 * Returns: the #AtspiRole of an #AtspiAccessible object.
565 atspi_accessible_get_role (AtspiAccessible *obj, GError **error)
567 g_return_val_if_fail (obj != NULL, ATSPI_ROLE_INVALID);
569 if (!_atspi_accessible_test_cache (obj, ATSPI_CACHE_ROLE))
572 /* TODO: Make this a property */
573 if (_atspi_dbus_call (obj, atspi_interface_accessible, "GetRole", error, "=>u", &role))
576 _atspi_accessible_add_cache (obj, ATSPI_CACHE_ROLE);
583 * atspi_accessible_get_role_name:
584 * @obj: a pointer to the #AtspiAccessible object on which to operate.
586 * Gets a UTF-8 string corresponding to the name of the role played by an object.
587 * This method will return useful values for roles that fall outside the
588 * enumeration used in atspi_accessible_get_role ().
590 * Returns: a UTF-8 string specifying the type of UI role played by an
591 * #AtspiAccessible object.
595 atspi_accessible_get_role_name (AtspiAccessible *obj, GError **error)
600 g_return_val_if_fail (obj != NULL, NULL);
602 role = atspi_accessible_get_role (obj, error);
603 if (role >= 0 && role < MAX_ROLES && role != ATSPI_ROLE_EXTENDED)
604 return g_strdup (role_names [role]);
606 _atspi_dbus_call (obj, atspi_interface_accessible, "GetRoleName", error, "=>s", &retval);
609 retval = g_strdup ("");
615 * atspi_accessible_get_localized_role_name:
616 * @obj: a pointer to the #AtspiAccessible object on which to operate.
618 * Gets a UTF-8 string corresponding to the name of the role played by an
619 * object, translated to the current locale.
620 * This method will return useful values for roles that fall outside the
621 * enumeration used in atspi_accessible_getRole ().
623 * Returns: a localized, UTF-8 string specifying the type of UI role played
624 * by an #AtspiAccessible object.
628 atspi_accessible_get_localized_role_name (AtspiAccessible *obj, GError **error)
632 g_return_val_if_fail (obj != NULL, NULL);
634 _atspi_dbus_call (obj, atspi_interface_accessible, "GetLocalizedRoleName", error, "=>s", &retval);
637 return g_strdup ("");
642 static AtspiStateSet *
645 AtspiStateSet *set = atspi_state_set_new (NULL);
646 atspi_state_set_add (set, ATSPI_STATE_DEFUNCT);
651 * atspi_accessible_get_state_set:
652 * @obj: a pointer to the #AtspiAccessible object on which to operate.
654 * Gets the states currently held by an object.
656 * Returns: (transfer full): a pointer to an #AtspiStateSet representing an
657 * object's current state set.
660 atspi_accessible_get_state_set (AtspiAccessible *obj)
662 if (!obj->parent.app || !obj->parent.app->bus)
663 return defunct_set ();
666 if (!_atspi_accessible_test_cache (obj, ATSPI_CACHE_STATES))
669 DBusMessageIter iter;
670 reply = _atspi_dbus_call_partial (obj, atspi_interface_accessible,
671 "GetState", NULL, "");
672 _ATSPI_DBUS_CHECK_SIG (reply, "au", NULL, defunct_set ());
673 dbus_message_iter_init (reply, &iter);
674 _atspi_dbus_set_state (obj, &iter);
675 dbus_message_unref (reply);
676 _atspi_accessible_add_cache (obj, ATSPI_CACHE_STATES);
679 return g_object_ref (obj->states);
683 * atspi_accessible_get_attributes:
684 * @obj: The #AtspiAccessible being queried.
686 * Gets the #AttributeSet representing any assigned
687 * name-value pair attributes or annotations for this object.
688 * For typographic, textual, or textually-semantic attributes, see
689 * atspi_text_get_attributes instead.
691 * Returns: (element-type gchar* gchar*) (transfer full): The name-value-pair
692 * attributes assigned to this object.
695 atspi_accessible_get_attributes (AtspiAccessible *obj, GError **error)
697 DBusMessage *message;
699 g_return_val_if_fail (obj != NULL, NULL);
701 if (!_atspi_accessible_test_cache (obj, ATSPI_CACHE_ATTRIBUTES))
703 message = _atspi_dbus_call_partial (obj, atspi_interface_accessible,
704 "GetAttributes", error, "");
705 obj->attributes = _atspi_dbus_return_hash_from_message (message);
706 _atspi_accessible_add_cache (obj, ATSPI_CACHE_ATTRIBUTES);
709 if (!obj->attributes)
711 return g_hash_table_ref (obj->attributes);
715 add_to_attribute_array (gpointer key, gpointer value, gpointer data)
717 GArray **array = (GArray **)data;
718 gchar *str = g_strconcat (key, ":", value, NULL);
719 *array = g_array_append_val (*array, str);
723 * atspi_accessible_get_attributes_as_array:
724 * @obj: The #AtspiAccessible being queried.
726 * Gets a #GArray representing any assigned
727 * name-value pair attributes or annotations for this object.
728 * For typographic, textual, or textually-semantic attributes, see
729 * atspi_text_get_attributes_as_array instead.
731 * Returns: (element-type gchar*) (transfer full): The name-value-pair
732 * attributes assigned to this object.
735 atspi_accessible_get_attributes_as_array (AtspiAccessible *obj, GError **error)
737 DBusMessage *message;
739 g_return_val_if_fail (obj != NULL, NULL);
741 if (_atspi_accessible_get_cache_mask (obj) & ATSPI_CACHE_ATTRIBUTES)
743 GArray *array = g_array_new (TRUE, TRUE, sizeof (gchar *));
744 GHashTable *attributes = atspi_accessible_get_attributes (obj, error);
747 g_hash_table_foreach (attributes, add_to_attribute_array, &array);
748 g_hash_table_unref (attributes);
752 message = _atspi_dbus_call_partial (obj, atspi_interface_accessible, "GetAttributes", error, "");
753 return _atspi_dbus_return_attribute_array_from_message (message);
757 * atspi_accessible_get_application:
758 * @obj: The #AtspiAccessible being queried.
760 * Gets the containing #AtspiApplication for an object.
762 * Returns: (transfer full): the containing #AtspiApplication instance for
766 atspi_accessible_get_application (AtspiAccessible *obj, GError **error)
768 AtspiAccessible *parent;
773 parent = atspi_accessible_get_parent (obj, NULL);
774 if (!parent && obj->parent.app &&
775 atspi_accessible_get_role (obj, NULL) != ATSPI_ROLE_APPLICATION)
777 AtspiAccessible *root = g_object_ref (obj->parent.app->root);
780 g_object_unref (obj);
781 if (atspi_accessible_get_role (root, NULL) == ATSPI_ROLE_DESKTOP_FRAME)
783 g_object_unref (root);
789 if (!parent || parent == obj ||
790 atspi_accessible_get_role (parent, NULL) == ATSPI_ROLE_DESKTOP_FRAME)
792 g_object_unref (obj);
797 /* Application-specific methods */
800 * atspi_accessible_get_toolkit_name:
801 * @obj: a pointer to the #AtspiAccessible object on which to operate.
803 * Gets the toolkit name for an #AtspiAccessible object.
804 * Only works on application root objects.
806 * Returns: a UTF-8 string indicating the toolkit name for the #AtspiAccessible object or NULL on exception.
809 atspi_accessible_get_toolkit_name (AtspiAccessible *obj, GError **error)
811 g_return_val_if_fail (obj != NULL, NULL);
813 if (!obj->parent.app)
816 if (!obj->parent.app->toolkit_name)
817 _atspi_dbus_get_property (obj, atspi_interface_application, "ToolkitName",
818 error, "s", &obj->parent.app->toolkit_name);
820 return g_strdup (obj->parent.app->toolkit_name);
824 * atspi_accessible_get_toolkit_version:
825 * @obj: a pointer to the #AtspiAccessible object on which to operate.
827 * Gets the toolkit version for an #AtspiAccessible object.
828 * Only works on application root objects.
830 * Returns: a UTF-8 string indicating the toolkit version for the #AtspiAccessible object or NULL on exception.
833 atspi_accessible_get_toolkit_version (AtspiAccessible *obj, GError **error)
835 g_return_val_if_fail (obj != NULL, NULL);
837 if (!obj->parent.app)
840 if (!obj->parent.app->toolkit_version)
841 _atspi_dbus_get_property (obj, atspi_interface_application, "Version",
842 error, "s", &obj->parent.app->toolkit_version);
844 return g_strdup (obj->parent.app->toolkit_version);
848 * atspi_accessible_get_atspi_version:
849 * @obj: a pointer to the #AtspiAccessible object on which to operate.
851 * Gets the AT-SPI IPC specification version supported by the application
852 * pointed to by the #AtspiAccessible object.
853 * Only works on application root objects.
855 * Returns: a UTF-8 string indicating the AT-SPI version for the #AtspiAccessible object or NULL on exception.
858 atspi_accessible_get_atspi_version (AtspiAccessible *obj, GError **error)
860 g_return_val_if_fail (obj != NULL, NULL);
862 if (!obj->parent.app)
865 if (!obj->parent.app->atspi_version)
866 _atspi_dbus_get_property (obj, atspi_interface_application, "AtspiVersion",
867 error, "s", &obj->parent.app->atspi_version);
869 return g_strdup (obj->parent.app->atspi_version);
873 * atspi_accessible_get_toolkit_version:
874 * @obj: a pointer to the #AtspiAccessible object on which to operate.
876 * Gets the application id for a #AtspiAccessible object.
877 * Only works on application root objects.
879 * Returns: a positive #gint indicating the id for the #AtspiAccessible object
880 * or -1 on exception.
883 atspi_accessible_get_id (AtspiAccessible *obj, GError **error)
887 g_return_val_if_fail (obj != NULL, -1);
889 if (!_atspi_dbus_get_property (obj, atspi_interface_application, "Id", error, "i", &ret))
895 /* Interface query methods */
898 _atspi_accessible_is_a (AtspiAccessible *accessible,
899 const char *interface_name)
903 if (accessible == NULL)
908 if (!_atspi_accessible_test_cache (accessible, ATSPI_CACHE_INTERFACES))
911 DBusMessageIter iter;
912 reply = _atspi_dbus_call_partial (accessible, atspi_interface_accessible,
913 "GetInterfaces", NULL, "");
914 _ATSPI_DBUS_CHECK_SIG (reply, "as", NULL, FALSE);
915 dbus_message_iter_init (reply, &iter);
916 _atspi_dbus_set_interfaces (accessible, &iter);
917 dbus_message_unref (reply);
918 _atspi_accessible_add_cache (accessible, ATSPI_CACHE_INTERFACES);
921 n = _atspi_get_iface_num (interface_name);
922 if (n == -1) return FALSE;
923 return (gboolean) ((accessible->interfaces & (1 << n))? TRUE: FALSE);
927 * atspi_accessible_is_action:
928 * @obj: a pointer to the #AtspiAccessible instance to query.
930 * Query whether the specified #AtspiAccessible implements the
931 * #AtspiAction interface.
933 * Returns: #TRUE if @obj implements the #AtspiAction interface,
937 atspi_accessible_is_action (AtspiAccessible *obj)
939 return _atspi_accessible_is_a (obj,
940 atspi_interface_action);
944 * atspi_accessible_is_application:
945 * @obj: a pointer to the #AtspiAccessible instance to query.
947 * Query whether the specified #AtspiAccessible implements the
948 * #AtspiApplication interface.
950 * Returns: #TRUE if @obj implements the #AtspiApplication interface,
954 atspi_accessible_is_application (AtspiAccessible *obj)
956 return _atspi_accessible_is_a (obj,
957 atspi_interface_application);
961 * atspi_accessible_is_collection:
962 * @obj: a pointer to the #AtspiAccessible instance to query.
964 * Query whether the specified #AtspiAccessible implements the
965 * #AtspiCollection interface.
967 * Returns: #TRUE if @obj implements the #AtspiCollection interface,
971 atspi_accessible_is_collection (AtspiAccessible *obj)
973 return _atspi_accessible_is_a (obj,
974 atspi_interface_collection);
978 * atspi_accessible_is_component:
979 * @obj: a pointer to the #AtspiAccessible instance to query.
981 * Query whether the specified #AtspiAccessible implements #AtspiComponent.
983 * Returns: #TRUE if @obj implements the #AtspiComponent interface,
987 atspi_accessible_is_component (AtspiAccessible *obj)
989 return _atspi_accessible_is_a (obj,
990 atspi_interface_component);
994 * atspi_accessible_is_document:
995 * @obj: a pointer to the #AtspiAccessible instance to query.
997 * Query whether the specified #AtspiAccessible implements the
998 * #AtspiDocument interface.
1000 * Returns: #TRUE if @obj implements the #AtspiDocument interface,
1004 atspi_accessible_is_document (AtspiAccessible *obj)
1006 return _atspi_accessible_is_a (obj,
1007 atspi_interface_document);
1011 * atspi_accessible_is_editable_text:
1012 * @obj: a pointer to the #AtspiAccessible instance to query.
1014 * Query whether the specified #AtspiAccessible implements the
1015 * #AtspiEditableText interface.
1017 * Returns: #TRUE if @obj implements the #AtspiEditableText interface,
1021 atspi_accessible_is_editable_text (AtspiAccessible *obj)
1023 return _atspi_accessible_is_a (obj,
1024 atspi_interface_editable_text);
1028 * atspi_accessible_is_hypertext:
1029 * @obj: a pointer to the #AtspiAccessible instance to query.
1031 * Query whether the specified #AtspiAccessible implements the
1032 * #AtspiHypertext interface.
1034 * Returns: #TRUE if @obj implements the #AtspiHypertext interface,
1038 atspi_accessible_is_hypertext (AtspiAccessible *obj)
1040 return _atspi_accessible_is_a (obj,
1041 atspi_interface_hypertext);
1045 * atspi_accessible_is_hyperlink:
1046 * @obj: a pointer to the #AtspiAccessible instance to query.
1048 * Query whether the specified #AtspiAccessible implements the
1049 * #AtspiHyperlink interface.
1051 * Returns: #TRUE if @obj implements the #AtspiHypertext interface,
1055 atspi_accessible_is_hyperlink (AtspiAccessible *obj)
1057 return _atspi_accessible_is_a (obj,
1058 atspi_interface_hyperlink);
1062 * atspi_accessible_is_image:
1063 * @obj: a pointer to the #AtspiAccessible instance to query.
1065 * Query whether the specified #AtspiAccessible implements the
1066 * #AtspiImage interface.
1068 * Returns: #TRUE if @obj implements the #AtspiImage interface,
1072 atspi_accessible_is_image (AtspiAccessible *obj)
1074 return _atspi_accessible_is_a (obj,
1075 atspi_interface_image);
1079 * atspi_accessible_is_selection:
1080 * @obj: a pointer to the #AtspiAccessible instance to query.
1082 * Query whether the specified #AtspiAccessible implements the
1083 * #AtspiSelection interface.
1085 * Returns: #TRUE if @obj implements the #AtspiSelection interface,
1089 atspi_accessible_is_selection (AtspiAccessible *obj)
1091 return _atspi_accessible_is_a (obj,
1092 atspi_interface_selection);
1096 * atspi_accessible_is_table:
1097 * @obj: a pointer to the #AtspiAccessible instance to query.
1099 * Query whether the specified #AtspiAccessible implements the
1100 * #AtspiTable interface.
1102 * Returns: #TRUE if @obj implements the #AtspiTable interface,
1106 atspi_accessible_is_table (AtspiAccessible *obj)
1108 return _atspi_accessible_is_a (obj,
1109 atspi_interface_table);
1113 * atspi_accessible_is_streamable_content:
1114 * @obj: a pointer to the #AtspiAccessible instance to query.
1116 * Query whether the specified #AtspiAccessible implements the
1117 * #AtspiStreamableContent interface.
1119 * Returns: #TRUE if @obj implements the #AtspiStreamableContent interface,
1123 atspi_accessible_is_streamable_content (AtspiAccessible *obj)
1126 return _atspi_accessible_is_a (obj,
1127 atspi_interface_streamable_content);
1129 g_warning ("Streamable content not implemented");
1135 * atspi_accessible_is_text:
1136 * @obj: a pointer to the #AtspiAccessible instance to query.
1138 * Query whether the specified #AtspiAccessible implements the
1139 * #AtspiText interface.
1141 * Returns: #TRUE if @obj implements the #AtspiText interface,
1145 atspi_accessible_is_text (AtspiAccessible *obj)
1147 return _atspi_accessible_is_a (obj,
1148 atspi_interface_text);
1152 * atspi_accessible_is_value:
1153 * @obj: a pointer to the #AtspiAccessible instance to query.
1155 * Query whether the specified #AtspiAccessible implements the
1156 * #AtspiValue interface.
1158 * Returns: #TRUE if @obj implements the #AtspiValue interface,
1162 atspi_accessible_is_value (AtspiAccessible *obj)
1164 return _atspi_accessible_is_a (obj,
1165 atspi_interface_value);
1169 * atspi_accessible_get_action:
1170 * @obj: a pointer to the #AtspiAccessible instance to query.
1172 * Gets the #AtspiAction interface for an #AtspiAccessible.
1174 * Returns: (transfer full): a pointer to an #AtspiAction interface
1175 * instance, or NULL if @obj does not implement #AtspiAction.
1178 atspi_accessible_get_action (AtspiAccessible *accessible)
1180 return (_atspi_accessible_is_a (accessible, atspi_interface_action) ?
1181 g_object_ref (ATSPI_ACTION (accessible)) : NULL);
1185 * atspi_accessible_get_collection:
1186 * @obj: a pointer to the #AtspiAccessible instance to query.
1188 * Gets the #AtspiCollection interface for an #AtspiAccessible.
1190 * Returns: (transfer full): a pointer to an #AtspiCollection interface
1191 * instance, or NULL if @obj does not implement #AtspiCollection.
1194 atspi_accessible_get_collection (AtspiAccessible *accessible)
1196 return (_atspi_accessible_is_a (accessible, atspi_interface_collection) ?
1197 g_object_ref (ATSPI_COLLECTION (accessible)) : NULL);
1201 * atspi_accessible_get_component:
1202 * @obj: a pointer to the #AtspiAccessible instance to query.
1204 * Gets the #AtspiComponent interface for an #AtspiAccessible.
1206 * Returns: (transfer full): a pointer to an #AtspiComponent interface
1207 * instance, or NULL if @obj does not implement #AtspiComponent.
1210 atspi_accessible_get_component (AtspiAccessible *obj)
1212 return (_atspi_accessible_is_a (obj, atspi_interface_component) ?
1213 g_object_ref (ATSPI_COMPONENT (obj)) : NULL);
1217 * atspi_accessible_get_document:
1218 * @obj: a pointer to the #AtspiAccessible instance to query.
1220 * Gets the #AtspiDocument interface for an #AtspiAccessible.
1222 * Returns: (transfer full): a pointer to an #AtspiDocument interface
1223 * instance, or NULL if @obj does not implement #AtspiDocument.
1226 atspi_accessible_get_document (AtspiAccessible *accessible)
1228 return (_atspi_accessible_is_a (accessible, atspi_interface_document) ?
1229 g_object_ref (ATSPI_DOCUMENT (accessible)) : NULL);
1233 * atspi_accessible_get_editable_text:
1234 * @obj: a pointer to the #AtspiAccessible instance to query.
1236 * Gets the #AtspiEditableText interface for an #AtspiAccessible.
1238 * Returns: (transfer full): a pointer to an #AtspiEditableText interface
1239 * instance, or NULL if @obj does not implement #AtspiEditableText.
1242 atspi_accessible_get_editable_text (AtspiAccessible *accessible)
1244 return (_atspi_accessible_is_a (accessible, atspi_interface_editable_text) ?
1245 g_object_ref (ATSPI_EDITABLE_TEXT (accessible)) : NULL);
1249 * atspi_accessible_get_hyperlink:
1250 * @obj: a pointer to the #AtspiAccessible object on which to operate.
1252 * Gets the #AtspiHyperlink interface for an #AtspiAccessible.
1254 * Returns: (transfer full): the #AtspiHyperlink object associated with
1255 * the given #AtspiAccessible, or NULL if not supported.
1258 atspi_accessible_get_hyperlink (AtspiAccessible *accessible)
1260 return (_atspi_accessible_is_a (accessible, atspi_interface_hyperlink) ?
1261 _atspi_hyperlink_new (accessible->parent.app, accessible->parent.path) : NULL);
1265 * atspi_accessible_get_hypertext:
1266 * @obj: a pointer to the #AtspiAccessible instance to query.
1268 * Gets the #AtspiHypertext interface for an #AtspiAccessible.
1270 * Returns: (transfer full): a pointer to an #AtspiHypertext interface
1271 * instance, or NULL if @obj does not implement #AtspiHypertext.
1274 atspi_accessible_get_hypertext (AtspiAccessible *accessible)
1276 return (_atspi_accessible_is_a (accessible, atspi_interface_hypertext) ?
1277 g_object_ref (ATSPI_HYPERTEXT (accessible)) : NULL);
1281 * atspi_accessible_get_image:
1282 * @obj: a pointer to the #AtspiAccessible instance to query.
1284 * Gets the #AtspiImage interface for an #AtspiAccessible.
1286 * Returns: (transfer full): a pointer to an #AtspiImage interface instance, or
1287 * NULL if @obj does not implement #AtspiImage.
1290 atspi_accessible_get_image (AtspiAccessible *accessible)
1292 return (_atspi_accessible_is_a (accessible, atspi_interface_image) ?
1293 g_object_ref (ATSPI_IMAGE (accessible)) : NULL);
1297 * atspi_accessible_get_selection:
1298 * @obj: a pointer to the #AtspiAccessible instance to query.
1300 * Gets the #AtspiSelection interface for an #AtspiAccessible.
1302 * Returns: (transfer full): a pointer to an #AtspiSelection interface
1303 * instance, or NULL if @obj does not implement #AtspiSelection.
1306 atspi_accessible_get_selection (AtspiAccessible *accessible)
1308 return (_atspi_accessible_is_a (accessible, atspi_interface_selection) ?
1309 g_object_ref (ATSPI_SELECTION (accessible)) : NULL);
1314 * atspi_accessible_get_streamable_content:
1315 * @obj: a pointer to the #AtspiAccessible instance to query.
1317 * Gets the #AtspiStreamableContent interface for an #AtspiAccessible.
1319 * Returns: (transfer full): a pointer to an #AtspiStreamableContent interface
1320 * instance, or NULL if @obj does not implement #AtspiStreamableContent.
1322 AtspiStreamableContent *
1323 atspi_accessible_get_streamable_content (AtspiAccessible *accessible)
1325 return (_atspi_accessible_is_a (accessible, atspi_interface_streamable_content) ?
1331 * atspi_accessible_get_table:
1332 * @obj: a pointer to the #AtspiAccessible instance to query.
1334 * Gets the #AtspiTable interface for an #AtspiAccessible.
1336 * Returns: (transfer full): a pointer to an #AtspiTable interface instance, or
1337 * NULL if @obj does not implement #AtspiTable.
1340 atspi_accessible_get_table (AtspiAccessible *obj)
1342 return (_atspi_accessible_is_a (obj, atspi_interface_table) ?
1343 g_object_ref (ATSPI_TABLE (obj)) : NULL);
1347 * atspi_accessible_get_text:
1348 * @obj: a pointer to the #AtspiAccessible instance to query.
1350 * Gets the #AtspiTable interface for an #AtspiAccessible.
1352 * Returns: (transfer full): a pointer to an #AtspiText interface instance, or
1353 * NULL if @obj does not implement #AtspiText.
1356 atspi_accessible_get_text (AtspiAccessible *obj)
1358 return (_atspi_accessible_is_a (obj, atspi_interface_text) ?
1359 g_object_ref (ATSPI_TEXT (obj)) : NULL);
1363 * atspi_accessible_get_value:
1364 * @obj: a pointer to the #AtspiAccessible instance to query.
1366 * Gets the #AtspiTable interface for an #AtspiAccessible.
1368 * Returns: (transfer full): a pointer to an #AtspiValue interface instance, or
1369 * NULL if @obj does not implement #AtspiValue.
1372 atspi_accessible_get_value (AtspiAccessible *accessible)
1374 return (_atspi_accessible_is_a (accessible, atspi_interface_value) ?
1375 g_object_ref (ATSPI_VALUE (accessible)) : NULL);
1379 append_const_val (GArray *array, const gchar *val)
1381 gchar *dup = g_strdup (val);
1384 g_array_append_val (array, dup);
1388 * atspi_accessible_get_interfaces:
1389 * @obj: The #AtspiAccessible to query.
1391 * A set of pointers to all interfaces supported by an #AtspiAccessible.
1393 * Returns: (element-type gchar*) (transfer full): A #GArray of strings
1394 * describing the interfaces supported by the object. Interfaces are
1395 * denoted in short-hand (i.e. "Component", "Text" etc.).
1398 atspi_accessible_get_interfaces (AtspiAccessible *obj)
1400 GArray *ret = g_array_new (TRUE, TRUE, sizeof (gchar *));
1402 g_return_val_if_fail (obj != NULL, NULL);
1404 append_const_val (ret, "Accessible");
1405 if (atspi_accessible_is_action (obj))
1406 append_const_val (ret, "Action");
1407 if (atspi_accessible_is_collection (obj))
1408 append_const_val (ret, "Collection");
1409 if (atspi_accessible_is_component (obj))
1410 append_const_val (ret, "Component");
1411 if (atspi_accessible_is_document (obj))
1412 append_const_val (ret, "Document");
1413 if (atspi_accessible_is_editable_text (obj))
1414 append_const_val (ret, "EditableText");
1415 if (atspi_accessible_is_hypertext (obj))
1416 append_const_val (ret, "Hypertext");
1417 if (atspi_accessible_is_hyperlink (obj))
1418 append_const_val (ret, "Hyperlink");
1419 if (atspi_accessible_is_image (obj))
1420 append_const_val (ret, "Image");
1421 if (atspi_accessible_is_selection (obj))
1422 append_const_val (ret, "Selection");
1423 if (atspi_accessible_is_table (obj))
1424 append_const_val (ret, "Table");
1425 if (atspi_accessible_is_text (obj))
1426 append_const_val (ret, "Text");
1427 if (atspi_accessible_is_value (obj))
1428 append_const_val (ret, "Value");
1434 _atspi_accessible_new (AtspiApplication *app, const gchar *path)
1436 AtspiAccessible *accessible;
1438 accessible = g_object_new (ATSPI_TYPE_ACCESSIBLE, NULL);
1439 g_return_val_if_fail (accessible != NULL, NULL);
1441 accessible->parent.app = g_object_ref (app);
1442 accessible->parent.path = g_strdup (path);
1448 * atspi_accessible_set_cache_mask:
1450 * @accessible: The #AtspiAccessible to operate on. Must be the desktop or
1451 * the root of an application.
1452 * @mask: (type int): An #AtspiCache specifying a bit mask of the types of data to cache.
1454 * Sets the type of data to cache for accessibles.
1455 * If this is not set for an application or is reset to ATSPI_CACHE_UNDEFINED,
1456 * then the desktop's cache flag will be used.
1457 * If the desktop's cache flag is also undefined, then all possible data will
1459 * This function is intended to work around bugs in toolkits where the proper
1460 * events are not raised / to aid in testing for such bugs.
1463 atspi_accessible_set_cache_mask (AtspiAccessible *accessible, AtspiCache mask)
1465 g_return_if_fail (accessible != NULL);
1466 g_return_if_fail (accessible->parent.app != NULL);
1467 g_return_if_fail (accessible == accessible->parent.app->root);
1468 accessible->parent.app->cache = mask;
1472 * atspi_accessible_clear_cache:
1473 * @accessible: The #AtspiAccessible whose cache to clear.
1475 * Clears the cached information for the given accessible and all of its
1479 atspi_accessible_clear_cache (AtspiAccessible *accessible)
1485 accessible->cached_properties = ATSPI_CACHE_NONE;
1486 for (l = accessible->children; l; l = l->next)
1487 atspi_accessible_clear_cache (l->data);
1492 * atspi_accessible_get_process_id:
1493 * @accessible: The #AtspiAccessible to query.
1495 * Returns the process id associated with the given accessible. Mainly
1496 * added for debugging; it is a shortcut to explicitly querying the
1497 * accessible's app->bus_name and then calling GetConnectionUnixProcessID.
1499 * Returns: The process ID, or -1 if defunct.
1502 atspi_accessible_get_process_id (AtspiAccessible *accessible, GError **error)
1504 DBusMessage *message, *reply;
1505 DBusConnection *bus = _atspi_bus ();
1506 dbus_uint32_t pid = -1;
1509 if (!accessible->parent.app || !accessible->parent.app->bus_name)
1512 message = dbus_message_new_method_call ("org.freedesktop.DBus",
1513 "/org/freedesktop/DBus",
1514 "org.freedesktop.DBus",
1515 "GetConnectionUnixProcessID");
1516 dbus_message_append_args (message, DBUS_TYPE_STRING,
1517 &accessible->parent.app->bus_name,
1519 dbus_error_init (&d_error);
1520 reply = dbus_connection_send_with_reply_and_block (bus, message, -1, &d_error);
1521 dbus_message_unref (message);
1522 dbus_message_get_args (reply, NULL, DBUS_TYPE_UINT32, &pid, DBUS_TYPE_INVALID);
1523 dbus_message_unref (reply);
1524 dbus_error_free (&d_error);
1529 _atspi_accessible_get_cache_mask (AtspiAccessible *accessible)
1533 if (!accessible->parent.app)
1534 return ATSPI_CACHE_NONE;
1536 mask = accessible->parent.app->cache;
1537 if (mask == ATSPI_CACHE_UNDEFINED &&
1538 accessible->parent.app->root &&
1539 accessible->parent.app->root->accessible_parent)
1541 AtspiAccessible *desktop = atspi_get_desktop (0);
1542 mask = desktop->parent.app->cache;
1543 g_object_unref (desktop);
1546 if (mask == ATSPI_CACHE_UNDEFINED)
1547 mask = ATSPI_CACHE_DEFAULT;
1553 _atspi_accessible_test_cache (AtspiAccessible *accessible, AtspiCache flag)
1555 AtspiCache mask = _atspi_accessible_get_cache_mask (accessible);
1556 AtspiCache result = accessible->cached_properties & mask & flag;
1557 return (result != 0 && atspi_main_loop && !atspi_no_cache);
1561 _atspi_accessible_add_cache (AtspiAccessible *accessible, AtspiCache flag)
1563 AtspiCache mask = _atspi_accessible_get_cache_mask (accessible);
1565 accessible->cached_properties |= flag & mask;