Fix get_toolkit_version, and add get_atspi_version for accessibles
[platform/upstream/at-spi2-core.git] / atspi / atspi-accessible.h
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
29 #include "glib-object.h"
30
31 #include "atspi-application.h"
32 #include "atspi-constants.h"
33 #include "atspi-object.h"
34 #include "atspi-stateset.h"
35 #include "atspi-types.h"
36
37 #define ATSPI_TYPE_ACCESSIBLE                        (atspi_accessible_get_type ())
38 #define ATSPI_ACCESSIBLE(obj)                        (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATSPI_TYPE_ACCESSIBLE, AtspiAccessible))
39 #define ATSPI_ACCESSIBLE_CLASS(klass)                (G_TYPE_CHECK_CLASS_CAST ((klass), ATSPI_TYPE_ACCESSIBLE, AtspiAccessibleClass))
40 #define ATSPI_IS_ACCESSIBLE(obj)                     (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATSPI_TYPE_ACCESSIBLE))
41 #define ATSPI_IS_ACCESSIBLE_CLASS(klass)             (G_TYPE_CHECK_CLASS_TYPE ((klass), ATSPI_TYPE_ACCESSIBLE))
42 #define ATSPI_ACCESSIBLE_GET_CLASS(obj)              (G_TYPE_INSTANCE_GET_CLASS ((obj), ATSPI_TYPE_ACCESSIBLE, AtspiAccessibleClass))
43
44 struct _AtspiAccessible
45 {
46   AtspiObject parent;
47   AtspiAccessible *accessible_parent;
48   GList *children;
49   AtspiRole role;
50   gint interfaces;
51   char *name;
52   char *description;
53   AtspiStateSet *states;
54   guint cached_properties;
55 };
56
57 typedef struct _AtspiAccessibleClass AtspiAccessibleClass;
58 struct _AtspiAccessibleClass
59 {
60   AtspiObjectClass parent_class;
61 };
62
63 GType atspi_accessible_get_type (void); 
64
65 AtspiAccessible *
66 atspi_accessible_new (AtspiApplication *app, const gchar *path);
67
68 gchar * atspi_role_get_name (AtspiRole role);
69
70 gchar * atspi_accessible_get_name (AtspiAccessible *obj, GError **error);
71
72 gchar * atspi_accessible_get_description (AtspiAccessible *obj, GError **error);
73
74 AtspiAccessible * atspi_accessible_get_parent (AtspiAccessible *obj, GError **error);
75
76 gint atspi_accessible_get_child_count (AtspiAccessible *obj, GError **error);
77
78 AtspiAccessible * atspi_accessible_get_child_at_index (AtspiAccessible *obj, gint    child_index, GError **error);
79
80 gint atspi_accessible_get_index_in_parent (AtspiAccessible *obj, GError **error);
81
82 GArray * atspi_accessible_get_relation_set (AtspiAccessible *obj, GError **error);
83
84 AtspiRole atspi_accessible_get_role (AtspiAccessible *obj, GError **error);
85
86 gchar * atspi_accessible_get_role_name (AtspiAccessible *obj, GError **error);
87
88 gchar * atspi_accessible_get_localized_role_name (AtspiAccessible *obj, GError **error);
89
90 AtspiStateSet * atspi_accessible_get_state_set (AtspiAccessible *obj);
91
92 GHashTable * atspi_accessible_get_attributes (AtspiAccessible *obj, GError **error);
93
94 GArray * atspi_accessible_get_attributes_as_array (AtspiAccessible *obj, GError **error);
95
96 gchar * atspi_accessible_get_toolkit_name (AtspiAccessible *obj, GError **error);
97
98 gchar * atspi_accessible_get_toolkit_version (AtspiAccessible *obj, GError **error);
99
100 gchar * atspi_accessible_get_atspi_version (AtspiAccessible *obj, GError **error);
101
102 gint atspi_accessible_get_id (AtspiAccessible *obj, GError **error);
103
104 AtspiAccessible * atspi_accessible_get_application (AtspiAccessible *obj, GError **error);
105
106 AtspiAction * atspi_accessible_get_action (AtspiAccessible *obj);
107
108 AtspiCollection * atspi_accessible_get_collection (AtspiAccessible *obj);
109
110 AtspiComponent * atspi_accessible_get_component (AtspiAccessible *obj);
111
112 AtspiDocument * atspi_accessible_get_document (AtspiAccessible *obj);
113
114 AtspiEditableText * atspi_accessible_get_editable_text (AtspiAccessible *obj);
115
116 AtspiHyperlink * atspi_accessible_get_hyperlink (AtspiAccessible *obj);
117
118 AtspiHypertext * atspi_accessible_get_hypertext (AtspiAccessible *obj);
119
120 AtspiImage * atspi_accessible_get_image (AtspiAccessible *obj);
121
122 AtspiSelection * atspi_accessible_get_selection (AtspiAccessible *obj);
123
124 AtspiTable * atspi_accessible_get_table (AtspiAccessible *obj);
125
126 AtspiText * atspi_accessible_get_text (AtspiAccessible *obj);
127
128 AtspiValue * atspi_accessible_get_value (AtspiAccessible *obj);
129
130 GArray * atspi_accessible_get_interfaces (AtspiAccessible *obj);
131
132 void atspi_accessible_set_cache_mask (AtspiAccessible *accessible, AtspiCache mask);
133
134 /* private */
135 void _atspi_accessible_add_cache (AtspiAccessible *accessible, AtspiCache flag);
136 gboolean _atspi_accessible_test_cache (AtspiAccessible *accessible, AtspiCache flag);
137 #endif  /* _ATSPI_ACCESSIBLE_H_ */