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.
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 #ifndef _ATSPI_ACCESSIBLE_H_
26 #define _ATSPI_ACCESSIBLE_H_
28 #include "glib-object.h"
30 #include "atspi-application.h"
31 #include "atspi-constants.h"
32 #include "atspi-object.h"
33 #include "atspi-stateset.h"
34 #include "atspi-types.h"
36 #define ATSPI_TYPE_ACCESSIBLE (atspi_accessible_get_type ())
37 #define ATSPI_ACCESSIBLE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATSPI_TYPE_ACCESSIBLE, AtspiAccessible))
38 #define ATSPI_ACCESSIBLE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), ATSPI_TYPE_ACCESSIBLE, AtspiAccessibleClass))
39 #define ATSPI_IS_ACCESSIBLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATSPI_TYPE_ACCESSIBLE))
40 #define ATSPI_IS_ACCESSIBLE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), ATSPI_TYPE_ACCESSIBLE))
41 #define ATSPI_ACCESSIBLE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), ATSPI_TYPE_ACCESSIBLE, AtspiAccessibleClass))
43 struct _AtspiAccessible
46 AtspiAccessible *accessible_parent;
52 AtspiStateSet *states;
53 guint cached_properties;
56 typedef struct _AtspiAccessibleClass AtspiAccessibleClass;
57 struct _AtspiAccessibleClass
59 AtspiObjectClass parent_class;
62 GType atspi_accessible_get_type (void);
65 atspi_accessible_new (AtspiApplication *app, const gchar *path);
67 gchar * atspi_role_get_name (AtspiRole role);
69 gchar * atspi_accessible_get_name (AtspiAccessible *obj, GError **error);
71 gchar * atspi_accessible_get_description (AtspiAccessible *obj, GError **error);
73 AtspiAccessible * atspi_accessible_get_parent (AtspiAccessible *obj, GError **error);
75 gint atspi_accessible_get_child_count (AtspiAccessible *obj, GError **error);
77 AtspiAccessible * atspi_accessible_get_child_at_index (AtspiAccessible *obj, gint child_index, GError **error);
79 gint atspi_accessible_get_index_in_parent (AtspiAccessible *obj, GError **error);
81 GArray * atspi_accessible_get_relation_set (AtspiAccessible *obj, GError **error);
83 AtspiRole atspi_accessible_get_role (AtspiAccessible *obj, GError **error);
85 gchar * atspi_accessible_get_role_name (AtspiAccessible *obj, GError **error);
87 gchar * atspi_accessible_get_localized_role_name (AtspiAccessible *obj, GError **error);
89 AtspiStateSet * atspi_accessible_get_state_set (AtspiAccessible *obj);
91 GHashTable * atspi_accessible_get_attributes (AtspiAccessible *obj, GError **error);
93 GArray * atspi_accessible_get_attributes_as_array (AtspiAccessible *obj, GError **error);
95 gchar * atspi_accessible_get_toolkit_name (AtspiAccessible *obj, GError **error);
97 gchar * atspi_accessible_get_toolkit_version (AtspiAccessible *obj, GError **error);
99 AtspiAccessible * atspi_accessible_get_application (AtspiAccessible *obj, GError **error);
101 AtspiAction * atspi_accessible_get_action (AtspiAccessible *obj);
103 AtspiCollection * atspi_accessible_get_collection (AtspiAccessible *obj);
105 AtspiComponent * atspi_accessible_get_component (AtspiAccessible *obj);
107 AtspiDocument * atspi_accessible_get_document (AtspiAccessible *obj);
109 AtspiEditableText * atspi_accessible_get_editable_text (AtspiAccessible *obj);
111 AtspiHyperlink * atspi_accessible_get_hyperlink (AtspiAccessible *obj);
113 AtspiHypertext * atspi_accessible_get_hypertext (AtspiAccessible *obj);
115 AtspiImage * atspi_accessible_get_image (AtspiAccessible *obj);
117 AtspiSelection * atspi_accessible_get_selection (AtspiAccessible *obj);
119 AtspiTable * atspi_accessible_get_table (AtspiAccessible *obj);
121 AtspiText * atspi_accessible_get_text (AtspiAccessible *obj);
123 AtspiValue * atspi_accessible_get_value (AtspiAccessible *obj);
125 GArray * atspi_accessible_get_interfaces (AtspiAccessible *obj);
127 void atspi_accessible_set_cache_mask (AtspiAccessible *accessible, AtspiCache mask);
130 void _atspi_accessible_add_cache (AtspiAccessible *accessible, AtspiCache flag);
131 #endif /* _ATSPI_ACCESSIBLE_H_ */