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 Lesser General Public
  12  * License as published by the Free Software Foundation; either
  13  * version 2.1 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  * Lesser General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Lesser General Public
  21  * License along with this library; if not, write to the
  22  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  23  * Boston, MA 02110-1301, 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 *self;
  58   AtspiAccessible *parent;
  59   AtspiAccessible *described_by_accessible;
  60   GHashTable *attributes;
  61   AtspiRole role;
  62   AtspiRole parent_role;
  63   char *name;
  64   char *labeled_by_name;
  65   char *text_interface_name;
  66   char *localized_role_name;
  67   char *description;
  68   char *value_text;
  69   gdouble value;
  70   gdouble increment;
  71   gdouble lower;
  72   gdouble upper;
  73   gint64 states;
  74   gint64 parent_states;
  75   gint child_count;
  76   gint index_in_parent;
  77   gint list_children_count;
  78   gint first_selected_child_index;
  79   gint parent_child_count;
  80   gint parent_selected_child_count;
  81   gboolean is_selected_in_parent;
  82   gboolean has_checkbox_child;
  83 };
  84
  85 struct _AtspiAccessible
  86 {
  87   AtspiObject parent;
  88   AtspiAccessible *accessible_parent;
  89   GPtrArray *children;
  90   AtspiRole role;
  91   gint interfaces;
  92   char *name;
  93   char *description;
  94   AtspiStateSet *states;
  95   GHashTable *attributes;
  96   guint cached_properties;
  97   AtspiAccessiblePrivate *priv;
  98 };
  99
 100 typedef struct _AtspiAccessibleClass AtspiAccessibleClass;
 101 struct _AtspiAccessibleClass
 102 {
 103   AtspiObjectClass parent_class;
 104
 105   void (*region_changed) (AtspiAccessible *accessible, gint current_offset, gint last_offset);
 106   void (*mode_changed) (AtspiAccessible *accessible, gboolean enabled);
 107 };
 108
 109 GType atspi_accessible_get_type (void);
 110
 111 AtspiAccessible *
 112 _atspi_accessible_new (AtspiApplication *app, const gchar *path);
 113
 114 gchar * atspi_accessible_get_name (AtspiAccessible *obj, GError **error);
 115
 116 gchar * atspi_accessible_get_description (AtspiAccessible *obj, GError **error);
 117
 118 gchar * atspi_accessible_get_path (AtspiAccessible *obj, GError **error);
 119
 120 gchar * atspi_accessible_get_bus_name (AtspiAccessible *obj, GError **error);
 121
 122 gchar * atspi_accessible_get_unique_id (AtspiAccessible *obj, GError **error);
 123
 124 AtspiAccessible *atspi_accessible_get_navigable_at_point (AtspiAccessible *root, gint x, gint y, AtspiCoordType ctype, GError **error);
 125
 126 AtspiAccessible *atspi_accessible_get_neighbor (AtspiAccessible *root, AtspiAccessible *start, AtspiNeighborSearchDirection direction, GError **error);
 127
 128 AtspiAccessibleReadingMaterial *atspi_accessible_get_reading_material (AtspiAccessible *obj, GError **error);
 129
 130 void atspi_accessible_free_reading_material (AtspiAccessibleReadingMaterial *rm);
 131
 132 AtspiAccessibleDefaultLabelInfo *atspi_accessible_get_default_label_info (AtspiAccessible *obj, GError **error);
 133
 134 AtspiAccessible * atspi_accessible_get_parent (AtspiAccessible *obj, GError **error);
 135
 136 gint atspi_accessible_get_child_count (AtspiAccessible *obj, GError **error);
 137
 138 //TIZEN_ONLY(20230315) Add new API to get children
 139 GArray * atspi_accessible_get_children (AtspiAccessible *obj, GError **error);
 140 //
 141
 142 AtspiAccessible * atspi_accessible_get_child_at_index (AtspiAccessible *obj, gint    child_index, GError **error);
 143
 144 gint atspi_accessible_get_index_in_parent (AtspiAccessible *obj, GError **error);
 145
 146 GArray * atspi_accessible_get_relation_set (AtspiAccessible *obj, GError **error);
 147
 148 AtspiRole atspi_accessible_get_role (AtspiAccessible *obj, GError **error);
 149
 150 gchar * atspi_accessible_get_role_name (AtspiAccessible *obj, GError **error);
 151
 152 gchar * atspi_accessible_get_localized_role_name (AtspiAccessible *obj, GError **error);
 153
 154 AtspiStateSet * atspi_accessible_get_state_set (AtspiAccessible *obj);
 155
 156 GHashTable * atspi_accessible_get_attributes (AtspiAccessible *obj, GError **error);
 157
 158 GArray * atspi_accessible_get_attributes_as_array (AtspiAccessible *obj, GError **error);
 159
 160 gchar * atspi_accessible_get_toolkit_name (AtspiAccessible *obj, GError **error);
 161
 162 gchar * atspi_accessible_get_toolkit_version (AtspiAccessible *obj, GError **error);
 163
 164 gchar * atspi_accessible_get_atspi_version (AtspiAccessible *obj, GError **error);
 165
 166 gint atspi_accessible_get_id (AtspiAccessible *obj, GError **error);
 167
 168 AtspiAccessible * atspi_accessible_get_application (AtspiAccessible *obj, GError **error);
 169
 170 //TIZEN_ONLY(20230307) Provide post render callback to client
 171 void atspi_accessible_set_listen_post_render(AtspiAccessible *obj, gboolean enabled, GError **error);
 172 //
 173
 174 #ifndef ATSPI_DISABLE_DEPRECATED
 175 AtspiAction * atspi_accessible_get_action (AtspiAccessible *obj);
 176
 177 AtspiCollection * atspi_accessible_get_collection (AtspiAccessible *obj);
 178
 179 AtspiComponent * atspi_accessible_get_component (AtspiAccessible *obj);
 180
 181 AtspiDocument * atspi_accessible_get_document (AtspiAccessible *obj);
 182
 183 AtspiEditableText * atspi_accessible_get_editable_text (AtspiAccessible *obj);
 184
 185 AtspiHyperlink * atspi_accessible_get_hyperlink (AtspiAccessible *obj);
 186
 187 AtspiHypertext * atspi_accessible_get_hypertext (AtspiAccessible *obj);
 188
 189 AtspiImage * atspi_accessible_get_image (AtspiAccessible *obj);
 190
 191 AtspiSelection * atspi_accessible_get_selection (AtspiAccessible *obj);
 192
 193 AtspiTable * atspi_accessible_get_table (AtspiAccessible *obj);
 194
 195 AtspiTableCell * atspi_accessible_get_table_cell (AtspiAccessible *obj);
 196
 197 AtspiText * atspi_accessible_get_text (AtspiAccessible *obj);
 198
 199 AtspiValue * atspi_accessible_get_value (AtspiAccessible *obj);
 200 #endif
 201
 202 AtspiAction * atspi_accessible_get_action_iface (AtspiAccessible *obj);
 203
 204 AtspiCollection * atspi_accessible_get_collection_iface (AtspiAccessible *obj);
 205
 206 AtspiComponent * atspi_accessible_get_component_iface (AtspiAccessible *obj);
 207
 208 AtspiDocument * atspi_accessible_get_document_iface (AtspiAccessible *obj);
 209
 210 AtspiEditableText * atspi_accessible_get_editable_text_iface (AtspiAccessible *obj);
 211
 212 AtspiHypertext * atspi_accessible_get_hypertext_iface (AtspiAccessible *obj);
 213
 214 AtspiImage * atspi_accessible_get_image_iface (AtspiAccessible *obj);
 215
 216 AtspiSelection * atspi_accessible_get_selection_iface (AtspiAccessible *obj);
 217
 218 AtspiTable * atspi_accessible_get_table_iface (AtspiAccessible *obj);
 219
 220 AtspiText * atspi_accessible_get_text_iface (AtspiAccessible *obj);
 221
 222 AtspiValue * atspi_accessible_get_value_iface (AtspiAccessible *obj);
 223
 224 GArray * atspi_accessible_get_interfaces (AtspiAccessible *obj);
 225
 226 const gchar* atspi_accessible_get_object_locale (AtspiAccessible *accessible, GError **error);
 227
 228 void atspi_accessible_set_cache_mask (AtspiAccessible *accessible, AtspiCache mask);
 229
 230 void atspi_accessible_clear_cache (AtspiAccessible *obj);
 231
 232 guint atspi_accessible_get_process_id (AtspiAccessible *accessible, GError **error);
 233
 234 gchar * atspi_accessible_get_accessible_id (AtspiAccessible *obj, GError **error);
 235
 236 gboolean atspi_accessible_is_equal (AtspiAccessible *obj, AtspiAccessible *other);
 237
 238 /* private */
 239 void _atspi_accessible_add_cache (AtspiAccessible *accessible, AtspiCache flag);
 240 AtspiCache _atspi_accessible_get_cache_mask (AtspiAccessible *accessible);
 241 gboolean _atspi_accessible_test_cache (AtspiAccessible *accessible, AtspiCache flag);
 242
 243 G_END_DECLS
 244
 245 #endif  /* _ATSPI_ACCESSIBLE_H_ */