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.
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
24 #include "atspi-private.h"
28 atspi_action_interface_init (AtspiAction *action)
33 atspi_collection_interface_init (AtspiCollection *component)
38 atspi_component_interface_init (AtspiComponent *component)
43 atspi_document_interface_init (AtspiDocument *document)
48 atspi_editable_text_interface_init (AtspiEditableText *editable_text)
53 atspi_hypertext_interface_init (AtspiHypertext *hypertext)
58 atspi_image_interface_init (AtspiImage *image)
63 atspi_selection_interface_init (AtspiSelection *selection)
68 atspi_table_interface_init (AtspiTable *table)
73 atspi_text_interface_init (AtspiText *text)
78 atspi_value_interface_init (AtspiValue *value)
82 G_DEFINE_TYPE_WITH_CODE (AtspiAccessible, atspi_accessible, ATSPI_TYPE_OBJECT,
83 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_ACTION, atspi_action_interface_init)
84 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_COLLECTION, atspi_collection_interface_init)
85 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_COMPONENT, atspi_component_interface_init)
86 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_DOCUMENT, atspi_document_interface_init)
87 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_EDITABLE_TEXT, atspi_editable_text_interface_init)
88 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_HYPERTEXT, atspi_hypertext_interface_init)
89 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_IMAGE, atspi_image_interface_init)
90 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_SELECTION, atspi_selection_interface_init)
91 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_TABLE, atspi_table_interface_init)
92 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_TEXT, atspi_text_interface_init)
93 G_IMPLEMENT_INTERFACE (ATSPI_TYPE_VALUE, atspi_value_interface_init))
95 #ifdef DEBUG_REF_COUNTS
96 static gint accessible_count = 0;
100 atspi_accessible_init (AtspiAccessible *accessible)
102 #ifdef DEBUG_REF_COUNTS
104 printf("at-spi: init: %d objects\n", accessible_count);
109 atspi_accessible_dispose (GObject *object)
111 AtspiAccessible *accessible = ATSPI_ACCESSIBLE (object);
113 AtspiAccessible *parent;
115 /* TODO: Only fire if object not already marked defunct */
116 memset (&e, 0, sizeof (e));
117 e.type = "object:state-change:defunct";
118 e.source = accessible;
121 _atspi_send_event (&e);
123 if (accessible->states)
125 g_object_unref (accessible->states);
126 accessible->states = NULL;
129 parent = accessible->accessible_parent;
130 if (parent && parent->children)
132 GList*ls = g_list_find (parent->children, accessible);
135 gboolean replace = (ls == parent->children);
136 ls = g_list_remove (ls, accessible);
138 parent->children = ls;
139 g_object_unref (object);
145 g_object_unref (parent);
146 accessible->accessible_parent = NULL;
149 G_OBJECT_CLASS (atspi_accessible_parent_class) ->dispose (object);
153 atspi_accessible_finalize (GObject *object)
155 AtspiAccessible *accessible = ATSPI_ACCESSIBLE (object);
157 g_free (accessible->description);
158 g_free (accessible->name);
160 #ifdef DEBUG_REF_COUNTS
162 printf("at-spi: finalize: %d objects\n", accessible_count);
165 G_OBJECT_CLASS (atspi_accessible_parent_class)
170 atspi_accessible_class_init (AtspiAccessibleClass *klass)
172 GObjectClass *object_class = G_OBJECT_CLASS (klass);
174 object_class->dispose = atspi_accessible_dispose;
175 object_class->finalize = atspi_accessible_finalize;
178 /* TODO: Generate following from spec? */
179 static const char *role_names [] =
237 "table-column-header",
239 "tear-off-menu-item",
269 "input method window"
272 #define MAX_ROLES (sizeof (role_names) / sizeof (char *))
275 * atspi_role_get_name
276 * @role: an #AtspiAccessibleRole object to query.
278 * Get a localizeable string that indicates the name of an #AtspiAccessibleRole.
279 * <em>DEPRECATED.</em>
281 * Returns: a localizable string name for an #AtspiAccessibleRole enumerated type.
284 atspi_role_get_name (AtspiRole role)
286 if (role < MAX_ROLES && role_names [(int) role])
288 return g_strdup (role_names [(int) role]);
292 return g_strdup ("");
297 * atspi_accessible_get_name:
298 * @obj: a pointer to the #AtspiAccessible object on which to operate.
300 * Get the name of an #AtspiAccessible object.
302 * Returns: a UTF-8 string indicating the name of the #AtspiAccessible object.
303 * or NULL on exception
306 atspi_accessible_get_name (AtspiAccessible *obj, GError **error)
308 g_return_val_if_fail (obj != NULL, g_strdup (""));
309 if (!(obj->cached_properties & ATSPI_CACHE_NAME))
311 if (!_atspi_dbus_get_property (obj, atspi_interface_accessible, "Name", error,
313 return g_strdup ("");
314 _atspi_accessible_add_cache (obj, ATSPI_CACHE_NAME);
316 return g_strdup (obj->name);
320 * atspi_accessible_get_description:
321 * @obj: a pointer to the #AtspiAccessible object on which to operate.
323 * Get the description of an #AtspiAccessible object.
325 * Returns: a UTF-8 string describing the #AtspiAccessible object.
326 * or NULL on exception
329 atspi_accessible_get_description (AtspiAccessible *obj, GError **error)
331 g_return_val_if_fail (obj != NULL, g_strdup (""));
333 if (!(obj->cached_properties & ATSPI_CACHE_DESCRIPTION))
335 if (!_atspi_dbus_get_property (obj, atspi_interface_accessible,
336 "Description", error, "s",
338 return g_strdup ("");
339 _atspi_accessible_add_cache (obj, ATSPI_CACHE_DESCRIPTION);
341 return g_strdup (obj->description);
344 const char *str_parent = "Parent";
347 * atspi_accessible_get_parent:
348 * @obj: a pointer to the #AtspiAccessible object to query.
350 * Get an #AtspiAccessible object's parent container.
352 * Returns: (transfer full): a pointer to the #AtspiAccessible object which
353 * contains the given #AtspiAccessible instance, or NULL if the @obj
354 * has no parent container.
358 atspi_accessible_get_parent (AtspiAccessible *obj, GError **error)
360 g_return_val_if_fail (obj != NULL, NULL);
362 if (obj->parent.app && !(obj->cached_properties & ATSPI_CACHE_PARENT))
364 DBusMessage *message, *reply;
365 DBusMessageIter iter, iter_variant;
366 message = dbus_message_new_method_call (obj->parent.app->bus_name,
368 DBUS_INTERFACE_PROPERTIES, "Get");
371 dbus_message_append_args (message, DBUS_TYPE_STRING, &atspi_interface_accessible,
372 DBUS_TYPE_STRING, &str_parent,
374 reply = _atspi_dbus_send_with_reply_and_block (message, error);
377 if (strcmp (dbus_message_get_signature (reply), "v") != 0)
379 dbus_message_unref (reply);
382 dbus_message_iter_init (reply, &iter);
383 dbus_message_iter_recurse (&iter, &iter_variant);
384 obj->accessible_parent = _atspi_dbus_return_accessible_from_iter (&iter_variant);
385 dbus_message_unref (reply);
386 _atspi_accessible_add_cache (obj, ATSPI_CACHE_PARENT);
388 if (!obj->accessible_parent)
390 return g_object_ref (obj->accessible_parent);
394 * atspi_accessible_get_child_count:
395 * @obj: a pointer to the #AtspiAccessible object on which to operate.
397 * Get the number of children contained by an #AtspiAccessible object.
399 * Returns: a #long indicating the number of #AtspiAccessible children
400 * contained by an #AtspiAccessible object. or -1 on exception
404 atspi_accessible_get_child_count (AtspiAccessible *obj, GError **error)
406 g_return_val_if_fail (obj != NULL, -1);
408 if (!(obj->cached_properties & ATSPI_CACHE_CHILDREN))
411 if (!_atspi_dbus_get_property (obj, atspi_interface_accessible,
412 "ChildCount", error, "i", &ret))
417 return g_list_length (obj->children);
421 * atspi_accessible_get_child_at_index:
422 * @obj: a pointer to the #AtspiAccessible object on which to operate.
423 * @child_index: a #long indicating which child is specified.
425 * Get the #AtspiAccessible child of an #AtspiAccessible object at a given index.
427 * Returns: (transfer full): a pointer to the #AtspiAccessible child object at
428 * index @child_index. or NULL on exception
431 atspi_accessible_get_child_at_index (AtspiAccessible *obj,
435 AtspiAccessible *child;
437 g_return_val_if_fail (obj != NULL, NULL);
439 if (!(obj->cached_properties & ATSPI_CACHE_CHILDREN))
442 reply = _atspi_dbus_call_partial (obj, atspi_interface_accessible,
443 "GetChildAtIndex", error, "i",
445 return _atspi_dbus_return_accessible_from_message (reply);
448 child = g_list_nth_data (obj->children, child_index);
451 return g_object_ref (child);
455 * atspi_accessible_get_index_in_parent
456 * @obj: a pointer to the #AtspiAccessible object on which to operate.
458 * Get the index of an #AtspiAccessible object in its containing #AtspiAccessible.
460 * Returns: a #glong indicating the index of the #AtspiAccessible object
461 * in its parent (i.e. containing) #AtspiAccessible instance,
462 * or -1 if @obj has no containing parent or on exception.
465 atspi_accessible_get_index_in_parent (AtspiAccessible *obj, GError **error)
470 g_return_val_if_fail (obj != NULL, -1);
471 if (!obj->accessible_parent) return -1;
472 if (!(obj->accessible_parent->cached_properties & ATSPI_CACHE_CHILDREN))
474 dbus_uint32_t ret = -1;
475 _atspi_dbus_call (obj, atspi_interface_accessible,
476 "GetIndexInParent", NULL, "=>u", &ret);
480 l = obj->accessible_parent->children;
483 if (l->data == obj) return i;
494 } Accessibility_Relation;
497 * atspi_accessible_get_relation_set:
498 * @obj: a pointer to the #AtspiAccessible object on which to operate.
500 * Get the set of #AtspiRelation objects which describe this #AtspiAccessible object's
501 * relationships with other #AtspiAccessible objects.
503 * Returns: (element-type AtspiAccessible*) (transfer full): an array of
504 * #AtspiAccessibleRelation pointers. or NULL on exception
507 atspi_accessible_get_relation_set (AtspiAccessible *obj, GError **error)
510 DBusMessageIter iter, iter_array;
513 g_return_val_if_fail (obj != NULL, NULL);
515 reply = _atspi_dbus_call_partial (obj, atspi_interface_accessible, "GetRelationSet", error, "");
518 _ATSPI_DBUS_CHECK_SIG (reply, "a(ua(so))", error, NULL);
520 ret = g_array_new (TRUE, TRUE, sizeof (AtspiRelation *));
521 dbus_message_iter_init (reply, &iter);
522 dbus_message_iter_recurse (&iter, &iter_array);
523 while (dbus_message_iter_get_arg_type (&iter_array) != DBUS_TYPE_INVALID)
526 AtspiRelation *relation;
527 relation = _atspi_relation_new_from_iter (&iter_array);
528 new_array = g_array_append_val (ret, relation);
531 dbus_message_iter_next (&iter_array);
533 dbus_message_unref (reply);
538 * atspi_accessible_get_role:
539 * @obj: a pointer to the #AtspiAccessible object on which to operate.
541 * Get the UI role of an #AtspiAccessible object.
542 * A UTF-8 string describing this role can be obtained via atspi_accessible_getRoleName ().
544 * Returns: the #AtspiRole of the object.
548 atspi_accessible_get_role (AtspiAccessible *obj, GError **error)
550 g_return_val_if_fail (obj != NULL, ATSPI_ROLE_INVALID);
552 if (!(obj->cached_properties & ATSPI_CACHE_ROLE))
555 /* TODO: Make this a property */
556 if (_atspi_dbus_call (obj, atspi_interface_accessible, "GetRole", error, "=>u", &role))
559 _atspi_accessible_add_cache (obj, ATSPI_CACHE_ROLE);
566 * atspi_accessible_get_role_name:
567 * @obj: a pointer to the #AtspiAccessible object on which to operate.
569 * Get a UTF-8 string describing the role this object plays in the UI.
570 * This method will return useful values for roles that fall outside the
571 * enumeration used in atspi_accessible_getRole ().
573 * Returns: a UTF-8 string specifying the role of this #AtspiAccessible object.
577 atspi_accessible_get_role_name (AtspiAccessible *obj, GError **error)
581 g_return_val_if_fail (obj != NULL, NULL);
583 _atspi_dbus_call (obj, atspi_interface_accessible, "GetRoleName", error, "=>s", &retval);
586 retval = g_strdup ("");
592 * atspi_accessible_get_localized_role_name:
593 * @obj: a pointer to the #AtspiAccessible object on which to operate.
595 * Get a UTF-8 string describing the (localized) role this object plays in the UI.
596 * This method will return useful values for roles that fall outside the
597 * enumeration used in atspi_accessible_getRole ().
599 * Returns: a UTF-8 string specifying the role of this #AtspiAccessible object.
603 atspi_accessible_get_localized_role_name (AtspiAccessible *obj, GError **error)
607 g_return_val_if_fail (obj != NULL, NULL);
609 _atspi_dbus_call (obj, atspi_interface_accessible, "GetLocalizedRoleName", error, "=>s", &retval);
612 return g_strdup ("");
617 static AtspiStateSet *
620 AtspiStateSet *set = atspi_state_set_new (NULL);
621 atspi_state_set_add (set, ATSPI_STATE_DEFUNCT);
626 * atspi_accessible_get_state_set:
627 * @obj: a pointer to the #AtspiAccessible object on which to operate.
629 * Gets the current state of an object.
631 * Returns: (transfer full): a pointer to an #AtspiStateSet representing the
632 * object's current state.
635 atspi_accessible_get_state_set (AtspiAccessible *obj)
637 if (!obj->parent.app || !obj->parent.app->bus)
638 return defunct_set ();
641 if (!(obj->cached_properties & ATSPI_CACHE_STATES))
644 DBusMessageIter iter;
645 reply = _atspi_dbus_call_partial (obj, atspi_interface_accessible,
646 "GetState", NULL, "");
647 _ATSPI_DBUS_CHECK_SIG (reply, "au", NULL, defunct_set ());
648 dbus_message_iter_init (reply, &iter);
649 _atspi_dbus_set_state (obj, &iter);
650 dbus_message_unref (reply);
651 _atspi_accessible_add_cache (obj, ATSPI_CACHE_STATES);
654 return g_object_ref (obj->states);
658 * atspi_accessible_get_attributes:
659 * @obj: The #AtspiAccessible being queried.
661 * Get the #AttributeSet representing any assigned
662 * name-value pair attributes or annotations for this object.
663 * For typographic, textual, or textually-semantic attributes, see
664 * atspi_text_get_attributes instead.
666 * Returns: (element-type gchar* gchar*) (transfer full): The name-value-pair
667 * attributes assigned to this object.
670 atspi_accessible_get_attributes (AtspiAccessible *obj, GError **error)
672 DBusMessage *message;
674 g_return_val_if_fail (obj != NULL, NULL);
676 message = _atspi_dbus_call_partial (obj, atspi_interface_accessible, "GetAttributes", error, "");
677 return _atspi_dbus_return_hash_from_message (message);
681 * atspi_accessible_get_attributes_as_array:
682 * @obj: The #AtspiAccessible being queried.
684 * Get the #AttributeSet representing any assigned
685 * name-value pair attributes or annotations for this object.
686 * For typographic, textual, or textually-semantic attributes, see
687 * atspi_text_get_attributes_as_array instead.
689 * Returns: (element-type gchar*) (transfer full): The name-value-pair
690 * attributes assigned to this object.
693 atspi_accessible_get_attributes_as_array (AtspiAccessible *obj, GError **error)
695 DBusMessage *message;
697 g_return_val_if_fail (obj != NULL, NULL);
699 message = _atspi_dbus_call_partial (obj, atspi_interface_accessible, "GetAttributes", error, "");
700 return _atspi_dbus_return_attribute_array_from_message (message);
704 * atspi_accessible_get_application:
705 * @obj: The #AtspiAccessible being queried.
707 * Get the containing #AtspiApplication for an object.
709 * Returns: (transfer full): the containing AtspiApplication instance for
713 atspi_accessible_get_application (AtspiAccessible *obj, GError **error)
715 AtspiAccessible *parent;
720 parent = atspi_accessible_get_parent (obj, NULL);
721 if (!parent || parent == obj ||
722 atspi_accessible_get_role (parent, NULL) == ATSPI_ROLE_DESKTOP_FRAME)
724 g_object_unref (obj);
729 /* Application-specific methods */
732 * atspi_accessible_get_toolkit_name:
733 * @obj: a pointer to the #AtspiAccessible object on which to operate.
735 * Get the toolkit for a #AtspiAccessible object.
736 * Only works on application root objects.
738 * Returns: a UTF-8 string indicating the toolkit name for the #AtspiAccessible object.
739 * or NULL on exception
742 atspi_accessible_get_toolkit_name (AtspiAccessible *obj, GError **error)
746 g_return_val_if_fail (obj != NULL, NULL);
748 if (!_atspi_dbus_get_property (obj, atspi_interface_application, "ToolkitName", error, "s", &ret))
750 return g_strdup (ret);
754 * atspi_accessible_get_toolkit_version:
755 * @obj: a pointer to the #AtspiAccessible object on which to operate.
757 * Get the toolkit version for a #AtspiAccessible object.
758 * Only works on application root objects.
760 * Returns: a UTF-8 string indicating the toolkit ersion for the #AtspiAccessible object.
761 * or NULL on exception
764 atspi_accessible_get_toolkit_version (AtspiAccessible *obj, GError **error)
768 g_return_val_if_fail (obj != NULL, NULL);
770 if (!_atspi_dbus_get_property (obj, atspi_interface_application, "ToolkitVersion", error, "s", &ret))
772 return g_strdup (ret);
774 /* Interface query methods */
777 _atspi_accessible_is_a (AtspiAccessible *accessible,
778 const char *interface_name)
782 if (accessible == NULL)
787 if (!(accessible->cached_properties & ATSPI_CACHE_INTERFACES))
790 DBusMessageIter iter;
791 reply = _atspi_dbus_call_partial (accessible, atspi_interface_accessible,
792 "GetInterfaces", NULL, "");
793 _ATSPI_DBUS_CHECK_SIG (reply, "as", NULL, FALSE);
794 dbus_message_iter_init (reply, &iter);
795 _atspi_dbus_set_interfaces (accessible, &iter);
796 dbus_message_unref (reply);
797 _atspi_accessible_add_cache (accessible, ATSPI_CACHE_INTERFACES);
800 n = _atspi_get_iface_num (interface_name);
801 if (n == -1) return FALSE;
802 return (gboolean) ((accessible->interfaces & (1 << n))? TRUE: FALSE);
806 * atspi_accessible_is_action:
807 * @obj: a pointer to the #AtspiAccessible instance to query.
809 * Query whether the specified #AtspiAccessible implements #AtspiAction.
811 * Returns: #TRUE if @obj implements the #AtspiAction interface,
815 atspi_accessible_is_action (AtspiAccessible *obj)
817 return _atspi_accessible_is_a (obj,
818 atspi_interface_action);
822 * atspi_accessible_is_application:
823 * @obj: a pointer to the #AtspiAccessible instance to query.
825 * Query whether the specified #AtspiAccessible implements #AtspiApplication.
827 * Returns: #TRUE if @obj implements the #AtspiApplication interface,
831 atspi_accessible_is_application (AtspiAccessible *obj)
833 return _atspi_accessible_is_a (obj,
834 atspi_interface_application);
838 * atspi_accessible_is_collection: * @obj: a pointer to the #AtspiAccessible instance to query.
840 * Query whether the specified #AtspiAccessible implements #AtspiCollection.
841 * Returns: #TRUE if @obj implements the #AtspiCollection interface,
845 atspi_accessible_is_collection (AtspiAccessible *obj)
847 return _atspi_accessible_is_a (obj,
848 atspi_interface_collection);
852 * atspi_accessible_is_component:
853 * @obj: a pointer to the #AtspiAccessible instance to query.
855 * Query whether the specified #AtspiAccessible implements #AtspiComponent.
857 * Returns: #TRUE if @obj implements the #AtspiComponent interface,
861 atspi_accessible_is_component (AtspiAccessible *obj)
863 return _atspi_accessible_is_a (obj,
864 atspi_interface_component);
868 * atspi_accessible_is_document:
869 * @obj: a pointer to the #AtspiAccessible instance to query.
871 * Query whether the specified #AtspiAccessible implements #AtspiDocument.
873 * Returns: #TRUE if @obj implements the #AtspiDocument interface,
877 atspi_accessible_is_document (AtspiAccessible *obj)
879 return _atspi_accessible_is_a (obj,
880 atspi_interface_document);
884 * atspi_accessible_is_editable_text:
885 * @obj: a pointer to the #AtspiAccessible instance to query.
887 * Query whether the specified #AtspiAccessible implements #AtspiEditableText.
889 * Returns: #TRUE if @obj implements the #AtspiEditableText interface,
893 atspi_accessible_is_editable_text (AtspiAccessible *obj)
895 return _atspi_accessible_is_a (obj,
896 atspi_interface_editable_text);
900 * atspi_accessible_is_hypertext:
901 * @obj: a pointer to the #AtspiAccessible instance to query.
903 * Query whether the specified #AtspiAccessible implements #AtspiHypertext.
905 * Returns: #TRUE if @obj implements the #AtspiHypertext interface,
909 atspi_accessible_is_hypertext (AtspiAccessible *obj)
911 return _atspi_accessible_is_a (obj,
912 atspi_interface_hypertext);
916 * atspi_accessible_is_hyperlink:
917 * @obj: a pointer to the #AtspiAccessible instance to query.
919 * Query whether the specified #AtspiAccessible implements #AtspiHyperlink.
921 * Returns: #TRUE if @obj implements the #AtspiHypertext interface,
925 atspi_accessible_is_hyperlink (AtspiAccessible *obj)
927 return _atspi_accessible_is_a (obj,
928 atspi_interface_hyperlink);
932 * atspi_accessible_is_image:
933 * @obj: a pointer to the #AtspiAccessible instance to query.
935 * Query whether the specified #AtspiAccessible implements #AtspiImage.
937 * Returns: #TRUE if @obj implements the #AtspiImage interface,
941 atspi_accessible_is_image (AtspiAccessible *obj)
943 return _atspi_accessible_is_a (obj,
944 atspi_interface_image);
948 * atspi_accessible_is_selection:
949 * @obj: a pointer to the #AtspiAccessible instance to query.
951 * Query whether the specified #AtspiAccessible implements #AtspiSelection.
953 * Returns: #TRUE if @obj implements the #AtspiSelection interface,
957 atspi_accessible_is_selection (AtspiAccessible *obj)
959 return _atspi_accessible_is_a (obj,
960 atspi_interface_selection);
964 * atspi_accessible_is_table:
965 * @obj: a pointer to the #AtspiAccessible instance to query.
967 * Query whether the specified #AtspiAccessible implements #AtspiTable.
969 * Returns: #TRUE if @obj implements the #AtspiTable interface,
973 atspi_accessible_is_table (AtspiAccessible *obj)
975 return _atspi_accessible_is_a (obj,
976 atspi_interface_table);
980 * atspi_accessible_is_streamable_content:
981 * @obj: a pointer to the #AtspiAccessible instance to query.
983 * Query whether the specified #AtspiAccessible implements
984 * #AtspiStreamableContent.
986 * Returns: #TRUE if @obj implements the #AtspiStreamableContent interface,
990 atspi_accessible_is_streamable_content (AtspiAccessible *obj)
993 return _atspi_accessible_is_a (obj,
994 atspi_interface_streamable_content);
996 g_warning (_("Streamable content not implemented"));
1002 * atspi_accessible_is_text:
1003 * @obj: a pointer to the #AtspiAccessible instance to query.
1005 * Query whether the specified #AtspiAccessible implements #AtspiText.
1007 * Returns: #TRUE if @obj implements the #AtspiText interface,
1011 atspi_accessible_is_text (AtspiAccessible *obj)
1013 return _atspi_accessible_is_a (obj,
1014 atspi_interface_text);
1018 * atspi_accessible_is_value:
1019 * @obj: a pointer to the #AtspiAccessible instance to query.
1021 * Query whether the specified #AtspiAccessible implements #AtspiValue.
1023 * Returns: #TRUE if @obj implements the #AtspiValue interface,
1027 atspi_accessible_is_value (AtspiAccessible *obj)
1029 return _atspi_accessible_is_a (obj,
1030 atspi_interface_value);
1034 * atspi_accessible_get_action:
1035 * @obj: a pointer to the #AtspiAccessible instance to query.
1037 * Get the #AtspiAction interface for an #AtspiAccessible.
1039 * Returns: (transfer full): a pointer to an #AtspiAction interface
1040 * instance, or NULL if @obj does not implement #AtspiAction.
1043 atspi_accessible_get_action (AtspiAccessible *accessible)
1045 return (_atspi_accessible_is_a (accessible, atspi_interface_action) ?
1046 g_object_ref (ATSPI_ACTION (accessible)) : NULL);
1050 * atspi_accessible_get_collection:
1051 * @obj: a pointer to the #AtspiAccessible instance to query.
1053 * Get the #AtspiCollection interface for an #AtspiAccessible.
1055 * Returns: (transfer full): a pointer to an #AtspiCollection interface
1056 * instance, or NULL if @obj does not implement #AtspiCollection.
1059 atspi_accessible_get_collection (AtspiAccessible *accessible)
1061 return (_atspi_accessible_is_a (accessible, atspi_interface_collection) ?
1062 g_object_ref (ATSPI_COLLECTION (accessible)) : NULL);
1066 * atspi_accessible_get_component:
1067 * @obj: a pointer to the #AtspiAccessible instance to query.
1069 * Get the #AtspiComponent interface for an #AtspiAccessible.
1071 * Returns: (transfer full): a pointer to an #AtspiComponent interface
1072 * instance, or NULL if @obj does not implement #AtspiComponent.
1075 atspi_accessible_get_component (AtspiAccessible *obj)
1077 return (_atspi_accessible_is_a (obj, atspi_interface_component) ?
1078 g_object_ref (ATSPI_COMPONENT (obj)) : NULL);
1082 * atspi_accessible_get_document:
1083 * @obj: a pointer to the #AtspiAccessible instance to query.
1085 * Get the #AtspiDocument interface for an #AtspiAccessible.
1087 * Returns: (transfer full): a pointer to an #AtspiDocument interface
1088 * instance, or NULL if @obj does not implement #AtspiDocument.
1091 atspi_accessible_get_document (AtspiAccessible *accessible)
1093 return (_atspi_accessible_is_a (accessible, atspi_interface_document) ?
1094 g_object_ref (ATSPI_DOCUMENT (accessible)) : NULL);
1098 * atspi_accessible_get_editable_text:
1099 * @obj: a pointer to the #AtspiAccessible instance to query.
1101 * Get the #AtspiEditableText interface for an #AtspiAccessible.
1103 * Returns: (transfer full): a pointer to an #AtspiEditableText interface
1104 * instance, or NULL if @obj does not implement #AtspiEditableText.
1107 atspi_accessible_get_editable_text (AtspiAccessible *accessible)
1109 return (_atspi_accessible_is_a (accessible, atspi_interface_editable_text) ?
1110 g_object_ref (ATSPI_EDITABLE_TEXT (accessible)) : NULL);
1114 * atspi_accessible_get_hyperlink:
1115 * @obj: a pointer to the #AtspiAccessible object on which to operate.
1117 * Get the #AtspiHyperlink associated with the given #AtspiAccessible, if
1120 * Returns: (transfer full): the #AtspiHyperlink object associated with
1121 * the given #AtspiAccessible, or NULL if not supported.
1124 atspi_accessible_get_hyperlink (AtspiAccessible *accessible)
1126 return (_atspi_accessible_is_a (accessible, atspi_interface_hyperlink) ?
1127 atspi_hyperlink_new (accessible->parent.app, accessible->parent.path) : NULL);
1131 * atspi_accessible_get_hypertext:
1132 * @obj: a pointer to the #AtspiAccessible instance to query.
1134 * Get the #AtspiHypertext interface for an #AtspiAccessible.
1136 * Returns: (transfer full): a pointer to an #AtspiHypertext interface
1137 * instance, or NULL if @obj does not implement #AtspiHypertext.
1140 atspi_accessible_get_hypertext (AtspiAccessible *accessible)
1142 return (_atspi_accessible_is_a (accessible, atspi_interface_hypertext) ?
1143 g_object_ref (ATSPI_HYPERTEXT (accessible)) : NULL);
1147 * atspi_accessible_get_image:
1148 * @obj: a pointer to the #AtspiAccessible instance to query.
1150 * Get the #AtspiImage interface for an #AtspiAccessible.
1152 * Returns: (transfer full): a pointer to an #AtspiImage interface instance, or
1153 * NULL if @obj does not implement #AtspiImage.
1156 atspi_accessible_get_image (AtspiAccessible *accessible)
1158 return (_atspi_accessible_is_a (accessible, atspi_interface_image) ?
1159 g_object_ref (ATSPI_IMAGE (accessible)) : NULL);
1163 * atspi_accessible_get_selection:
1164 * @obj: a pointer to the #AtspiAccessible instance to query.
1166 * Get the #AtspiSelection interface for an #AtspiAccessible.
1168 * Returns: (transfer full): a pointer to an #AtspiSelection interface
1169 * instance, or NULL if @obj does not implement #AtspiSelection.
1172 atspi_accessible_get_selection (AtspiAccessible *accessible)
1174 return (_atspi_accessible_is_a (accessible, atspi_interface_selection) ?
1175 g_object_ref (ATSPI_SELECTION (accessible)) : NULL);
1180 * atspi_accessible_get_streamable_content:
1181 * @obj: a pointer to the #AtspiAccessible instance to query.
1183 * Get the #AtspiStreamableContent interface for an #AtspiAccessible.
1185 * Returns: (transfer full): a pointer to an #AtspiStreamableContent interface
1186 * instance, or NULL if @obj does not implement #AtspiStreamableContent.
1188 AtspiStreamableContent *
1189 atspi_accessible_get_streamable_content (AtspiAccessible *accessible)
1191 return (_atspi_accessible_is_a (accessible, atspi_interface_streamable_content) ?
1197 * atspi_accessible_get_table:
1198 * @obj: a pointer to the #AtspiAccessible instance to query.
1200 * Get the #AtspiTable interface for an #AtspiAccessible.
1202 * Returns: (transfer full): a pointer to an #AtspiTable interface instance, or
1203 * NULL if @obj does not implement #AtspiTable.
1206 atspi_accessible_get_table (AtspiAccessible *obj)
1208 return (_atspi_accessible_is_a (obj, atspi_interface_table) ?
1209 g_object_ref (ATSPI_TABLE (obj)) : NULL);
1213 * atspi_accessible_get_text:
1214 * @obj: a pointer to the #AtspiAccessible instance to query.
1216 * Get the #AtspiTable interface for an #AtspiAccessible.
1218 * Returns: (transfer full): a pointer to an #AtspiText interface instance, or
1219 * NULL if @obj does not implement #AtspiText.
1222 atspi_accessible_get_text (AtspiAccessible *obj)
1224 return (_atspi_accessible_is_a (obj, atspi_interface_text) ?
1225 g_object_ref (ATSPI_TEXT (obj)) : NULL);
1229 * atspi_accessible_get_value:
1230 * @obj: a pointer to the #AtspiAccessible instance to query.
1232 * Get the #AtspiTable interface for an #AtspiAccessible.
1234 * Returns: (transfer full): a pointer to an #AtspiValue interface instance, or
1235 * NULL if @obj does not implement #AtspiValue.
1238 atspi_accessible_get_value (AtspiAccessible *accessible)
1240 return (_atspi_accessible_is_a (accessible, atspi_interface_value) ?
1241 g_object_ref (ATSPI_VALUE (accessible)) : NULL);
1245 append_const_val (GArray *array, const gchar *val)
1247 gchar *dup = g_strdup (val);
1250 g_array_append_val (array, dup);
1254 * atspi_accessible_get_interfaces:
1256 * #obj: The #AtspiAccessible to query.
1258 * Returns: (element-type gchar*) (transfer full): A #GArray of strings
1259 * describing the interfaces supported by the object. Interfaces are
1260 * denoted in short-hand (ie, "Component", "Text", etc.)
1263 atspi_accessible_get_interfaces (AtspiAccessible *obj)
1265 GArray *ret = g_array_new (TRUE, TRUE, sizeof (gchar *));
1270 g_return_val_if_fail (obj != NULL, NULL);
1272 if (atspi_accessible_is_action (obj))
1273 append_const_val (ret, "Action");
1274 if (atspi_accessible_is_collection (obj))
1275 append_const_val (ret, "Collection");
1276 if (atspi_accessible_is_component (obj))
1277 append_const_val (ret, "Component");
1278 if (atspi_accessible_is_document (obj))
1279 append_const_val (ret, "Document");
1280 if (atspi_accessible_is_editable_text (obj))
1281 append_const_val (ret, "EditableText");
1282 if (atspi_accessible_is_hypertext (obj))
1283 append_const_val (ret, "Hypertext");
1284 if (atspi_accessible_is_hyperlink (obj))
1285 append_const_val (ret, "Hyperlink");
1286 if (atspi_accessible_is_image (obj))
1287 append_const_val (ret, "Image");
1288 if (atspi_accessible_is_selection (obj))
1289 append_const_val (ret, "Selection");
1290 if (atspi_accessible_is_table (obj))
1291 append_const_val (ret, "Table");
1292 if (atspi_accessible_is_text (obj))
1293 append_const_val (ret, "Text");
1294 if (atspi_accessible_is_value (obj))
1295 append_const_val (ret, "Value");
1301 atspi_accessible_new (AtspiApplication *app, const gchar *path)
1303 AtspiAccessible *accessible;
1305 accessible = g_object_new (ATSPI_TYPE_ACCESSIBLE, NULL);
1306 g_return_val_if_fail (accessible != NULL, NULL);
1308 accessible->parent.app = g_object_ref (app);
1309 accessible->parent.path = g_strdup (path);
1315 * atspi_accessible_set_cache_mask:
1317 * @accessible: The #AtspiAccessible to operate on. Must be the desktop or
1318 * the root of an application.
1319 * @mask: An #AtspiCache specifying a bit mask of the types of data to cache.
1321 * Sets the type of data to cache for accessibles.
1322 * If this is not set for an application or is reset to ATSPI_CACHE_UNDEFINED,
1323 * then the desktop's cache flag will be used.
1324 * If the desktop's cache flag is also undefined, then all possible data will
1326 * This function is intended to work around bugs in toolkits where the proper
1327 * events are not raised / to aid in testing for such bugs.
1329 * Note: This function has no effect on data that has already been cached.
1332 atspi_accessible_set_cache_mask (AtspiAccessible *accessible, AtspiCache mask)
1334 g_return_if_fail (accessible != NULL);
1335 g_return_if_fail (accessible->parent.app != NULL);
1336 g_return_if_fail (accessible == accessible->parent.app->root);
1337 accessible->parent.app->cache = mask;
1341 _atspi_accessible_add_cache (AtspiAccessible *accessible, AtspiCache flag)
1343 AtspiCache mask = accessible->parent.app->cache;
1345 if (mask == ATSPI_CACHE_UNDEFINED &&
1346 accessible->parent.app->root->accessible_parent)
1348 AtspiAccessible *desktop = atspi_get_desktop (0);
1349 mask = desktop->parent.app->cache;
1350 g_object_unref (desktop);
1353 if (mask == ATSPI_CACHE_UNDEFINED)
1354 mask = ATSPI_CACHE_ALL;
1356 accessible->cached_properties |= flag & mask;