at-spi-2.0/atspi/atspi-component.h

0001 /*
0002  * AT-SPI - Assistive Technology Service Provider Interface
0003  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
0004  *
0005  * Copyright 2002 Ximian, Inc.
0006  *           2002 Sun Microsystems Inc.
0007  *
0008  *
0009  * This library is free software; you can redistribute it and/or
0010  * modify it under the terms of the GNU Lesser General Public
0011  * License as published by the Free Software Foundation; either
0012  * version 2.1 of the License, or (at your option) any later version.
0013  *
0014  * This library is distributed in the hope that it will be useful,
0015  * but WITHOUT ANY WARRANTY; without even the implied warranty of
0016  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
0017  * Lesser General Public License for more details.
0018  *
0019  * You should have received a copy of the GNU Lesser General Public
0020  * License along with this library; if not, write to the
0021  * Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
0022  * Boston, MA 02110-1301, USA.
0023  */
0024
0025 #ifndef _ATSPI_COMPONENT_H_
0026 #define _ATSPI_COMPONENT_H_
0027
0028 #include "glib-object.h"
0029
0030 #include "atspi-constants.h"
0031
0032 #include "atspi-types.h"
0033
0034 G_BEGIN_DECLS
0035
0036 typedef struct _AtspiRect AtspiRect;
0037 struct _AtspiRect
0038 {
0039   gint x;
0040   gint y;
0041   gint width;
0042   gint height;
0043 };
0044
0045 /**
0046  * ATSPI_TYPE_RECT:
0047  *
0048  * The #GType for a boxed type holding a #AtspiRect.
0049  */
0050 #define ATSPI_TYPE_RECT (atspi_rect_get_type ())
0051
0052 GType atspi_rect_get_type ();
0053
0054 AtspiRect *atspi_rect_copy (AtspiRect *src);
0055
0056 typedef struct _AtspiPoint AtspiPoint;
0057 struct _AtspiPoint
0058 {
0059   gint x;
0060   gint y;
0061 };
0062
0063 /**
0064  * ATSPI_TYPE_POINT:
0065  *
0066  * The #GType for a boxed type holding a #AtspiPoint.
0067  */
0068 #define ATSPI_TYPE_POINT (atspi_point_get_type ())
0069
0070 GType atspi_point_get_type ();
0071
0072 AtspiPoint *atspi_point_copy (AtspiPoint *src);
0073
0074 #define ATSPI_TYPE_COMPONENT (atspi_component_get_type ())
0075 #define ATSPI_IS_COMPONENT(obj) G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATSPI_TYPE_COMPONENT)
0076 #define ATSPI_COMPONENT(obj) G_TYPE_CHECK_INSTANCE_CAST ((obj), ATSPI_TYPE_COMPONENT, AtspiComponent)
0077 #define ATSPI_COMPONENT_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATSPI_TYPE_COMPONENT, AtspiComponent))
0078
0079 GType atspi_component_get_type ();
0080
0081 struct _AtspiComponent
0082 {
0083   GTypeInterface parent;
0084 };
0085
0086 gboolean atspi_component_contains (AtspiComponent *obj, gint x, gint y, AtspiCoordType ctype, GError **error);
0087
0088 AtspiAccessible *atspi_component_get_accessible_at_point (AtspiComponent *obj, gint x, gint y, AtspiCoordType ctype, GError **error);
0089
0090 AtspiRect *atspi_component_get_extents (AtspiComponent *obj, AtspiCoordType ctype, GError **error);
0091
0092 AtspiPoint *atspi_component_get_position (AtspiComponent *obj, AtspiCoordType ctype, GError **error);
0093
0094 AtspiPoint *atspi_component_get_size (AtspiComponent *obj, GError **error);
0095
0096 AtspiComponentLayer atspi_component_get_layer (AtspiComponent *obj, GError **error);
0097
0098 gshort atspi_component_get_mdi_z_order (AtspiComponent *obj, GError **error);
0099
0100 gboolean atspi_component_grab_focus (AtspiComponent *obj, GError **error);
0101
0102 gdouble atspi_component_get_alpha (AtspiComponent *obj, GError **error);
0103
0104 gboolean atspi_component_set_extents (AtspiComponent *obj, gint x, gint y, gint width, gint height, AtspiCoordType ctype, GError **error);
0105
0106 gboolean atspi_component_set_position (AtspiComponent *obj, gint x, gint y, AtspiCoordType ctype, GError **error);
0107
0108 gboolean atspi_component_set_size (AtspiComponent *obj, gint width, gint height, GError **error);
0109
0110 gboolean atspi_component_scroll_to (AtspiComponent *obj, AtspiScrollType type, GError **error);
0111
0112 gboolean atspi_component_scroll_to_point (AtspiComponent *obj, AtspiCoordType coords, gint x, gint y, GError **error);
0113
0114 G_END_DECLS
0115
0116 #endif /* _ATSPI_COMPONENT_H_ */