at-spi-2.0/atspi/atspi-accessible.h

0001 /*
0002  * AT-SPI - Assistive Technology Service Provider Interface
0003  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
0004  *
0005  * Copyright 2002 Ximian, Inc.
0006  *           2002 Sun Microsystems Inc.
0007  * Copyright 2010, 2011 Novell, Inc.
0008  *
0009  *
0010  * This library is free software; you can redistribute it and/or
0011  * modify it under the terms of the GNU Lesser General Public
0012  * License as published by the Free Software Foundation; either
0013  * version 2.1 of the License, or (at your option) any later version.
0014  *
0015  * This library is distributed in the hope that it will be useful,
0016  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0017  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0018  * Lesser General Public License for more details.
0019  *
0020  * You should have received a copy of the GNU Lesser General Public
0021  * License along with this library; if not, write to the
0022  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
0023  * Boston, MA 02110-1301, USA.
0024  */
0025
0026 #ifndef _ATSPI_ACCESSIBLE_H_
0027 #define _ATSPI_ACCESSIBLE_H_
0028
0029 G_BEGIN_DECLS
0030
0031 #include "glib-object.h"
0032
0033 #include "atspi-application.h"
0034 #include "atspi-constants.h"
0035 #include "atspi-object.h"
0036 #include "atspi-stateset.h"
0037 #include "atspi-types.h"
0038
0039 #define ATSPI_TYPE_ACCESSIBLE (atspi_accessible_get_type ())
0040 #define ATSPI_ACCESSIBLE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), ATSPI_TYPE_ACCESSIBLE, AtspiAccessible))
0041 #define ATSPI_ACCESSIBLE_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), ATSPI_TYPE_ACCESSIBLE, AtspiAccessibleClass))
0042 #define ATSPI_IS_ACCESSIBLE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATSPI_TYPE_ACCESSIBLE))
0043 #define ATSPI_IS_ACCESSIBLE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), ATSPI_TYPE_ACCESSIBLE))
0044 #define ATSPI_ACCESSIBLE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), ATSPI_TYPE_ACCESSIBLE, AtspiAccessibleClass))
0045
0046 typedef struct _AtspiAccessiblePrivate AtspiAccessiblePrivate;
0047
0048 struct _AtspiAccessible
0049 {
0050   AtspiObject parent;
0051   AtspiAccessible *accessible_parent;
0052   GPtrArray *children;
0053   AtspiRole role;
0054   gint interfaces;
0055   char *name;
0056   char *description;
0057   AtspiStateSet *states;
0058   GHashTable *attributes;
0059   guint cached_properties;
0060   AtspiAccessiblePrivate *priv;
0061 };
0062
0063 typedef struct _AtspiAccessibleClass AtspiAccessibleClass;
0064 struct _AtspiAccessibleClass
0065 {
0066   AtspiObjectClass parent_class;
0067
0068   void (*region_changed) (AtspiAccessible *accessible, gint current_offset, gint last_offset);
0069   void (*mode_changed) (AtspiAccessible *accessible, gboolean enabled);
0070 };
0071
0072 GType atspi_accessible_get_type (void);
0073
0074 AtspiAccessible *
0075 _atspi_accessible_new (AtspiApplication *app, const gchar *path);
0076
0077 gchar *atspi_accessible_get_name (AtspiAccessible *obj, GError **error);
0078
0079 gchar *atspi_accessible_get_description (AtspiAccessible *obj, GError **error);
0080
0081 AtspiAccessible *atspi_accessible_get_parent (AtspiAccessible *obj, GError **error);
0082
0083 gint atspi_accessible_get_child_count (AtspiAccessible *obj, GError **error);
0084
0085 AtspiAccessible *atspi_accessible_get_child_at_index (AtspiAccessible *obj, gint child_index, GError **error);
0086
0087 gint atspi_accessible_get_index_in_parent (AtspiAccessible *obj, GError **error);
0088
0089 GArray *atspi_accessible_get_relation_set (AtspiAccessible *obj, GError **error);
0090
0091 AtspiRole atspi_accessible_get_role (AtspiAccessible *obj, GError **error);
0092
0093 gchar *atspi_accessible_get_role_name (AtspiAccessible *obj, GError **error);
0094
0095 gchar *atspi_accessible_get_localized_role_name (AtspiAccessible *obj, GError **error);
0096
0097 AtspiStateSet *atspi_accessible_get_state_set (AtspiAccessible *obj);
0098
0099 GHashTable *atspi_accessible_get_attributes (AtspiAccessible *obj, GError **error);
0100
0101 GArray *atspi_accessible_get_attributes_as_array (AtspiAccessible *obj, GError **error);
0102
0103 gchar *atspi_accessible_get_toolkit_name (AtspiAccessible *obj, GError **error);
0104
0105 gchar *atspi_accessible_get_toolkit_version (AtspiAccessible *obj, GError **error);
0106
0107 gchar *atspi_accessible_get_atspi_version (AtspiAccessible *obj, GError **error);
0108
0109 gint atspi_accessible_get_id (AtspiAccessible *obj, GError **error);
0110
0111 gboolean atspi_accessible_is_action (AtspiAccessible *obj);
0112
0113 gboolean atspi_accessible_is_application (AtspiAccessible *obj);
0114
0115 gboolean atspi_accessible_is_collection (AtspiAccessible *obj);
0116
0117 gboolean atspi_accessible_is_component (AtspiAccessible *obj);
0118
0119 gboolean atspi_accessible_is_document (AtspiAccessible *obj);
0120
0121 gboolean atspi_accessible_is_editable_text (AtspiAccessible *obj);
0122
0123 gboolean atspi_accessible_is_hypertext (AtspiAccessible *obj);
0124
0125 gboolean atspi_accessible_is_hyperlink (AtspiAccessible *obj);
0126
0127 gboolean atspi_accessible_is_image (AtspiAccessible *obj);
0128
0129 gboolean atspi_accessible_is_selection (AtspiAccessible *obj);
0130
0131 gboolean atspi_accessible_is_table (AtspiAccessible *obj);
0132
0133 gboolean atspi_accessible_is_table_cell (AtspiAccessible *obj);
0134
0135 gboolean atspi_accessible_is_text (AtspiAccessible *obj);
0136
0137 gboolean atspi_accessible_is_value (AtspiAccessible *obj);
0138
0139 AtspiAccessible *atspi_accessible_get_application (AtspiAccessible *obj, GError **error);
0140
0141 #ifndef ATSPI_DISABLE_DEPRECATED
0142 AtspiAction *atspi_accessible_get_action (AtspiAccessible *obj);
0143
0144 AtspiCollection *atspi_accessible_get_collection (AtspiAccessible *obj);
0145
0146 AtspiComponent *atspi_accessible_get_component (AtspiAccessible *obj);
0147
0148 AtspiDocument *atspi_accessible_get_document (AtspiAccessible *obj);
0149
0150 AtspiEditableText *atspi_accessible_get_editable_text (AtspiAccessible *obj);
0151
0152 AtspiHyperlink *atspi_accessible_get_hyperlink (AtspiAccessible *obj);
0153
0154 AtspiHypertext *atspi_accessible_get_hypertext (AtspiAccessible *obj);
0155
0156 AtspiImage *atspi_accessible_get_image (AtspiAccessible *obj);
0157
0158 AtspiSelection *atspi_accessible_get_selection (AtspiAccessible *obj);
0159
0160 AtspiTable *atspi_accessible_get_table (AtspiAccessible *obj);
0161
0162 AtspiTableCell *atspi_accessible_get_table_cell (AtspiAccessible *obj);
0163
0164 AtspiText *atspi_accessible_get_text (AtspiAccessible *obj);
0165
0166 AtspiValue *atspi_accessible_get_value (AtspiAccessible *obj);
0167 #endif
0168
0169 AtspiAction *atspi_accessible_get_action_iface (AtspiAccessible *obj);
0170
0171 AtspiCollection *atspi_accessible_get_collection_iface (AtspiAccessible *obj);
0172
0173 AtspiComponent *atspi_accessible_get_component_iface (AtspiAccessible *obj);
0174
0175 AtspiDocument *atspi_accessible_get_document_iface (AtspiAccessible *obj);
0176
0177 AtspiEditableText *atspi_accessible_get_editable_text_iface (AtspiAccessible *obj);
0178
0179 AtspiHypertext *atspi_accessible_get_hypertext_iface (AtspiAccessible *obj);
0180
0181 AtspiImage *atspi_accessible_get_image_iface (AtspiAccessible *obj);
0182
0183 AtspiSelection *atspi_accessible_get_selection_iface (AtspiAccessible *obj);
0184
0185 AtspiTable *atspi_accessible_get_table_iface (AtspiAccessible *obj);
0186
0187 AtspiText *atspi_accessible_get_text_iface (AtspiAccessible *obj);
0188
0189 AtspiValue *atspi_accessible_get_value_iface (AtspiAccessible *obj);
0190
0191 GArray *atspi_accessible_get_interfaces (AtspiAccessible *obj);
0192
0193 const gchar *atspi_accessible_get_object_locale (AtspiAccessible *accessible, GError **error);
0194
0195 void atspi_accessible_set_cache_mask (AtspiAccessible *accessible, AtspiCache mask);
0196
0197 void atspi_accessible_clear_cache (AtspiAccessible *obj);
0198
0199 void atspi_accessible_clear_cache_single (AtspiAccessible *obj);
0200
0201 guint atspi_accessible_get_process_id (AtspiAccessible *accessible, GError **error);
0202
0203 gchar *atspi_accessible_get_accessible_id (AtspiAccessible *obj, GError **error);
0204
0205 gchar *atspi_accessible_get_help_text (AtspiAccessible *obj, GError **error);
0206
0207 /* private */
0208 void _atspi_accessible_add_cache (AtspiAccessible *accessible, AtspiCache flag);
0209 AtspiCache _atspi_accessible_get_cache_mask (AtspiAccessible *accessible);
0210 gboolean _atspi_accessible_test_cache (AtspiAccessible *accessible, AtspiCache flag);
0211
0212 G_END_DECLS
0213
0214 #endif /* _ATSPI_ACCESSIBLE_H_ */