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