atk/atkcomponent.h

   1 /* ATK -  Accessibility Toolkit
   2  * Copyright 2001 Sun Microsystems Inc.
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Library General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Library General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Library General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 #if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined (__ATK_H_INSIDE__) && !defined (ATK_COMPILATION)
  21 #error "Only <atk/atk.h> can be included directly."
  22 #endif
  23
  24 #ifndef __ATK_COMPONENT_H__
  25 #define __ATK_COMPONENT_H__
  26
  27 #include <atk/atkobject.h>
  28 #include <atk/atkutil.h>
  29
  30 G_BEGIN_DECLS
  31
  32 /*
  33  * The AtkComponent interface should be supported by any object that is
  34  * rendered on the screen. The interface provides the standard mechanism
  35  * for an assistive technology to determine and set the graphical
  36  * representation of an object.
  37  */
  38
  39 #define ATK_TYPE_COMPONENT                    (atk_component_get_type ())
  40 #define ATK_IS_COMPONENT(obj)                 G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_COMPONENT)
  41 #define ATK_COMPONENT(obj)                    G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_COMPONENT, AtkComponent)
  42 #define ATK_COMPONENT_GET_IFACE(obj)          (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_COMPONENT, AtkComponentIface))
  43
  44 #ifndef _TYPEDEF_ATK_COMPONENT_
  45 #define _TYPEDEF_ATK_COMPONENT_
  46 typedef struct _AtkComponent AtkComponent;
  47 #endif
  48 typedef struct _AtkComponentIface  AtkComponentIface;
  49
  50 /**
  51  * AtkFocusHandler:
  52  * @object: the #AtkObject that receives/lose the focus
  53  * @focus_in: TRUE if the object receives the focus
  54  *
  55  * The type of callback function used for
  56  * atk_component_add_focus_handler() and
  57  * atk_component_remove_focus_handler()
  58  *
  59  * Deprecated: This type is deprecated since ATK version 2.9.4. as
  60  * atk_component_add_focus_handler() and
  61  * atk_component_remove_focus_handler() are deprecated. See those
  62  * methods for more information.
  63  */
  64 typedef void (*AtkFocusHandler) (AtkObject* object, gboolean focus_in);
  65
  66 typedef struct _AtkRectangle       AtkRectangle;
  67
  68 /**
  69  * AtkRectangle:
  70  * @x: X coordinate of the left side of the rectangle.
  71  * @y: Y coordinate of the top side of the rectangle.
  72  * @width: width of the rectangle.
  73  * @height: height of the rectangle.
  74  *
  75  * A data structure for holding a rectangle. Those coordinates are
  76  * relative to the component top-level parent.
  77  */
  78 struct _AtkRectangle
  79 {
  80   gint x;
  81   gint y;
  82   gint width;
  83   gint height;
  84 };
  85
  86 GType atk_rectangle_get_type (void);
  87
  88 #define ATK_TYPE_RECTANGLE (atk_rectangle_get_type ())
  89
  90 /**
  91  * AtkComponentIface:
  92  * @add_focus_handler: This virtual function is deprecated since 2.9.4
  93  * and it should not be overriden. See
  94  * atk_component_add_focus_handler() for more information.
  95  * @get_position: This virtual function is deprecated since 2.12 and
  96  * it should not be overriden. Use @get_extents instead.
  97  * @get_size: This virtual function is deprecated since 2.12 and it
  98  * should not be overriden. Use @get_extents instead.
  99  * @remove_focus_handler: This virtual function is deprecated since
 100  * 2.9.4 and it should not be overriden. See
 101  * atk_component_remove_focus_handler() for more information.
 102  */
 103
 104 struct _AtkComponentIface
 105 {
 106   GTypeInterface parent;
 107
 108   guint          (* add_focus_handler)  (AtkComponent          *component,
 109                                          AtkFocusHandler        handler);
 110
 111   gboolean       (* contains)           (AtkComponent          *component,
 112                                          gint                   x,
 113                                          gint                   y,
 114                                          AtkCoordType           coord_type);
 115
 116   AtkObject*    (* ref_accessible_at_point)  (AtkComponent     *component,
 117                                          gint                   x,
 118                                          gint                   y,
 119                                          AtkCoordType           coord_type);
 120   void          (* get_extents)         (AtkComponent          *component,
 121                                          gint                  *x,
 122                                          gint                  *y,
 123                                          gint                  *width,
 124                                          gint                  *height,
 125                                          AtkCoordType          coord_type);
 126   void                     (* get_position)     (AtkComponent   *component,
 127                                                  gint           *x,
 128                                                  gint           *y,
 129                                                  AtkCoordType   coord_type);
 130   void                     (* get_size)                 (AtkComponent   *component,
 131                                                          gint           *width,
 132                                                          gint           *height);
 133   gboolean                 (* grab_focus)               (AtkComponent   *component);
 134   gboolean                 (* grab_highlight)           (AtkComponent   *component);
 135   gboolean                 (* clear_highlight)          (AtkComponent   *component);
 136   gint                     (* get_highlight_index)      (AtkComponent   *component);
 137
 138   void                     (* remove_focus_handler)      (AtkComponent  *component,
 139                                                           guint         handler_id);
 140   gboolean                 (* set_extents)      (AtkComponent   *component,
 141                                                  gint           x,
 142                                                  gint           y,
 143                                                  gint           width,
 144                                                  gint           height,
 145                                                  AtkCoordType   coord_type);
 146   gboolean                 (* set_position)     (AtkComponent   *component,
 147                                                  gint           x,
 148                                                  gint           y,
 149                                                  AtkCoordType   coord_type);
 150   gboolean                 (* set_size)         (AtkComponent   *component,
 151                                                  gint           width,
 152                                                  gint           height);
 153
 154   AtkLayer                 (* get_layer)        (AtkComponent   *component);
 155   gint                     (* get_mdi_zorder)   (AtkComponent   *component);
 156
 157   /*
 158    * signal handlers
 159    */
 160   void                     (* bounds_changed)   (AtkComponent   *component,
 161                                                  AtkRectangle   *bounds);
 162   gdouble                  (* get_alpha)        (AtkComponent   *component);
 163 };
 164
 165 GType atk_component_get_type (void);
 166
 167 /* convenience functions */
 168 G_DEPRECATED
 169 guint                atk_component_add_focus_handler      (AtkComponent    *component,
 170                                                            AtkFocusHandler handler);
 171 gboolean              atk_component_contains               (AtkComponent    *component,
 172                                                             gint            x,
 173                                                             gint            y,
 174                                                             AtkCoordType    coord_type);
 175 AtkObject*            atk_component_ref_accessible_at_point(AtkComponent    *component,
 176                                                             gint            x,
 177                                                             gint            y,
 178                                                             AtkCoordType    coord_type);
 179 void                  atk_component_get_extents            (AtkComponent    *component,
 180                                                             gint            *x,
 181                                                             gint            *y,
 182                                                             gint            *width,
 183                                                             gint            *height,
 184                                                             AtkCoordType    coord_type);
 185 G_DEPRECATED_FOR(atk_component_get_extents)
 186 void                  atk_component_get_position           (AtkComponent    *component,
 187                                                             gint            *x,
 188                                                             gint            *y,
 189                                                             AtkCoordType    coord_type);
 190 G_DEPRECATED_FOR(atk_component_get_extents)
 191 void                  atk_component_get_size               (AtkComponent    *component,
 192                                                             gint            *width,
 193                                                             gint            *height);
 194 AtkLayer              atk_component_get_layer              (AtkComponent    *component);
 195 gint                  atk_component_get_mdi_zorder         (AtkComponent    *component);
 196 gboolean              atk_component_grab_focus             (AtkComponent    *component);
 197 gboolean              atk_component_grab_highlight         (AtkComponent    *component);
 198 gboolean              atk_component_clear_highlight        (AtkComponent    *component);
 199 gint                  atk_component_get_highlight_index    (AtkComponent    *component);
 200 G_DEPRECATED
 201 void                  atk_component_remove_focus_handler   (AtkComponent    *component,
 202                                                             guint           handler_id);
 203 gboolean              atk_component_set_extents            (AtkComponent    *component,
 204                                                             gint            x,
 205                                                             gint            y,
 206                                                             gint            width,
 207                                                             gint            height,
 208                                                             AtkCoordType    coord_type);
 209 gboolean              atk_component_set_position           (AtkComponent    *component,
 210                                                             gint            x,
 211                                                             gint            y,
 212                                                             AtkCoordType    coord_type);
 213 gboolean              atk_component_set_size               (AtkComponent    *component,
 214                                                             gint            width,
 215                                                             gint            height);
 216 gdouble               atk_component_get_alpha              (AtkComponent    *component);
 217
 218 G_END_DECLS
 219
 220 #endif /* __ATK_COMPONENT_H__ */