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-stateset.h"
33 #include "atspi-types.h"
35 #define ATSPI_TYPE_ACCESSIBLE (atspi_accessible_get_type ())
36 #define ATSPI_ACCESSIBLE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATSPI_TYPE_ACCESSIBLE, AtspiAccessible))
37 #define ATSPI_ACCESSIBLE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), ATSPI_TYPE_ACCESSIBLE, AtspiAccessibleClass))
38 #define ATSPI_IS_ACCESSIBLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATSPI_TYPE_ACCESSIBLE))
39 #define ATSPI_IS_ACCESSIBLE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), ATSPI_TYPE_ACCESSIBLE))
40 #define ATSPI_ACCESSIBLE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), ATSPI_TYPE_ACCESSIBLE, AtspiAccessibleClass))
42 typedef struct _AtspiAccessible AtspiAccessible;
43 struct _AtspiAccessible
47 AtspiAccessible *accessible_parent;
49 AtspiApplication *app;
55 AtspiStateSet *states;
56 guint cached_properties;
59 typedef struct _AtspiAccessibleClass AtspiAccessibleClass;
60 struct _AtspiAccessibleClass
62 GObjectClass parent_class;
65 GType atspi_accessible_get_type (void);
68 atspi_accessible_new (AtspiApplication *app, const gchar *path);
70 gchar * atspi_role_get_name (AtspiRole role);
72 gchar * atspi_accessible_get_name (AtspiAccessible *obj, GError **error);
74 gchar * atspi_accessible_get_description (AtspiAccessible *obj, GError **error);
76 AtspiAccessible * atspi_accessible_get_parent (AtspiAccessible *obj, GError **error);
78 gint atspi_accessible_get_child_count (AtspiAccessible *obj, GError *error);
80 AtspiAccessible * atspi_accessible_get_child_at_index (AtspiAccessible *obj, gint child_index, GError **error);
82 gint atspi_accessible_get_index_in_parent (AtspiAccessible *obj, GError **error);
84 GArray * atspi_accessible_get_relation_set (AtspiAccessible *obj, GError **error);
86 AtspiRole atspi_accessible_get_role (AtspiAccessible *obj, GError **error);
88 gchar * atspi_accessible_get_role_name (AtspiAccessible *obj, GError **error);
90 gchar * atspi_accessible_get_localized_role_name (AtspiAccessible *obj, GError **error);
92 AtspiStateSet * atspi_accessible_get_state_set (AtspiAccessible *obj);
94 GHashTable * atspi_accessible_get_attributes (AtspiAccessible *obj, GError **error);
96 GArray * atspi_accessible_get_attributes_as_array (AtspiAccessible *obj, GError **error);
98 AtspiAccessible * atspi_accessible_get_host_application (AtspiAccessible *obj, GError **error);
100 AtspiComponent * atspi_accessible_get_component (AtspiAccessible *accessible);
101 #endif /* _ATSPI_ACCESSIBLE_H_ */