atkcomponent.h 13.7 KB
Newer Older
Bill Haneman's avatar
Bill Haneman committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
/* 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
Piotr Drąg's avatar
Piotr Drąg committed
15
16
17
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
Bill Haneman's avatar
Bill Haneman committed
18
19
 */

20
21
22
#ifndef __ATK_COMPONENT_H__
#define __ATK_COMPONENT_H__

23
24
25
26
#if defined(ATK_DISABLE_SINGLE_INCLUDES) && !defined (__ATK_H_INSIDE__) && !defined (ATK_COMPILATION)
#error "Only <atk/atk.h> can be included directly."
#endif

Bill Haneman's avatar
Bill Haneman committed
27
#include <atk/atkobject.h>
28
#include <atk/atkutil.h>
Bill Haneman's avatar
Bill Haneman committed
29

30
G_BEGIN_DECLS
Bill Haneman's avatar
Bill Haneman committed
31

32
/**
33
 * AtkScrollType:
34
35
36
37
38
39
40
41
42
43
44
45
 * @ATK_SCROLL_TOP_LEFT: Scroll the object vertically and horizontally to bring
 *   its top left corner to the top left corner of the window.
 * @ATK_SCROLL_BOTTOM_RIGHT: Scroll the object vertically and horizontally to
 *   bring its bottom right corner to the bottom right corner of the window.
 * @ATK_SCROLL_TOP_EDGE: Scroll the object vertically to bring its top edge to
 *   the top edge of the window.
 * @ATK_SCROLL_BOTTOM_EDGE: Scroll the object vertically to bring its bottom
 *   edge to the bottom edge of the window.
 * @ATK_SCROLL_LEFT_EDGE: Scroll the object vertically and horizontally to bring
 *   its left edge to the left edge of the window.
 * @ATK_SCROLL_RIGHT_EDGE: Scroll the object vertically and horizontally to
 *   bring its right edge to the right edge of the window.
46
47
48
 * @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.
49
50
 *
 * Specifies where an object should be placed on the screen when using scroll_to.
Michael Catanzaro's avatar
Michael Catanzaro committed
51
52
 *
 * Since: 2.30
53
 */
54
55
56
57
58
59
60
61
62
63
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;

Bill Haneman's avatar
Bill Haneman committed
64
65
66
67
68
69
70
71
72
#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
73
typedef struct _AtkComponentIface  AtkComponentIface;
Bill Haneman's avatar
Bill Haneman committed
74

75
76
77
78
79
80
81
82
83
/**
 * 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()
 *
84
85
 * Deprecated: 2.9.4: Deprecated with atk_component_add_focus_handler()
 * and atk_component_remove_focus_handler(). See those
86
87
88
 * methods for more information.
 */
typedef void (*AtkFocusHandler) (AtkObject* object, gboolean focus_in);
Bill Haneman's avatar
Bill Haneman committed
89

Padraig O'Briain's avatar
Padraig O'Briain committed
90
91
typedef struct _AtkRectangle       AtkRectangle;

92
93
94
95
96
97
98
99
100
101
/**
 * 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.
 */
Padraig O'Briain's avatar
Padraig O'Briain committed
102
103
104
105
106
107
108
struct _AtkRectangle
{
  gint x;
  gint y;
  gint width;
  gint height;
};
Bill Haneman's avatar
Bill Haneman committed
109

110
ATK_AVAILABLE_IN_ALL
111
112
113
GType atk_rectangle_get_type (void);

#define ATK_TYPE_RECTANGLE (atk_rectangle_get_type ())
114
115
116
117

/**
 * AtkComponentIface:
 * @add_focus_handler: This virtual function is deprecated since 2.9.4
118
119
 *   and it should not be overriden. See atk_component_add_focus_handler()
 *   for more information.
120
 * @get_position: This virtual function is deprecated since 2.12 and
121
 *   it should not be overriden. Use @AtkComponentIface.get_extents instead.
122
 * @get_size: This virtual function is deprecated since 2.12 and it
123
 *   should not be overriden. Use @AtkComponentIface.get_extents instead.
124
 * @remove_focus_handler: This virtual function is deprecated since
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 *   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.
145
 */
Bill Haneman's avatar
Bill Haneman committed
146
147
struct _AtkComponentIface
{
148
  /*< private >*/
Bill Haneman's avatar
Bill Haneman committed
149
150
  GTypeInterface parent;

151
  /*< public >*/
152
153
  guint          (* add_focus_handler)  (AtkComponent          *component,
                                         AtkFocusHandler        handler);
154

155
  gboolean       (* contains)           (AtkComponent          *component,
Bill Haneman's avatar
Bill Haneman committed
156
                                         gint                   x,
157
158
                                         gint                   y,
                                         AtkCoordType           coord_type);
Bill Haneman's avatar
Bill Haneman committed
159

160
  AtkObject*    (* ref_accessible_at_point)  (AtkComponent     *component,
Bill Haneman's avatar
Bill Haneman committed
161
                                         gint                   x,
162
163
                                         gint                   y,
                                         AtkCoordType           coord_type);
Bill Haneman's avatar
Bill Haneman committed
164
165
166
167
  void          (* get_extents)         (AtkComponent          *component,
                                         gint                  *x,
                                         gint                  *y,
                                         gint                  *width,
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
                                         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);
193
  	
194
195
  AtkLayer                 (* get_layer)        (AtkComponent   *component);
  gint                     (* get_mdi_zorder)   (AtkComponent   *component);
196

Padraig O'Briain's avatar
Padraig O'Briain committed
197
198
199
200
201
  /*
   * signal handlers
   */
  void                     (* bounds_changed)   (AtkComponent   *component,
                                                 AtkRectangle   *bounds);
202
  gdouble                  (* get_alpha)        (AtkComponent   *component);
203
204
205

  /*
   * Scrolls this object so it becomes visible on the screen.
206
207
208
209
210
211
212
   *
   * 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.
   *
213
214
215
216
217
218
219
220
221
   * Since ATK 2.30
   */
  gboolean                (*scroll_to)          (AtkComponent   *component,
                                                 AtkScrollType   type);

  gboolean                (*scroll_to_point)    (AtkComponent   *component,
                                                 AtkCoordType    coords,
                                                 gint            x,
                                                 gint            y);
Bill Haneman's avatar
Bill Haneman committed
222
223
};

224
ATK_AVAILABLE_IN_ALL
225
GType atk_component_get_type (void);
Bill Haneman's avatar
Bill Haneman committed
226
227

/* convenience functions */
228
ATK_DEPRECATED_IN_2_10
Bill Haneman's avatar
Bill Haneman committed
229
230
guint                atk_component_add_focus_handler      (AtkComponent    *component,
                                                           AtkFocusHandler handler);
231
ATK_AVAILABLE_IN_ALL
Bill Haneman's avatar
Bill Haneman committed
232
233
gboolean              atk_component_contains               (AtkComponent    *component,
                                                            gint            x,
234
235
                                                            gint            y,
                                                            AtkCoordType    coord_type);
236
ATK_AVAILABLE_IN_ALL
237
AtkObject*            atk_component_ref_accessible_at_point(AtkComponent    *component,
Bill Haneman's avatar
Bill Haneman committed
238
                                                            gint            x,
239
240
                                                            gint            y,
                                                            AtkCoordType    coord_type);
241
ATK_AVAILABLE_IN_ALL
Bill Haneman's avatar
Bill Haneman committed
242
243
244
245
void                  atk_component_get_extents            (AtkComponent    *component,
                                                            gint            *x,
                                                            gint            *y,
                                                            gint            *width,
246
247
                                                            gint            *height,
                                                            AtkCoordType    coord_type);
248
ATK_DEPRECATED_IN_2_12_FOR(atk_component_get_extents)
Bill Haneman's avatar
Bill Haneman committed
249
250
void                  atk_component_get_position           (AtkComponent    *component,
                                                            gint            *x,
251
252
                                                            gint            *y,
                                                            AtkCoordType    coord_type);
253
ATK_DEPRECATED_IN_2_12_FOR(atk_component_get_extents)
Bill Haneman's avatar
Bill Haneman committed
254
255
256
void                  atk_component_get_size               (AtkComponent    *component,
                                                            gint            *width,
                                                            gint            *height);
257
ATK_AVAILABLE_IN_ALL
258
AtkLayer              atk_component_get_layer              (AtkComponent    *component);
259
ATK_AVAILABLE_IN_ALL
260
gint                  atk_component_get_mdi_zorder         (AtkComponent    *component);
261
ATK_AVAILABLE_IN_ALL
262
gboolean              atk_component_grab_focus             (AtkComponent    *component);
263
ATK_DEPRECATED_IN_2_10
Bill Haneman's avatar
Bill Haneman committed
264
265
void                  atk_component_remove_focus_handler   (AtkComponent    *component,
                                                            guint           handler_id);
266
ATK_AVAILABLE_IN_ALL
267
gboolean              atk_component_set_extents            (AtkComponent    *component,
Bill Haneman's avatar
Bill Haneman committed
268
269
270
                                                            gint            x,
                                                            gint            y,
                                                            gint            width,
271
272
                                                            gint            height,
                                                            AtkCoordType    coord_type);
273
ATK_AVAILABLE_IN_ALL
274
gboolean              atk_component_set_position           (AtkComponent    *component,
Bill Haneman's avatar
Bill Haneman committed
275
                                                            gint            x,
276
277
                                                            gint            y,
                                                            AtkCoordType    coord_type);
278
ATK_AVAILABLE_IN_ALL
279
gboolean              atk_component_set_size               (AtkComponent    *component,
Bill Haneman's avatar
Bill Haneman committed
280
281
                                                            gint            width,
                                                            gint            height);
282
ATK_AVAILABLE_IN_ALL
283
gdouble               atk_component_get_alpha              (AtkComponent    *component);
Bill Haneman's avatar
Bill Haneman committed
284

285
286
287
288
289
290
291
292
293
294
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);

295
G_END_DECLS
Bill Haneman's avatar
Bill Haneman committed
296
297

#endif /* __ATK_COMPONENT_H__ */