diff options
Diffstat (limited to 'atk/atkcomponent.h')
| -rw-r--r-- | atk/atkcomponent.h | 232 |
1 files changed, 232 insertions, 0 deletions
diff --git a/atk/atkcomponent.h b/atk/atkcomponent.h new file mode 100644 index 0000000000..de33022075 --- /dev/null +++ b/atk/atkcomponent.h @@ -0,0 +1,232 @@ +/* ATK - Accessibility Toolkit + * Copyright 2001 Sun Microsystems Inc. + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Library General Public + * License as published by the Free Software Foundation; either + * version 2 of the License, or (at your option) any later version. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Library General Public License for more details. + * + * You should have received a copy of the GNU Library General Public + * License along with this library; if not, write to the + * Free Software Foundation, Inc., 59 Temple Place - Suite 330, + * Boston, MA 02111-1307, USA. + */ + +#ifndef __ATK_COMPONENT_H__ +#define __ATK_COMPONENT_H__ + +#if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined (__ATK_H_INSIDE__) && !defined (GTK_COMPILATION) +#error "Only <atk/atk.h> can be included directly." +#endif + +#include <atk/atktypes.h> +#include <atk/atkobject.h> + +G_BEGIN_DECLS + +#define ATK_TYPE_COMPONENT (atk_component_get_type ()) +#define ATK_IS_COMPONENT(obj) G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_COMPONENT) +#define ATK_COMPONENT(obj) G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_COMPONENT, AtkComponent) +#define ATK_COMPONENT_GET_IFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), ATK_TYPE_COMPONENT, AtkComponentIface)) + +#ifndef _TYPEDEF_ATK_COMPONENT_ +#define _TYPEDEF_ATK_COMPONENT_ +typedef struct _AtkComponent AtkComponent; +#endif +typedef struct _AtkComponentIface AtkComponentIface; + +typedef struct _AtkRectangle AtkRectangle; + +/** + * AtkRectangle: + * @x: X coordinate of the left side of the rectangle. + * @y: Y coordinate of the top side of the rectangle. + * @width: width of the rectangle. + * @height: height of the rectangle. + * + * A data structure for holding a rectangle. Those coordinates are + * relative to the component top-level parent. + */ +struct _AtkRectangle +{ + gint x; + gint y; + gint width; + gint height; +}; + +GDK_AVAILABLE_IN_ALL +GType atk_rectangle_get_type (void); + +#define ATK_TYPE_RECTANGLE (atk_rectangle_get_type ()) + +/** + * AtkComponentIface: + * @add_focus_handler: This virtual function is deprecated since 2.9.4 + * and it should not be overriden. See atk_component_add_focus_handler() + * for more information. + * @get_position: This virtual function is deprecated since 2.12 and + * it should not be overriden. Use @AtkComponentIface.get_extents instead. + * @get_size: This virtual function is deprecated since 2.12 and it + * should not be overriden. Use @AtkComponentIface.get_extents instead. + * @remove_focus_handler: This virtual function is deprecated since + * 2.9.4 and it should not be overriden. See atk_component_remove_focus_handler() + * for more information. + * @contains: + * @ref_accessible_at_point: + * @get_extents: + * @grab_focus: + * @set_extents: + * @set_position: + * @set_size: + * @get_layer: + * @get_mdi_zorder: + * @bounds_changed: + * @get_alpha: + * @scroll_to: + * @scroll_to_point: + * + * The AtkComponent interface should be supported by any object that is + * rendered on the screen. The interface provides the standard mechanism + * for an assistive technology to determine and set the graphical + * representation of an object. + */ +struct _AtkComponentIface +{ + /*< private >*/ + GTypeInterface parent; + + /*< public >*/ + gboolean (* contains) (AtkComponent *component, + gint x, + gint y, + AtkCoordType coord_type); + + AtkObject* (* ref_accessible_at_point) (AtkComponent *component, + gint x, + gint y, + AtkCoordType coord_type); + void (* get_extents) (AtkComponent *component, + gint *x, + gint *y, + gint *width, + gint *height, + AtkCoordType coord_type); + void (* get_position) (AtkComponent *component, + gint *x, + gint *y, + AtkCoordType coord_type); + void (* get_size) (AtkComponent *component, + gint *width, + gint *height); + gboolean (* grab_focus) (AtkComponent *component); + void (* remove_focus_handler) (AtkComponent *component, + guint handler_id); + gboolean (* set_extents) (AtkComponent *component, + gint x, + gint y, + gint width, + gint height, + AtkCoordType coord_type); + gboolean (* set_position) (AtkComponent *component, + gint x, + gint y, + AtkCoordType coord_type); + gboolean (* set_size) (AtkComponent *component, + gint width, + gint height); + + AtkLayer (* get_layer) (AtkComponent *component); + gint (* get_mdi_zorder) (AtkComponent *component); + + /* + * signal handlers + */ + void (* bounds_changed) (AtkComponent *component, + AtkRectangle *bounds); + gdouble (* get_alpha) (AtkComponent *component); + + /* + * Scrolls this object so it becomes visible on the screen. + * + * scroll_to lets the implementation compute an appropriate target + * position on the screen, with type used as a positioning hint. + * + * scroll_to_point lets the client specify a precise target position + * on the screen for the top-left of the object. + * + * Since ATK 2.30 + */ + gboolean (*scroll_to) (AtkComponent *component, + AtkScrollType type); + + gboolean (*scroll_to_point) (AtkComponent *component, + AtkCoordType coords, + gint x, + gint y); +}; + +GDK_AVAILABLE_IN_ALL +GType atk_component_get_type (void); + +/* convenience functions */ +GDK_AVAILABLE_IN_ALL +gboolean atk_component_contains (AtkComponent *component, + gint x, + gint y, + AtkCoordType coord_type); +GDK_AVAILABLE_IN_ALL +AtkObject* atk_component_ref_accessible_at_point(AtkComponent *component, + gint x, + gint y, + AtkCoordType coord_type); +GDK_AVAILABLE_IN_ALL +void atk_component_get_extents (AtkComponent *component, + gint *x, + gint *y, + gint *width, + gint *height, + AtkCoordType coord_type); +GDK_AVAILABLE_IN_ALL +AtkLayer atk_component_get_layer (AtkComponent *component); +GDK_AVAILABLE_IN_ALL +gint atk_component_get_mdi_zorder (AtkComponent *component); +GDK_AVAILABLE_IN_ALL +gboolean atk_component_grab_focus (AtkComponent *component); +GDK_AVAILABLE_IN_ALL +gboolean atk_component_set_extents (AtkComponent *component, + gint x, + gint y, + gint width, + gint height, + AtkCoordType coord_type); +GDK_AVAILABLE_IN_ALL +gboolean atk_component_set_position (AtkComponent *component, + gint x, + gint y, + AtkCoordType coord_type); +GDK_AVAILABLE_IN_ALL +gboolean atk_component_set_size (AtkComponent *component, + gint width, + gint height); +GDK_AVAILABLE_IN_ALL +gdouble atk_component_get_alpha (AtkComponent *component); + +GDK_AVAILABLE_IN_ALL +gboolean atk_component_scroll_to (AtkComponent *component, + AtkScrollType type); + +GDK_AVAILABLE_IN_ALL +gboolean atk_component_scroll_to_point (AtkComponent *component, + AtkCoordType coords, + gint x, + gint y); + +G_END_DECLS + +#endif /* __ATK_COMPONENT_H__ */ |