summaryrefslogtreecommitdiff
path: root/atspi/atspi-accessible.h
blob: 6d35ee840d1d226542132ffa7fd72b49b69e879a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
/*
 * AT-SPI - Assistive Technology Service Provider Interface
 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
 *
 * Copyright 2002 Ximian, Inc.
 *           2002 Sun Microsystems Inc.
 * Copyright 2010, 2011 Novell, Inc.
 *
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

#ifndef _ATSPI_ACCESSIBLE_H_
#define _ATSPI_ACCESSIBLE_H_

G_BEGIN_DECLS

#include "glib-object.h"

#include "atspi-application.h"
#include "atspi-constants.h"
#include "atspi-object.h"
#include "atspi-stateset.h"
#include "atspi-types.h"

#define ATSPI_TYPE_ACCESSIBLE (atspi_accessible_get_type ())
#define ATSPI_ACCESSIBLE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATSPI_TYPE_ACCESSIBLE, AtspiAccessible))
#define ATSPI_ACCESSIBLE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), ATSPI_TYPE_ACCESSIBLE, AtspiAccessibleClass))
#define ATSPI_IS_ACCESSIBLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATSPI_TYPE_ACCESSIBLE))
#define ATSPI_IS_ACCESSIBLE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), ATSPI_TYPE_ACCESSIBLE))
#define ATSPI_ACCESSIBLE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), ATSPI_TYPE_ACCESSIBLE, AtspiAccessibleClass))

typedef struct _AtspiAccessiblePrivate AtspiAccessiblePrivate;

struct _AtspiAccessible
{
  AtspiObject parent;
  AtspiAccessible *accessible_parent;
  GPtrArray *children;
  AtspiRole role;
  gint interfaces;
  char *name;
  char *description;
  AtspiStateSet *states;
  GHashTable *attributes;
  guint cached_properties;
  AtspiAccessiblePrivate *priv;
};

typedef struct _AtspiAccessibleClass AtspiAccessibleClass;
struct _AtspiAccessibleClass
{
  AtspiObjectClass parent_class;

  void (*region_changed) (AtspiAccessible *accessible, gint current_offset, gint last_offset);
  void (*mode_changed) (AtspiAccessible *accessible, gboolean enabled);
};

GType atspi_accessible_get_type (void);

AtspiAccessible *
_atspi_accessible_new (AtspiApplication *app, const gchar *path);

gchar *atspi_accessible_get_name (AtspiAccessible *obj, GError **error);

gchar *atspi_accessible_get_description (AtspiAccessible *obj, GError **error);

AtspiAccessible *atspi_accessible_get_parent (AtspiAccessible *obj, GError **error);

gint atspi_accessible_get_child_count (AtspiAccessible *obj, GError **error);

AtspiAccessible *atspi_accessible_get_child_at_index (AtspiAccessible *obj, gint child_index, GError **error);

gint atspi_accessible_get_index_in_parent (AtspiAccessible *obj, GError **error);

GArray *atspi_accessible_get_relation_set (AtspiAccessible *obj, GError **error);

AtspiRole atspi_accessible_get_role (AtspiAccessible *obj, GError **error);

gchar *atspi_accessible_get_role_name (AtspiAccessible *obj, GError **error);

gchar *atspi_accessible_get_localized_role_name (AtspiAccessible *obj, GError **error);

AtspiStateSet *atspi_accessible_get_state_set (AtspiAccessible *obj);

GHashTable *atspi_accessible_get_attributes (AtspiAccessible *obj, GError **error);

GArray *atspi_accessible_get_attributes_as_array (AtspiAccessible *obj, GError **error);

gchar *atspi_accessible_get_toolkit_name (AtspiAccessible *obj, GError **error);

gchar *atspi_accessible_get_toolkit_version (AtspiAccessible *obj, GError **error);

gchar *atspi_accessible_get_atspi_version (AtspiAccessible *obj, GError **error);

gint atspi_accessible_get_id (AtspiAccessible *obj, GError **error);

AtspiAccessible *atspi_accessible_get_application (AtspiAccessible *obj, GError **error);

#ifndef ATSPI_DISABLE_DEPRECATED
AtspiAction *atspi_accessible_get_action (AtspiAccessible *obj);

AtspiCollection *atspi_accessible_get_collection (AtspiAccessible *obj);

AtspiComponent *atspi_accessible_get_component (AtspiAccessible *obj);

AtspiDocument *atspi_accessible_get_document (AtspiAccessible *obj);

AtspiEditableText *atspi_accessible_get_editable_text (AtspiAccessible *obj);

AtspiHyperlink *atspi_accessible_get_hyperlink (AtspiAccessible *obj);

AtspiHypertext *atspi_accessible_get_hypertext (AtspiAccessible *obj);

AtspiImage *atspi_accessible_get_image (AtspiAccessible *obj);

AtspiSelection *atspi_accessible_get_selection (AtspiAccessible *obj);

AtspiTable *atspi_accessible_get_table (AtspiAccessible *obj);

AtspiTableCell *atspi_accessible_get_table_cell (AtspiAccessible *obj);

AtspiText *atspi_accessible_get_text (AtspiAccessible *obj);

AtspiValue *atspi_accessible_get_value (AtspiAccessible *obj);
#endif

AtspiAction *atspi_accessible_get_action_iface (AtspiAccessible *obj);

AtspiCollection *atspi_accessible_get_collection_iface (AtspiAccessible *obj);

AtspiComponent *atspi_accessible_get_component_iface (AtspiAccessible *obj);

AtspiDocument *atspi_accessible_get_document_iface (AtspiAccessible *obj);

AtspiEditableText *atspi_accessible_get_editable_text_iface (AtspiAccessible *obj);

AtspiHypertext *atspi_accessible_get_hypertext_iface (AtspiAccessible *obj);

AtspiImage *atspi_accessible_get_image_iface (AtspiAccessible *obj);

AtspiSelection *atspi_accessible_get_selection_iface (AtspiAccessible *obj);

AtspiTable *atspi_accessible_get_table_iface (AtspiAccessible *obj);

AtspiText *atspi_accessible_get_text_iface (AtspiAccessible *obj);

AtspiValue *atspi_accessible_get_value_iface (AtspiAccessible *obj);

GArray *atspi_accessible_get_interfaces (AtspiAccessible *obj);

const gchar *atspi_accessible_get_object_locale (AtspiAccessible *accessible, GError **error);

void atspi_accessible_set_cache_mask (AtspiAccessible *accessible, AtspiCache mask);

void atspi_accessible_clear_cache (AtspiAccessible *obj);

guint atspi_accessible_get_process_id (AtspiAccessible *accessible, GError **error);

gchar *atspi_accessible_get_accessible_id (AtspiAccessible *obj, GError **error);

/* private */
void _atspi_accessible_add_cache (AtspiAccessible *accessible, AtspiCache flag);
AtspiCache _atspi_accessible_get_cache_mask (AtspiAccessible *accessible);
gboolean _atspi_accessible_test_cache (AtspiAccessible *accessible, AtspiCache flag);

G_END_DECLS

#endif /* _ATSPI_ACCESSIBLE_H_ */