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 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 _AtspiAccessibleDefaultLabelInfo
  49 {
  50   AtspiAccessible *obj;
  51   AtspiRole role;
  52   GHashTable *attributes;
  53 };
  54
  55 struct _AtspiAccessibleReadingMaterial
  56 {
  57   AtspiAccessible *parent;
  58   AtspiAccessible *described_by_accessible;
  59   GHashTable *attributes;
  60   AtspiRole role;
  61   AtspiRole parent_role;
  62   char *name;
  63   char *labeled_by_name;
  64   char *text_interface_name;
  65   char *localized_role_name;
  66   char *description;
  67   gdouble value;
  68   gdouble increment;
  69   gdouble lower;
  70   gdouble upper;
  71   gint64 states;
  72   gint64 parent_states;
  73   gint child_count;
  74   gint index_in_parent;
  75   gint list_children_count;
  76   gint first_selected_child_index;
  77   gint parent_child_count;
  78   gint parent_selected_child_count;
  79   gboolean is_selected_in_parent;
  80   gboolean has_checkbox_child;
  81 };
  82
  83 struct _AtspiAccessible
  84 {
  85   AtspiObject parent;
  86   AtspiAccessible *accessible_parent;
  87   GPtrArray *children;
  88   AtspiRole role;
  89   gint interfaces;
  90   char *name;
  91   char *description;
  92   AtspiStateSet *states;
  93   GHashTable *attributes;
  94   guint cached_properties;
  95   AtspiAccessiblePrivate *priv;
  96 };
  97
  98 typedef struct _AtspiAccessibleClass AtspiAccessibleClass;
  99 struct _AtspiAccessibleClass
 100 {
 101   AtspiObjectClass parent_class;
 102 };
 103
 104 GType atspi_accessible_get_type (void);
 105
 106 AtspiAccessible *
 107 _atspi_accessible_new (AtspiApplication *app, const gchar *path);
 108
 109 gchar * atspi_accessible_get_name (AtspiAccessible *obj, GError **error);
 110
 111 gchar * atspi_accessible_get_description (AtspiAccessible *obj, GError **error);
 112
 113 gchar * atspi_accessible_get_path (AtspiAccessible *obj, GError **error);
 114
 115 gchar * atspi_accessible_get_bus_name (AtspiAccessible *obj, GError **error);
 116
 117 gchar * atspi_accessible_get_unique_id (AtspiAccessible *obj, GError **error);
 118
 119 AtspiAccessible *atspi_accessible_get_navigable_at_point (AtspiAccessible *root, gint x, gint y, AtspiCoordType ctype, GError **error);
 120
 121 AtspiAccessible *atspi_accessible_get_neighbor (AtspiAccessible *root, AtspiAccessible *start, AtspiNeighborSearchDirection direction, GError **error);
 122
 123 AtspiAccessibleReadingMaterial *atspi_accessible_get_reading_material (AtspiAccessible *obj, GError **error);
 124
 125 AtspiAccessibleDefaultLabelInfo *atspi_accessible_get_default_label_info (AtspiAccessible *obj, GError **error);
 126
 127 AtspiAccessible * atspi_accessible_get_parent (AtspiAccessible *obj, GError **error);
 128
 129 gint atspi_accessible_get_child_count (AtspiAccessible *obj, GError **error);
 130
 131 AtspiAccessible * atspi_accessible_get_child_at_index (AtspiAccessible *obj, gint    child_index, GError **error);
 132
 133 gint atspi_accessible_get_index_in_parent (AtspiAccessible *obj, GError **error);
 134
 135 GArray * atspi_accessible_get_relation_set (AtspiAccessible *obj, GError **error);
 136
 137 AtspiRole atspi_accessible_get_role (AtspiAccessible *obj, GError **error);
 138
 139 gchar * atspi_accessible_get_role_name (AtspiAccessible *obj, GError **error);
 140
 141 gchar * atspi_accessible_get_localized_role_name (AtspiAccessible *obj, GError **error);
 142
 143 AtspiStateSet * atspi_accessible_get_state_set (AtspiAccessible *obj);
 144
 145 GHashTable * atspi_accessible_get_attributes (AtspiAccessible *obj, GError **error);
 146
 147 GArray * atspi_accessible_get_attributes_as_array (AtspiAccessible *obj, GError **error);
 148
 149 gchar * atspi_accessible_get_toolkit_name (AtspiAccessible *obj, GError **error);
 150
 151 gchar * atspi_accessible_get_toolkit_version (AtspiAccessible *obj, GError **error);
 152
 153 gchar * atspi_accessible_get_atspi_version (AtspiAccessible *obj, GError **error);
 154
 155 gint atspi_accessible_get_id (AtspiAccessible *obj, GError **error);
 156
 157 AtspiAccessible * atspi_accessible_get_application (AtspiAccessible *obj, GError **error);
 158
 159 #ifndef ATSPI_DISABLE_DEPRECATED
 160 AtspiAction * atspi_accessible_get_action (AtspiAccessible *obj);
 161
 162 AtspiCollection * atspi_accessible_get_collection (AtspiAccessible *obj);
 163
 164 AtspiComponent * atspi_accessible_get_component (AtspiAccessible *obj);
 165
 166 AtspiDocument * atspi_accessible_get_document (AtspiAccessible *obj);
 167
 168 AtspiEditableText * atspi_accessible_get_editable_text (AtspiAccessible *obj);
 169
 170 AtspiHyperlink * atspi_accessible_get_hyperlink (AtspiAccessible *obj);
 171
 172 AtspiHypertext * atspi_accessible_get_hypertext (AtspiAccessible *obj);
 173
 174 AtspiImage * atspi_accessible_get_image (AtspiAccessible *obj);
 175
 176 AtspiSelection * atspi_accessible_get_selection (AtspiAccessible *obj);
 177
 178 AtspiTable * atspi_accessible_get_table (AtspiAccessible *obj);
 179
 180 AtspiTableCell * atspi_accessible_get_table_cell (AtspiAccessible *obj);
 181
 182 AtspiText * atspi_accessible_get_text (AtspiAccessible *obj);
 183
 184 AtspiValue * atspi_accessible_get_value (AtspiAccessible *obj);
 185 #endif
 186
 187 AtspiAction * atspi_accessible_get_action_iface (AtspiAccessible *obj);
 188
 189 AtspiCollection * atspi_accessible_get_collection_iface (AtspiAccessible *obj);
 190
 191 AtspiComponent * atspi_accessible_get_component_iface (AtspiAccessible *obj);
 192
 193 AtspiDocument * atspi_accessible_get_document_iface (AtspiAccessible *obj);
 194
 195 AtspiEditableText * atspi_accessible_get_editable_text_iface (AtspiAccessible *obj);
 196
 197 AtspiHypertext * atspi_accessible_get_hypertext_iface (AtspiAccessible *obj);
 198
 199 AtspiImage * atspi_accessible_get_image_iface (AtspiAccessible *obj);
 200
 201 AtspiSelection * atspi_accessible_get_selection_iface (AtspiAccessible *obj);
 202
 203 AtspiTable * atspi_accessible_get_table_iface (AtspiAccessible *obj);
 204
 205 AtspiText * atspi_accessible_get_text_iface (AtspiAccessible *obj);
 206
 207 AtspiValue * atspi_accessible_get_value_iface (AtspiAccessible *obj);
 208
 209 GArray * atspi_accessible_get_interfaces (AtspiAccessible *obj);
 210
 211 const gchar* atspi_accessible_get_object_locale (AtspiAccessible *accessible, GError **error);
 212
 213 void atspi_accessible_set_cache_mask (AtspiAccessible *accessible, AtspiCache mask);
 214
 215 void atspi_accessible_clear_cache (AtspiAccessible *obj);
 216
 217 guint atspi_accessible_get_process_id (AtspiAccessible *accessible, GError **error);
 218
 219 /* private */
 220 void _atspi_accessible_add_cache (AtspiAccessible *accessible, AtspiCache flag);
 221 AtspiCache _atspi_accessible_get_cache_mask (AtspiAccessible *accessible);
 222 gboolean _atspi_accessible_test_cache (AtspiAccessible *accessible, AtspiCache flag);
 223
 224 G_END_DECLS
 225
 226 #endif  /* _ATSPI_ACCESSIBLE_H_ */