1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
|
/* 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 (ATK_COMPILATION)
#error "Only <atk/atk.h> can be included directly."
#endif
#include <atk/atkobject.h>
#include <atk/atkutil.h>
G_BEGIN_DECLS
/**
*AtkScrollType:
*@ATK_SCROLL_TOP_LEFT: Scroll the object vertically and horizontally to the top
*left corner of the window.
*@ATK_SCROLL_BOTTOM_RIGHT: Scroll the object vertically and horizontally to the
*bottom right corner of the window.
*@ATK_SCROLL_TOP_EDGE: Scroll the object vertically to the top edge of the
window.
*@ATK_SCROLL_BOTTOM_EDGE: Scroll the object vertically to the bottom edge of
*the window.
*@ATK_SCROLL_LEFT_EDGE: Scroll the object vertically and horizontally to the
*left edge of the window.
*@ATK_SCROLL_RIGHT_EDGE: Scroll the object vertically and horizontally to the
*right edge of the window.
*@ATK_SCROLL_ANYWHERE: Scroll the object vertically and horizontally so that
*as much as possible of the object becomes visible. The exact placement is
*determined by the application.
*
* Specifies where an object should be placed on the screen when using scroll_to.
*
* Since: 2.30
**/
typedef enum {
ATK_SCROLL_TOP_LEFT,
ATK_SCROLL_BOTTOM_RIGHT,
ATK_SCROLL_TOP_EDGE,
ATK_SCROLL_BOTTOM_EDGE,
ATK_SCROLL_LEFT_EDGE,
ATK_SCROLL_RIGHT_EDGE,
ATK_SCROLL_ANYWHERE
} AtkScrollType;
/*
* 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.
*/
#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;
/**
* AtkFocusHandler:
* @object: the #AtkObject that receives/lose the focus
* @focus_in: TRUE if the object receives the focus
*
* The type of callback function used for
* atk_component_add_focus_handler() and
* atk_component_remove_focus_handler()
*
* Deprecated: 2.9.4: Deprecated with atk_component_add_focus_handler()
* and atk_component_remove_focus_handler(). See those
* methods for more information.
*/
typedef void (*AtkFocusHandler) (AtkObject* object, gboolean focus_in);
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;
};
ATK_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 @get_extents instead.
* @get_size: This virtual function is deprecated since 2.12 and it
* should not be overriden. Use @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.
*/
struct _AtkComponentIface
{
GTypeInterface parent;
guint (* add_focus_handler) (AtkComponent *component,
AtkFocusHandler handler);
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.
* Since ATK 2.30
*/
gboolean (*scroll_to) (AtkComponent *component,
AtkScrollType type);
gboolean (*scroll_to_point) (AtkComponent *component,
AtkCoordType coords,
gint x,
gint y);
};
ATK_AVAILABLE_IN_ALL
GType atk_component_get_type (void);
/* convenience functions */
ATK_DEPRECATED_IN_2_10
guint atk_component_add_focus_handler (AtkComponent *component,
AtkFocusHandler handler);
ATK_AVAILABLE_IN_ALL
gboolean atk_component_contains (AtkComponent *component,
gint x,
gint y,
AtkCoordType coord_type);
ATK_AVAILABLE_IN_ALL
AtkObject* atk_component_ref_accessible_at_point(AtkComponent *component,
gint x,
gint y,
AtkCoordType coord_type);
ATK_AVAILABLE_IN_ALL
void atk_component_get_extents (AtkComponent *component,
gint *x,
gint *y,
gint *width,
gint *height,
AtkCoordType coord_type);
ATK_DEPRECATED_IN_2_12_FOR(atk_component_get_extents)
void atk_component_get_position (AtkComponent *component,
gint *x,
gint *y,
AtkCoordType coord_type);
ATK_DEPRECATED_IN_2_12_FOR(atk_component_get_extents)
void atk_component_get_size (AtkComponent *component,
gint *width,
gint *height);
ATK_AVAILABLE_IN_ALL
AtkLayer atk_component_get_layer (AtkComponent *component);
ATK_AVAILABLE_IN_ALL
gint atk_component_get_mdi_zorder (AtkComponent *component);
ATK_AVAILABLE_IN_ALL
gboolean atk_component_grab_focus (AtkComponent *component);
ATK_DEPRECATED_IN_2_10
void atk_component_remove_focus_handler (AtkComponent *component,
guint handler_id);
ATK_AVAILABLE_IN_ALL
gboolean atk_component_set_extents (AtkComponent *component,
gint x,
gint y,
gint width,
gint height,
AtkCoordType coord_type);
ATK_AVAILABLE_IN_ALL
gboolean atk_component_set_position (AtkComponent *component,
gint x,
gint y,
AtkCoordType coord_type);
ATK_AVAILABLE_IN_ALL
gboolean atk_component_set_size (AtkComponent *component,
gint width,
gint height);
ATK_AVAILABLE_IN_ALL
gdouble atk_component_get_alpha (AtkComponent *component);
ATK_AVAILABLE_IN_2_30
gboolean atk_component_scroll_to (AtkComponent *component,
AtkScrollType type);
ATK_AVAILABLE_IN_2_30
gboolean atk_component_scroll_to_point (AtkComponent *component,
AtkCoordType coords,
gint x,
gint y);
G_END_DECLS
#endif /* __ATK_COMPONENT_H__ */
|
