2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2002 Ximian, Inc.
6 * 2002 Sun Microsystems Inc.
7 * Copyright 2010, 2011 Novell, Inc.
10 * This library is free software; you can redistribute it and/or
11 * modify it under the terms of the GNU Library General Public
12 * License as published by the Free Software Foundation; either
13 * version 2 of the License, or (at your option) any later version.
15 * This library is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 * Library General Public License for more details.
20 * You should have received a copy of the GNU Library General Public
21 * License along with this library; if not, write to the
22 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 * Boston, MA 02111-1307, USA.
26 #ifndef _ATSPI_ACCESSIBLE_H_
27 #define _ATSPI_ACCESSIBLE_H_
29 #include "glib-object.h"
31 #include "atspi-application.h"
32 #include "atspi-constants.h"
33 #include "atspi-object.h"
34 #include "atspi-stateset.h"
35 #include "atspi-types.h"
37 #define ATSPI_TYPE_ACCESSIBLE (atspi_accessible_get_type ())
38 #define ATSPI_ACCESSIBLE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATSPI_TYPE_ACCESSIBLE, AtspiAccessible))
39 #define ATSPI_ACCESSIBLE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), ATSPI_TYPE_ACCESSIBLE, AtspiAccessibleClass))
40 #define ATSPI_IS_ACCESSIBLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATSPI_TYPE_ACCESSIBLE))
41 #define ATSPI_IS_ACCESSIBLE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), ATSPI_TYPE_ACCESSIBLE))
42 #define ATSPI_ACCESSIBLE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), ATSPI_TYPE_ACCESSIBLE, AtspiAccessibleClass))
44 struct _AtspiAccessible
47 AtspiAccessible *accessible_parent;
53 AtspiStateSet *states;
54 GHashTable *attributes;
55 guint cached_properties;
58 typedef struct _AtspiAccessibleClass AtspiAccessibleClass;
59 struct _AtspiAccessibleClass
61 AtspiObjectClass parent_class;
64 GType atspi_accessible_get_type (void);
67 atspi_accessible_new (AtspiApplication *app, const gchar *path);
69 gchar * atspi_role_get_name (AtspiRole role);
71 gchar * atspi_accessible_get_name (AtspiAccessible *obj, GError **error);
73 gchar * atspi_accessible_get_description (AtspiAccessible *obj, GError **error);
75 AtspiAccessible * atspi_accessible_get_parent (AtspiAccessible *obj, GError **error);
77 gint atspi_accessible_get_child_count (AtspiAccessible *obj, GError **error);
79 AtspiAccessible * atspi_accessible_get_child_at_index (AtspiAccessible *obj, gint child_index, GError **error);
81 gint atspi_accessible_get_index_in_parent (AtspiAccessible *obj, GError **error);
83 GPtrArray * atspi_accessible_get_relation_set (AtspiAccessible *obj, GError **error);
85 AtspiRole atspi_accessible_get_role (AtspiAccessible *obj, GError **error);
87 gchar * atspi_accessible_get_role_name (AtspiAccessible *obj, GError **error);
89 gchar * atspi_accessible_get_localized_role_name (AtspiAccessible *obj, GError **error);
91 AtspiStateSet * atspi_accessible_get_state_set (AtspiAccessible *obj);
93 GHashTable * atspi_accessible_get_attributes (AtspiAccessible *obj, GError **error);
95 GArray * atspi_accessible_get_attributes_as_array (AtspiAccessible *obj, GError **error);
97 gchar * atspi_accessible_get_toolkit_name (AtspiAccessible *obj, GError **error);
99 gchar * atspi_accessible_get_toolkit_version (AtspiAccessible *obj, GError **error);
101 gchar * atspi_accessible_get_atspi_version (AtspiAccessible *obj, GError **error);
103 gint atspi_accessible_get_id (AtspiAccessible *obj, GError **error);
105 AtspiAccessible * atspi_accessible_get_application (AtspiAccessible *obj, GError **error);
107 AtspiAction * atspi_accessible_get_action (AtspiAccessible *obj);
109 AtspiCollection * atspi_accessible_get_collection (AtspiAccessible *obj);
111 AtspiComponent * atspi_accessible_get_component (AtspiAccessible *obj);
113 AtspiDocument * atspi_accessible_get_document (AtspiAccessible *obj);
115 AtspiEditableText * atspi_accessible_get_editable_text (AtspiAccessible *obj);
117 AtspiHyperlink * atspi_accessible_get_hyperlink (AtspiAccessible *obj);
119 AtspiHypertext * atspi_accessible_get_hypertext (AtspiAccessible *obj);
121 AtspiImage * atspi_accessible_get_image (AtspiAccessible *obj);
123 AtspiSelection * atspi_accessible_get_selection (AtspiAccessible *obj);
125 AtspiTable * atspi_accessible_get_table (AtspiAccessible *obj);
127 AtspiText * atspi_accessible_get_text (AtspiAccessible *obj);
129 AtspiValue * atspi_accessible_get_value (AtspiAccessible *obj);
131 GArray * atspi_accessible_get_interfaces (AtspiAccessible *obj);
133 void atspi_accessible_set_cache_mask (AtspiAccessible *accessible, AtspiCache mask);
135 void atspi_accessible_clear_cache (AtspiAccessible *accessible);
137 guint atspi_accessible_get_process_id (AtspiAccessible *accessible, GError **error);
140 void _atspi_accessible_add_cache (AtspiAccessible *accessible, AtspiCache flag);
141 AtspiCache _atspi_accessible_get_cache_mask (AtspiAccessible *accessible);
142 gboolean _atspi_accessible_test_cache (AtspiAccessible *accessible, AtspiCache flag);
143 #endif /* _ATSPI_ACCESSIBLE_H_ */