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 struct _AtspiAccessible
  47 {
  48   AtspiObject parent;
  49   AtspiAccessible *accessible_parent;
  50   GList *children;
  51   AtspiRole role;
  52   gint interfaces;
  53   char *name;
  54   char *description;
  55   AtspiStateSet *states;
  56   GHashTable *attributes;
  57   guint cached_properties;
  58 };
  59
  60 typedef struct _AtspiAccessibleClass AtspiAccessibleClass;
  61 struct _AtspiAccessibleClass
  62 {
  63   AtspiObjectClass parent_class;
  64 };
  65
  66 GType atspi_accessible_get_type (void);
  67
  68 AtspiAccessible *
  69 _atspi_accessible_new (AtspiApplication *app, const gchar *path);
  70
  71 gchar * atspi_role_get_name (AtspiRole role);
  72
  73 gchar * atspi_accessible_get_name (AtspiAccessible *obj, GError **error);
  74
  75 gchar * atspi_accessible_get_description (AtspiAccessible *obj, GError **error);
  76
  77 AtspiAccessible * atspi_accessible_get_parent (AtspiAccessible *obj, GError **error);
  78
  79 gint atspi_accessible_get_child_count (AtspiAccessible *obj, GError **error);
  80
  81 AtspiAccessible * atspi_accessible_get_child_at_index (AtspiAccessible *obj, gint    child_index, GError **error);
  82
  83 gint atspi_accessible_get_index_in_parent (AtspiAccessible *obj, GError **error);
  84
  85 GArray * atspi_accessible_get_relation_set (AtspiAccessible *obj, GError **error);
  86
  87 AtspiRole atspi_accessible_get_role (AtspiAccessible *obj, GError **error);
  88
  89 gchar * atspi_accessible_get_role_name (AtspiAccessible *obj, GError **error);
  90
  91 gchar * atspi_accessible_get_localized_role_name (AtspiAccessible *obj, GError **error);
  92
  93 AtspiStateSet * atspi_accessible_get_state_set (AtspiAccessible *obj);
  94
  95 GHashTable * atspi_accessible_get_attributes (AtspiAccessible *obj, GError **error);
  96
  97 GArray * atspi_accessible_get_attributes_as_array (AtspiAccessible *obj, GError **error);
  98
  99 gchar * atspi_accessible_get_toolkit_name (AtspiAccessible *obj, GError **error);
 100
 101 gchar * atspi_accessible_get_toolkit_version (AtspiAccessible *obj, GError **error);
 102
 103 gchar * atspi_accessible_get_atspi_version (AtspiAccessible *obj, GError **error);
 104
 105 gint atspi_accessible_get_id (AtspiAccessible *obj, GError **error);
 106
 107 AtspiAccessible * atspi_accessible_get_application (AtspiAccessible *obj, GError **error);
 108
 109 AtspiAction * atspi_accessible_get_action (AtspiAccessible *obj);
 110
 111 AtspiCollection * atspi_accessible_get_collection (AtspiAccessible *obj);
 112
 113 AtspiComponent * atspi_accessible_get_component (AtspiAccessible *obj);
 114
 115 AtspiDocument * atspi_accessible_get_document (AtspiAccessible *obj);
 116
 117 AtspiEditableText * atspi_accessible_get_editable_text (AtspiAccessible *obj);
 118
 119 AtspiHyperlink * atspi_accessible_get_hyperlink (AtspiAccessible *obj);
 120
 121 AtspiHypertext * atspi_accessible_get_hypertext (AtspiAccessible *obj);
 122
 123 AtspiImage * atspi_accessible_get_image (AtspiAccessible *obj);
 124
 125 AtspiSelection * atspi_accessible_get_selection (AtspiAccessible *obj);
 126
 127 AtspiTable * atspi_accessible_get_table (AtspiAccessible *obj);
 128
 129 AtspiText * atspi_accessible_get_text (AtspiAccessible *obj);
 130
 131 AtspiValue * atspi_accessible_get_value (AtspiAccessible *obj);
 132
 133 GArray * atspi_accessible_get_interfaces (AtspiAccessible *obj);
 134
 135 const gchar* atspi_accessible_get_object_locale (AtspiAccessible *accessible, GError **error);
 136
 137 void atspi_accessible_set_cache_mask (AtspiAccessible *accessible, AtspiCache mask);
 138
 139 void atspi_accessible_clear_cache (AtspiAccessible *accessible);
 140
 141 guint atspi_accessible_get_process_id (AtspiAccessible *accessible, GError **error);
 142
 143 /* private */
 144 void _atspi_accessible_add_cache (AtspiAccessible *accessible, AtspiCache flag);
 145 AtspiCache _atspi_accessible_get_cache_mask (AtspiAccessible *accessible);
 146 gboolean _atspi_accessible_test_cache (AtspiAccessible *accessible, AtspiCache flag);
 147
 148 G_END_DECLS
 149
 150 #endif  /* _ATSPI_ACCESSIBLE_H_ */