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 Lesser General Public
12 * License as published by the Free Software Foundation; either
13 * version 2.1 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 * Lesser General Public License for more details.
20 * You should have received a copy of the GNU Lesser General Public
21 * License along with this library; if not, write to the
22 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23 * Boston, MA 02110-1301, USA.
26 #ifndef _ATSPI_ACCESSIBLE_H_
27 #define _ATSPI_ACCESSIBLE_H_
31 #include "glib-object.h"
33 #include "atspi-application.h"
34 #include "atspi-constants.h"
35 #include "atspi-object.h"
36 #include "atspi-stateset.h"
37 #include "atspi-types.h"
39 #define ATSPI_TYPE_ACCESSIBLE (atspi_accessible_get_type ())
40 #define ATSPI_ACCESSIBLE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATSPI_TYPE_ACCESSIBLE, AtspiAccessible))
41 #define ATSPI_ACCESSIBLE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), ATSPI_TYPE_ACCESSIBLE, AtspiAccessibleClass))
42 #define ATSPI_IS_ACCESSIBLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATSPI_TYPE_ACCESSIBLE))
43 #define ATSPI_IS_ACCESSIBLE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), ATSPI_TYPE_ACCESSIBLE))
44 #define ATSPI_ACCESSIBLE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), ATSPI_TYPE_ACCESSIBLE, AtspiAccessibleClass))
46 typedef struct _AtspiAccessiblePrivate AtspiAccessiblePrivate;
48 struct _AtspiAccessibleDefaultLabelInfo
52 GHashTable *attributes;
55 struct _AtspiAccessibleReadingMaterial
57 AtspiAccessible *parent;
58 AtspiAccessible *described_by_accessible;
59 GHashTable *attributes;
61 AtspiRole parent_role;
63 char *labeled_by_name;
64 char *text_interface_name;
65 char *localized_role_name;
75 gint list_children_count;
76 gint first_selected_child_index;
77 gint parent_child_count;
78 gint parent_selected_child_count;
79 gboolean is_selected_in_parent;
80 gboolean has_checkbox_child;
83 struct _AtspiAccessible
86 AtspiAccessible *accessible_parent;
92 AtspiStateSet *states;
93 GHashTable *attributes;
94 guint cached_properties;
95 AtspiAccessiblePrivate *priv;
98 typedef struct _AtspiAccessibleClass AtspiAccessibleClass;
99 struct _AtspiAccessibleClass
101 AtspiObjectClass parent_class;
103 void (*region_changed) (AtspiAccessible *accessible, gint current_offset, gint last_offset);
104 void (*mode_changed) (AtspiAccessible *accessible, gboolean enabled);
107 GType atspi_accessible_get_type (void);
110 _atspi_accessible_new (AtspiApplication *app, const gchar *path);
112 gchar * atspi_accessible_get_name (AtspiAccessible *obj, GError **error);
114 gchar * atspi_accessible_get_description (AtspiAccessible *obj, GError **error);
116 gchar * atspi_accessible_get_path (AtspiAccessible *obj, GError **error);
118 gchar * atspi_accessible_get_bus_name (AtspiAccessible *obj, GError **error);
120 gchar * atspi_accessible_get_unique_id (AtspiAccessible *obj, GError **error);
122 AtspiAccessible *atspi_accessible_get_navigable_at_point (AtspiAccessible *root, gint x, gint y, AtspiCoordType ctype, GError **error);
124 AtspiAccessible *atspi_accessible_get_neighbor (AtspiAccessible *root, AtspiAccessible *start, AtspiNeighborSearchDirection direction, GError **error);
126 AtspiAccessibleReadingMaterial *atspi_accessible_get_reading_material (AtspiAccessible *obj, GError **error);
128 AtspiAccessibleDefaultLabelInfo *atspi_accessible_get_default_label_info (AtspiAccessible *obj, GError **error);
130 AtspiAccessible * atspi_accessible_get_parent (AtspiAccessible *obj, GError **error);
132 gint atspi_accessible_get_child_count (AtspiAccessible *obj, GError **error);
134 AtspiAccessible * atspi_accessible_get_child_at_index (AtspiAccessible *obj, gint child_index, GError **error);
136 gint atspi_accessible_get_index_in_parent (AtspiAccessible *obj, GError **error);
138 GArray * atspi_accessible_get_relation_set (AtspiAccessible *obj, GError **error);
140 AtspiRole atspi_accessible_get_role (AtspiAccessible *obj, GError **error);
142 gchar * atspi_accessible_get_role_name (AtspiAccessible *obj, GError **error);
144 gchar * atspi_accessible_get_localized_role_name (AtspiAccessible *obj, GError **error);
146 AtspiStateSet * atspi_accessible_get_state_set (AtspiAccessible *obj);
148 GHashTable * atspi_accessible_get_attributes (AtspiAccessible *obj, GError **error);
150 GArray * atspi_accessible_get_attributes_as_array (AtspiAccessible *obj, GError **error);
152 gchar * atspi_accessible_get_toolkit_name (AtspiAccessible *obj, GError **error);
154 gchar * atspi_accessible_get_toolkit_version (AtspiAccessible *obj, GError **error);
156 gchar * atspi_accessible_get_atspi_version (AtspiAccessible *obj, GError **error);
158 gint atspi_accessible_get_id (AtspiAccessible *obj, GError **error);
160 AtspiAccessible * atspi_accessible_get_application (AtspiAccessible *obj, GError **error);
162 #ifndef ATSPI_DISABLE_DEPRECATED
163 AtspiAction * atspi_accessible_get_action (AtspiAccessible *obj);
165 AtspiCollection * atspi_accessible_get_collection (AtspiAccessible *obj);
167 AtspiComponent * atspi_accessible_get_component (AtspiAccessible *obj);
169 AtspiDocument * atspi_accessible_get_document (AtspiAccessible *obj);
171 AtspiEditableText * atspi_accessible_get_editable_text (AtspiAccessible *obj);
173 AtspiHyperlink * atspi_accessible_get_hyperlink (AtspiAccessible *obj);
175 AtspiHypertext * atspi_accessible_get_hypertext (AtspiAccessible *obj);
177 AtspiImage * atspi_accessible_get_image (AtspiAccessible *obj);
179 AtspiSelection * atspi_accessible_get_selection (AtspiAccessible *obj);
181 AtspiTable * atspi_accessible_get_table (AtspiAccessible *obj);
183 AtspiTableCell * atspi_accessible_get_table_cell (AtspiAccessible *obj);
185 AtspiText * atspi_accessible_get_text (AtspiAccessible *obj);
187 AtspiValue * atspi_accessible_get_value (AtspiAccessible *obj);
190 AtspiAction * atspi_accessible_get_action_iface (AtspiAccessible *obj);
192 AtspiCollection * atspi_accessible_get_collection_iface (AtspiAccessible *obj);
194 AtspiComponent * atspi_accessible_get_component_iface (AtspiAccessible *obj);
196 AtspiDocument * atspi_accessible_get_document_iface (AtspiAccessible *obj);
198 AtspiEditableText * atspi_accessible_get_editable_text_iface (AtspiAccessible *obj);
200 AtspiHypertext * atspi_accessible_get_hypertext_iface (AtspiAccessible *obj);
202 AtspiImage * atspi_accessible_get_image_iface (AtspiAccessible *obj);
204 AtspiSelection * atspi_accessible_get_selection_iface (AtspiAccessible *obj);
206 AtspiTable * atspi_accessible_get_table_iface (AtspiAccessible *obj);
208 AtspiText * atspi_accessible_get_text_iface (AtspiAccessible *obj);
210 AtspiValue * atspi_accessible_get_value_iface (AtspiAccessible *obj);
212 GArray * atspi_accessible_get_interfaces (AtspiAccessible *obj);
214 const gchar* atspi_accessible_get_object_locale (AtspiAccessible *accessible, GError **error);
216 void atspi_accessible_set_cache_mask (AtspiAccessible *accessible, AtspiCache mask);
218 void atspi_accessible_clear_cache (AtspiAccessible *obj);
220 guint atspi_accessible_get_process_id (AtspiAccessible *accessible, GError **error);
222 gchar * atspi_accessible_get_accessible_id (AtspiAccessible *obj, GError **error);
224 gboolean atspi_accessible_is_equal (AtspiAccessible *obj, AtspiAccessible *other);
227 void _atspi_accessible_add_cache (AtspiAccessible *accessible, AtspiCache flag);
228 AtspiCache _atspi_accessible_get_cache_mask (AtspiAccessible *accessible);
229 gboolean _atspi_accessible_test_cache (AtspiAccessible *accessible, AtspiCache flag);
233 #endif /* _ATSPI_ACCESSIBLE_H_ */