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 guint cached_properties;
57 typedef struct _AtspiAccessibleClass AtspiAccessibleClass;
58 struct _AtspiAccessibleClass
60 AtspiObjectClass parent_class;
63 GType atspi_accessible_get_type (void);
66 atspi_accessible_new (AtspiApplication *app, const gchar *path);
68 gchar * atspi_role_get_name (AtspiRole role);
70 gchar * atspi_accessible_get_name (AtspiAccessible *obj, GError **error);
72 gchar * atspi_accessible_get_description (AtspiAccessible *obj, GError **error);
74 AtspiAccessible * atspi_accessible_get_parent (AtspiAccessible *obj, GError **error);
76 gint atspi_accessible_get_child_count (AtspiAccessible *obj, GError **error);
78 AtspiAccessible * atspi_accessible_get_child_at_index (AtspiAccessible *obj, gint child_index, GError **error);
80 gint atspi_accessible_get_index_in_parent (AtspiAccessible *obj, GError **error);
82 GArray * atspi_accessible_get_relation_set (AtspiAccessible *obj, GError **error);
84 AtspiRole atspi_accessible_get_role (AtspiAccessible *obj, GError **error);
86 gchar * atspi_accessible_get_role_name (AtspiAccessible *obj, GError **error);
88 gchar * atspi_accessible_get_localized_role_name (AtspiAccessible *obj, GError **error);
90 AtspiStateSet * atspi_accessible_get_state_set (AtspiAccessible *obj);
92 GHashTable * atspi_accessible_get_attributes (AtspiAccessible *obj, GError **error);
94 GArray * atspi_accessible_get_attributes_as_array (AtspiAccessible *obj, GError **error);
96 gchar * atspi_accessible_get_toolkit_name (AtspiAccessible *obj, GError **error);
98 gchar * atspi_accessible_get_toolkit_version (AtspiAccessible *obj, GError **error);
100 gint atspi_accessible_get_id (AtspiAccessible *obj, GError **error);
102 AtspiAccessible * atspi_accessible_get_application (AtspiAccessible *obj, GError **error);
104 AtspiAction * atspi_accessible_get_action (AtspiAccessible *obj);
106 AtspiCollection * atspi_accessible_get_collection (AtspiAccessible *obj);
108 AtspiComponent * atspi_accessible_get_component (AtspiAccessible *obj);
110 AtspiDocument * atspi_accessible_get_document (AtspiAccessible *obj);
112 AtspiEditableText * atspi_accessible_get_editable_text (AtspiAccessible *obj);
114 AtspiHyperlink * atspi_accessible_get_hyperlink (AtspiAccessible *obj);
116 AtspiHypertext * atspi_accessible_get_hypertext (AtspiAccessible *obj);
118 AtspiImage * atspi_accessible_get_image (AtspiAccessible *obj);
120 AtspiSelection * atspi_accessible_get_selection (AtspiAccessible *obj);
122 AtspiTable * atspi_accessible_get_table (AtspiAccessible *obj);
124 AtspiText * atspi_accessible_get_text (AtspiAccessible *obj);
126 AtspiValue * atspi_accessible_get_value (AtspiAccessible *obj);
128 GArray * atspi_accessible_get_interfaces (AtspiAccessible *obj);
130 void atspi_accessible_set_cache_mask (AtspiAccessible *accessible, AtspiCache mask);
133 void _atspi_accessible_add_cache (AtspiAccessible *accessible, AtspiCache flag);
134 #endif /* _ATSPI_ACCESSIBLE_H_ */