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 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.
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 * Library General Public License for more details.
19 *
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.
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
69GType atspi_accessible_get_type (void);
70
71AtspiAccessible *
72_atspi_accessible_new (AtspiApplication *app, const gchar *path);
73
74gchar * atspi_accessible_get_name (AtspiAccessible *obj, GError **error);
75
76gchar * atspi_accessible_get_description (AtspiAccessible *obj, GError **error);
77
78AtspiAccessible * atspi_accessible_get_parent (AtspiAccessible *obj, GError **error);
79
80gint atspi_accessible_get_child_count (AtspiAccessible *obj, GError **error);
81
82AtspiAccessible * atspi_accessible_get_child_at_index (AtspiAccessible *obj, gint child_index, GError **error);
83
84gint atspi_accessible_get_index_in_parent (AtspiAccessible *obj, GError **error);
85
86GArray * atspi_accessible_get_relation_set (AtspiAccessible *obj, GError **error);
87
88AtspiRole atspi_accessible_get_role (AtspiAccessible *obj, GError **error);
89
90gchar * atspi_accessible_get_role_name (AtspiAccessible *obj, GError **error);
91
92gchar * atspi_accessible_get_localized_role_name (AtspiAccessible *obj, GError **error);
93
94AtspiStateSet * atspi_accessible_get_state_set (AtspiAccessible *obj);
95
96GHashTable * atspi_accessible_get_attributes (AtspiAccessible *obj, GError **error);
97
98GArray * atspi_accessible_get_attributes_as_array (AtspiAccessible *obj, GError **error);
99
100gchar * atspi_accessible_get_toolkit_name (AtspiAccessible *obj, GError **error);
101
102gchar * atspi_accessible_get_toolkit_version (AtspiAccessible *obj, GError **error);
103
104gchar * atspi_accessible_get_atspi_version (AtspiAccessible *obj, GError **error);
105
106gint atspi_accessible_get_id (AtspiAccessible *obj, GError **error);
107
108AtspiAccessible * atspi_accessible_get_application (AtspiAccessible *obj, GError **error);
109
110#ifndef ATSPI_DISABLE_DEPRECATED
111AtspiAction * atspi_accessible_get_action (AtspiAccessible *obj);
112
113AtspiCollection * atspi_accessible_get_collection (AtspiAccessible *obj);
114
115AtspiComponent * atspi_accessible_get_component (AtspiAccessible *obj);
116
117AtspiDocument * atspi_accessible_get_document (AtspiAccessible *obj);
118
119AtspiEditableText * atspi_accessible_get_editable_text (AtspiAccessible *obj);
120
121AtspiHyperlink * atspi_accessible_get_hyperlink (AtspiAccessible *obj);
122
123AtspiHypertext * atspi_accessible_get_hypertext (AtspiAccessible *obj);
124
125AtspiImage * atspi_accessible_get_image (AtspiAccessible *obj);
126
127AtspiSelection * atspi_accessible_get_selection (AtspiAccessible *obj);
128
129AtspiTable * atspi_accessible_get_table (AtspiAccessible *obj);
130
131AtspiTableCell * atspi_accessible_get_table_cell (AtspiAccessible *obj);
132
133AtspiText * atspi_accessible_get_text (AtspiAccessible *obj);
134
135AtspiValue * atspi_accessible_get_value (AtspiAccessible *obj);
136#endif
137
138AtspiAction * atspi_accessible_get_action_iface (AtspiAccessible *obj);
139
140AtspiCollection * atspi_accessible_get_collection_iface (AtspiAccessible *obj);
141
142AtspiComponent * atspi_accessible_get_component_iface (AtspiAccessible *obj);
143
144AtspiDocument * atspi_accessible_get_document_iface (AtspiAccessible *obj);
145
146AtspiEditableText * atspi_accessible_get_editable_text_iface (AtspiAccessible *obj);
147
148AtspiHypertext * atspi_accessible_get_hypertext_iface (AtspiAccessible *obj);
149
150AtspiImage * atspi_accessible_get_image_iface (AtspiAccessible *obj);
151
152AtspiSelection * atspi_accessible_get_selection_iface (AtspiAccessible *obj);
153
154AtspiTable * atspi_accessible_get_table_iface (AtspiAccessible *obj);
155
156AtspiText * atspi_accessible_get_text_iface (AtspiAccessible *obj);
157
158AtspiValue * atspi_accessible_get_value_iface (AtspiAccessible *obj);
159
160GArray * atspi_accessible_get_interfaces (AtspiAccessible *obj);
161
162const gchar* atspi_accessible_get_object_locale (AtspiAccessible *accessible, GError **error);
163
164void atspi_accessible_set_cache_mask (AtspiAccessible *accessible, AtspiCache mask);
165
166void atspi_accessible_clear_cache (AtspiAccessible *obj);
167
168guint atspi_accessible_get_process_id (AtspiAccessible *accessible, GError **error);
169
170/* private */
171void _atspi_accessible_add_cache (AtspiAccessible *accessible, AtspiCache flag);
172AtspiCache _atspi_accessible_get_cache_mask (AtspiAccessible *accessible);
173gboolean _atspi_accessible_test_cache (AtspiAccessible *accessible, AtspiCache flag);
174
175G_END_DECLS
176
177#endif /* _ATSPI_ACCESSIBLE_H_ */
178