1/*
2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
4 *
5 * Copyright 2002 Ximian, Inc.
6 * 2002 Sun Microsystems Inc.
7 * Copyright 2010, 2011 Novell, Inc.
8 *
9 *
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.
14 *
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.
19 *
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.
24 */
25
26#ifndef _ATSPI_ACCESSIBLE_H_
27#define _ATSPI_ACCESSIBLE_H_
28
29G_BEGIN_DECLS
30
31#include "glib-object.h"
32
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"
38
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))
45
46typedef struct _AtspiAccessiblePrivate AtspiAccessiblePrivate;
47
48struct _AtspiAccessible
49{
50 AtspiObject parent;
51 AtspiAccessible *accessible_parent;
52 GPtrArray *children;
53 AtspiRole role;
54 gint interfaces;
55 char *name;
56 char *description;
57 AtspiStateSet *states;
58 GHashTable *attributes;
59 guint cached_properties;
60 AtspiAccessiblePrivate *priv;
61};
62
63typedef struct _AtspiAccessibleClass AtspiAccessibleClass;
64struct _AtspiAccessibleClass
65{
66 AtspiObjectClass parent_class;
67
68 void (*region_changed) (AtspiAccessible *accessible, gint current_offset, gint last_offset);
69 void (*mode_changed) (AtspiAccessible *accessible, gboolean enabled);
70};
71
72GType atspi_accessible_get_type (void);
73
74AtspiAccessible *
75_atspi_accessible_new (AtspiApplication *app, const gchar *path);
76
77gchar * atspi_accessible_get_name (AtspiAccessible *obj, GError **error);
78
79gchar * atspi_accessible_get_description (AtspiAccessible *obj, GError **error);
80
81AtspiAccessible * atspi_accessible_get_parent (AtspiAccessible *obj, GError **error);
82
83gint atspi_accessible_get_child_count (AtspiAccessible *obj, GError **error);
84
85AtspiAccessible * atspi_accessible_get_child_at_index (AtspiAccessible *obj, gint child_index, GError **error);
86
87gint atspi_accessible_get_index_in_parent (AtspiAccessible *obj, GError **error);
88
89GArray * atspi_accessible_get_relation_set (AtspiAccessible *obj, GError **error);
90
91AtspiRole atspi_accessible_get_role (AtspiAccessible *obj, GError **error);
92
93gchar * atspi_accessible_get_role_name (AtspiAccessible *obj, GError **error);
94
95gchar * atspi_accessible_get_localized_role_name (AtspiAccessible *obj, GError **error);
96
97AtspiStateSet * atspi_accessible_get_state_set (AtspiAccessible *obj);
98
99GHashTable * atspi_accessible_get_attributes (AtspiAccessible *obj, GError **error);
100
101GArray * atspi_accessible_get_attributes_as_array (AtspiAccessible *obj, GError **error);
102
103gchar * atspi_accessible_get_toolkit_name (AtspiAccessible *obj, GError **error);
104
105gchar * atspi_accessible_get_toolkit_version (AtspiAccessible *obj, GError **error);
106
107gchar * atspi_accessible_get_atspi_version (AtspiAccessible *obj, GError **error);
108
109gint atspi_accessible_get_id (AtspiAccessible *obj, GError **error);
110
111AtspiAccessible * atspi_accessible_get_application (AtspiAccessible *obj, GError **error);
112
113#ifndef ATSPI_DISABLE_DEPRECATED
114AtspiAction * atspi_accessible_get_action (AtspiAccessible *obj);
115
116AtspiCollection * atspi_accessible_get_collection (AtspiAccessible *obj);
117
118AtspiComponent * atspi_accessible_get_component (AtspiAccessible *obj);
119
120AtspiDocument * atspi_accessible_get_document (AtspiAccessible *obj);
121
122AtspiEditableText * atspi_accessible_get_editable_text (AtspiAccessible *obj);
123
124AtspiHyperlink * atspi_accessible_get_hyperlink (AtspiAccessible *obj);
125
126AtspiHypertext * atspi_accessible_get_hypertext (AtspiAccessible *obj);
127
128AtspiImage * atspi_accessible_get_image (AtspiAccessible *obj);
129
130AtspiSelection * atspi_accessible_get_selection (AtspiAccessible *obj);
131
132AtspiTable * atspi_accessible_get_table (AtspiAccessible *obj);
133
134AtspiTableCell * atspi_accessible_get_table_cell (AtspiAccessible *obj);
135
136AtspiText * atspi_accessible_get_text (AtspiAccessible *obj);
137
138AtspiValue * atspi_accessible_get_value (AtspiAccessible *obj);
139#endif
140
141AtspiAction * atspi_accessible_get_action_iface (AtspiAccessible *obj);
142
143AtspiCollection * atspi_accessible_get_collection_iface (AtspiAccessible *obj);
144
145AtspiComponent * atspi_accessible_get_component_iface (AtspiAccessible *obj);
146
147AtspiDocument * atspi_accessible_get_document_iface (AtspiAccessible *obj);
148
149AtspiEditableText * atspi_accessible_get_editable_text_iface (AtspiAccessible *obj);
150
151AtspiHypertext * atspi_accessible_get_hypertext_iface (AtspiAccessible *obj);
152
153AtspiImage * atspi_accessible_get_image_iface (AtspiAccessible *obj);
154
155AtspiSelection * atspi_accessible_get_selection_iface (AtspiAccessible *obj);
156
157AtspiTable * atspi_accessible_get_table_iface (AtspiAccessible *obj);
158
159AtspiText * atspi_accessible_get_text_iface (AtspiAccessible *obj);
160
161AtspiValue * atspi_accessible_get_value_iface (AtspiAccessible *obj);
162
163GArray * atspi_accessible_get_interfaces (AtspiAccessible *obj);
164
165const gchar* atspi_accessible_get_object_locale (AtspiAccessible *accessible, GError **error);
166
167void atspi_accessible_set_cache_mask (AtspiAccessible *accessible, AtspiCache mask);
168
169void atspi_accessible_clear_cache (AtspiAccessible *obj);
170
171guint atspi_accessible_get_process_id (AtspiAccessible *accessible, GError **error);
172
173gchar * atspi_accessible_get_accessible_id (AtspiAccessible *obj, GError **error);
174
175/* private */
176void _atspi_accessible_add_cache (AtspiAccessible *accessible, AtspiCache flag);
177AtspiCache _atspi_accessible_get_cache_mask (AtspiAccessible *accessible);
178gboolean _atspi_accessible_test_cache (AtspiAccessible *accessible, AtspiCache flag);
179
180G_END_DECLS
181
182#endif /* _ATSPI_ACCESSIBLE_H_ */
183

source code of include/at-spi-2.0/atspi/atspi-accessible.h