1 /* ATK - Accessibility Toolkit
2 * Copyright 2001 Sun Microsystems Inc.
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.
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.
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.
20 #if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined (__ATK_H_INSIDE__) && !defined (ATK_COMPILATION)
21 #error "Only <atk/atk.h> can be included directly."
24 #ifndef __ATK_COMPONENT_H__
25 #define __ATK_COMPONENT_H__
27 #include <atk/atkobject.h>
28 #include <atk/atkutil.h>
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.
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))
44 #ifndef _TYPEDEF_ATK_COMPONENT_
45 #define _TYPEDEF_ATK_COMPONENT_
46 typedef struct _AtkComponent AtkComponent;
48 typedef struct _AtkComponentIface AtkComponentIface;
50 typedef void (*AtkFocusHandler) (AtkObject*, gboolean);
52 typedef struct _AtkRectangle AtkRectangle;
62 GType atk_rectangle_get_type (void);
64 #define ATK_TYPE_RECTANGLE (atk_rectangle_get_type ())
65 struct _AtkComponentIface
67 GTypeInterface parent;
69 guint (* add_focus_handler) (AtkComponent *component,
70 AtkFocusHandler handler);
72 gboolean (* contains) (AtkComponent *component,
75 AtkCoordType coord_type);
77 AtkObject* (* ref_accessible_at_point) (AtkComponent *component,
80 AtkCoordType coord_type);
81 void (* get_extents) (AtkComponent *component,
86 AtkCoordType coord_type);
87 void (* get_position) (AtkComponent *component,
90 AtkCoordType coord_type);
91 void (* get_size) (AtkComponent *component,
94 gboolean (* grab_focus) (AtkComponent *component);
95 void (* remove_focus_handler) (AtkComponent *component,
97 gboolean (* set_extents) (AtkComponent *component,
102 AtkCoordType coord_type);
103 gboolean (* set_position) (AtkComponent *component,
106 AtkCoordType coord_type);
107 gboolean (* set_size) (AtkComponent *component,
111 AtkLayer (* get_layer) (AtkComponent *component);
112 gint (* get_mdi_zorder) (AtkComponent *component);
117 void (* bounds_changed) (AtkComponent *component,
118 AtkRectangle *bounds);
119 gdouble (* get_alpha) (AtkComponent *component);
122 GType atk_component_get_type (void);
124 /* convenience functions */
126 guint atk_component_add_focus_handler (AtkComponent *component,
127 AtkFocusHandler handler);
128 gboolean atk_component_contains (AtkComponent *component,
131 AtkCoordType coord_type);
132 AtkObject* atk_component_ref_accessible_at_point(AtkComponent *component,
135 AtkCoordType coord_type);
136 void atk_component_get_extents (AtkComponent *component,
141 AtkCoordType coord_type);
142 void atk_component_get_position (AtkComponent *component,
145 AtkCoordType coord_type);
146 void atk_component_get_size (AtkComponent *component,
149 AtkLayer atk_component_get_layer (AtkComponent *component);
150 gint atk_component_get_mdi_zorder (AtkComponent *component);
151 gboolean atk_component_grab_focus (AtkComponent *component);
152 void atk_component_remove_focus_handler (AtkComponent *component,
154 gboolean atk_component_set_extents (AtkComponent *component,
159 AtkCoordType coord_type);
160 gboolean atk_component_set_position (AtkComponent *component,
163 AtkCoordType coord_type);
164 gboolean atk_component_set_size (AtkComponent *component,
167 gdouble atk_component_get_alpha (AtkComponent *component);
171 #endif /* __ATK_COMPONENT_H__ */