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