atspi/atspi-component.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  *
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Lesser General Public
  11  * License as published by the Free Software Foundation; either
  12  * version 2.1 of the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Lesser General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Lesser General Public
  20  * License along with this library; if not, write to the
  21  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  22  * Boston, MA 02110-1301, USA.
  23  */
  24
  25 #ifndef _ATSPI_COMPONENT_H_
  26 #define _ATSPI_COMPONENT_H_
  27
  28 #include "glib-object.h"
  29
  30 #include "atspi-constants.h"
  31
  32 #include "atspi-types.h"
  33
  34 G_BEGIN_DECLS
  35
  36 typedef struct _AtspiRect AtspiRect;
  37 struct _AtspiRect
  38 {
  39   gint x;
  40   gint y;
  41   gint width;
  42   gint height;
  43 };
  44
  45 /**
  46  * ATSPI_TYPE_RECT:
  47  *
  48  * The #GType for a boxed type holding a #AtspiRect.
  49  */
  50 #define ATSPI_TYPE_RECT (atspi_rect_get_type ())
  51
  52 GType atspi_rect_get_type ();
  53
  54 AtspiRect *atspi_rect_copy (AtspiRect *src);
  55
  56 typedef struct _AtspiPoint AtspiPoint;
  57 struct _AtspiPoint
  58 {
  59   gint x;
  60   gint y;
  61 };
  62
  63 /**
  64  * ATSPI_TYPE_POINT:
  65  *
  66  * The #GType for a boxed type holding a #AtspiPoint.
  67  */
  68 #define ATSPI_TYPE_POINT (atspi_point_get_type ())
  69
  70 GType atspi_point_get_type ();
  71
  72 AtspiPoint *atspi_point_copy (AtspiPoint *src);
  73
  74 #define ATSPI_TYPE_COMPONENT                    (atspi_component_get_type ())
  75 #define ATSPI_IS_COMPONENT(obj)                 G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATSPI_TYPE_COMPONENT)
  76 #define ATSPI_COMPONENT(obj)                    G_TYPE_CHECK_INSTANCE_CAST ((obj), ATSPI_TYPE_COMPONENT, AtspiComponent)
  77 #define ATSPI_COMPONENT_GET_IFACE(obj)          (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATSPI_TYPE_COMPONENT, AtspiComponent))
  78
  79 GType atspi_component_get_type ();
  80
  81 struct _AtspiComponent
  82 {
  83   GTypeInterface parent;
  84 };
  85
  86 gboolean atspi_component_contains (AtspiComponent *obj, gint x, gint y, AtspiCoordType ctype, GError **error);
  87
  88 AtspiAccessible *atspi_component_get_accessible_at_point (AtspiComponent *obj, gint x, gint y, AtspiCoordType ctype, GError **error);
  89
  90 AtspiRect *atspi_component_get_extents (AtspiComponent *obj, AtspiCoordType ctype, GError **error);
  91
  92 AtspiPoint *atspi_component_get_position (AtspiComponent *obj, AtspiCoordType ctype, GError **error);
  93
  94 AtspiPoint *atspi_component_get_size (AtspiComponent *obj, GError **error);
  95
  96 AtspiComponentLayer atspi_component_get_layer (AtspiComponent *obj, GError **error);
  97
  98 gshort atspi_component_get_mdi_z_order (AtspiComponent *obj, GError **error);
  99
 100 gboolean atspi_component_grab_focus (AtspiComponent *obj, GError **error);
 101
 102 gdouble      atspi_component_get_alpha    (AtspiComponent *obj, GError **error);
 103
 104 gboolean atspi_component_set_extents (AtspiComponent *obj, gint x, gint y, gint width, gint height, AtspiCoordType ctype, GError **error);
 105
 106 gboolean atspi_component_set_position (AtspiComponent *obj, gint x, gint y, AtspiCoordType ctype, GError **error);
 107
 108 gboolean atspi_component_set_size (AtspiComponent *obj, gint width, gint height, GError **error);
 109
 110 gboolean atspi_component_scroll_to (AtspiComponent *obj, AtspiScrollType type, GError **error);
 111
 112 gboolean atspi_component_scroll_to_point (AtspiComponent *obj, AtspiCoordType coords, gint x, gint y, GError **error);
 113
 114 G_END_DECLS
 115
 116 #endif  /* _ATSPI_COMPONENT_H_ */