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 Lesser 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 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser 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.
22 #include "atkcomponent.h"
25 * SECTION:atkcomponent
26 * @Short_description: The ATK interface provided by UI components
27 * which occupy a physical area on the screen.
28 * which the user can activate/interact with.
31 * #AtkComponent should be implemented by most if not all UI elements
32 * with an actual on-screen presence, i.e. components which can be
33 * said to have a screen-coordinate bounding box. Virtually all
34 * widgets will need to have #AtkComponent implementations provided
35 * for their corresponding #AtkObject class. In short, only UI
36 * elements which are *not* GUI elements will omit this ATK interface.
38 * A possible exception might be textual information with a
39 * transparent background, in which case text glyph bounding box
40 * information is provided by #AtkText.
48 static void atk_component_base_init (AtkComponentIface *class);
50 static gboolean atk_component_real_contains (AtkComponent *component,
53 AtkCoordType coord_type);
55 static AtkObject* atk_component_real_ref_accessible_at_point (AtkComponent *component,
58 AtkCoordType coord_type);
60 static void atk_component_real_get_position (AtkComponent *component,
63 AtkCoordType coord_type);
65 static void atk_component_real_get_size (AtkComponent *component,
69 static guint atk_component_signals[LAST_SIGNAL] = { 0 };
72 atk_component_get_type (void)
74 static GType type = 0;
77 static const GTypeInfo tinfo =
79 sizeof (AtkComponentIface),
80 (GBaseInitFunc) atk_component_base_init,
81 (GBaseFinalizeFunc) NULL,
85 type = g_type_register_static (G_TYPE_INTERFACE, "AtkComponent", &tinfo, 0);
92 atk_component_base_init (AtkComponentIface *class)
94 static gboolean initialized = FALSE;
98 class->ref_accessible_at_point = atk_component_real_ref_accessible_at_point;
99 class->contains = atk_component_real_contains;
100 class->get_position = atk_component_real_get_position;
101 class->get_size = atk_component_real_get_size;
105 * AtkComponent::bounds-changed:
106 * @atkcomponent: the object which received the signal.
107 * @arg1: The AtkRectangle giving the new position and size.
109 * The 'bounds-changed" signal is emitted when the bposition or
110 * size of the component changes.
112 atk_component_signals[BOUNDS_CHANGED] =
113 g_signal_new ("bounds_changed",
116 G_STRUCT_OFFSET (AtkComponentIface, bounds_changed),
117 (GSignalAccumulator) NULL, NULL,
118 g_cclosure_marshal_VOID__BOXED,
120 ATK_TYPE_RECTANGLE | G_SIGNAL_TYPE_STATIC_SCOPE);
128 * atk_component_add_focus_handler:
129 * @component: The #AtkComponent to attach the @handler to
130 * @handler: The #AtkFocusHandler to be attached to @component
132 * Add the specified handler to the set of functions to be called
133 * when this object receives focus events (in or out). If the handler is
134 * already added it is not added again
136 * Deprecated: This method is deprecated since ATK version 2.9.4. If
137 * you need to track when an object gains or lose the focus, use
138 * state-changed:focused notification instead.
140 * Returns: a handler id which can be used in atk_component_remove_focus_handler()
141 * or zero if the handler was already added.
144 atk_component_add_focus_handler (AtkComponent *component,
145 AtkFocusHandler handler)
147 AtkComponentIface *iface = NULL;
148 g_return_val_if_fail (ATK_IS_COMPONENT (component), 0);
150 iface = ATK_COMPONENT_GET_IFACE (component);
152 if (iface->add_focus_handler)
153 return (iface->add_focus_handler) (component, handler);
159 * atk_component_remove_focus_handler:
160 * @component: the #AtkComponent to remove the focus handler from
161 * @handler_id: the handler id of the focus handler to be removed
164 * Remove the handler specified by @handler_id from the list of
165 * functions to be executed when this object receives focus events
168 * Deprecated: This method is deprecated since ATK version 2.9.4. If
169 * you need to track when an object gains or lose the focus, use
170 * state-changed:focused notification instead.
174 atk_component_remove_focus_handler (AtkComponent *component,
177 AtkComponentIface *iface = NULL;
178 g_return_if_fail (ATK_IS_COMPONENT (component));
180 iface = ATK_COMPONENT_GET_IFACE (component);
182 if (iface->remove_focus_handler)
183 (iface->remove_focus_handler) (component, handler_id);
187 * atk_component_contains:
188 * @component: the #AtkComponent
191 * @coord_type: specifies whether the coordinates are relative to the screen
192 * or to the components top level window
194 * Checks whether the specified point is within the extent of the @component.
196 * Toolkit implementor note: ATK provides a default implementation for
197 * this virtual method. In general there are little reason to
200 * Returns: %TRUE or %FALSE indicating whether the specified point is within
201 * the extent of the @component or not
204 atk_component_contains (AtkComponent *component,
207 AtkCoordType coord_type)
209 AtkComponentIface *iface = NULL;
210 g_return_val_if_fail (ATK_IS_COMPONENT (component), FALSE);
212 iface = ATK_COMPONENT_GET_IFACE (component);
215 return (iface->contains) (component, x, y, coord_type);
221 * atk_component_ref_accessible_at_point:
222 * @component: the #AtkComponent
225 * @coord_type: specifies whether the coordinates are relative to the screen
226 * or to the components top level window
228 * Gets a reference to the accessible child, if one exists, at the
229 * coordinate point specified by @x and @y.
231 * Returns: (transfer full): a reference to the accessible child, if one exists
234 atk_component_ref_accessible_at_point (AtkComponent *component,
237 AtkCoordType coord_type)
239 AtkComponentIface *iface = NULL;
240 g_return_val_if_fail (ATK_IS_COMPONENT (component), NULL);
242 iface = ATK_COMPONENT_GET_IFACE (component);
244 if (iface->ref_accessible_at_point)
245 return (iface->ref_accessible_at_point) (component, x, y, coord_type);
251 * atk_component_get_extents:
252 * @component: an #AtkComponent
253 * @x: address of #gint to put x coordinate
254 * @y: address of #gint to put y coordinate
255 * @width: address of #gint to put width
256 * @height: address of #gint to put height
257 * @coord_type: specifies whether the coordinates are relative to the screen
258 * or to the components top level window
260 * Gets the rectangle which gives the extent of the @component.
264 atk_component_get_extents (AtkComponent *component,
269 AtkCoordType coord_type)
271 AtkComponentIface *iface = NULL;
272 gint local_x, local_y, local_width, local_height;
273 gint *real_x, *real_y, *real_width, *real_height;
275 g_return_if_fail (ATK_IS_COMPONENT (component));
288 real_width = &local_width;
290 real_height = height;
292 real_height = &local_height;
294 iface = ATK_COMPONENT_GET_IFACE (component);
296 if (iface->get_extents)
297 (iface->get_extents) (component, real_x, real_y, real_width, real_height, coord_type);
301 * atk_component_get_position:
302 * @component: an #AtkComponent
303 * @x: address of #gint to put x coordinate position
304 * @y: address of #gint to put y coordinate position
305 * @coord_type: specifies whether the coordinates are relative to the screen
306 * or to the components top level window
308 * Gets the position of @component in the form of
309 * a point specifying @component's top-left corner.
311 * Deprecated: Since 2.12. Use atk_component_get_extents() instead.
314 atk_component_get_position (AtkComponent *component,
317 AtkCoordType coord_type)
319 AtkComponentIface *iface = NULL;
320 gint local_x, local_y;
321 gint *real_x, *real_y;
323 g_return_if_fail (ATK_IS_COMPONENT (component));
334 iface = ATK_COMPONENT_GET_IFACE (component);
336 if (iface->get_position)
337 (iface->get_position) (component, real_x, real_y, coord_type);
341 * atk_component_get_size:
342 * @component: an #AtkComponent
343 * @width: address of #gint to put width of @component
344 * @height: address of #gint to put height of @component
346 * Gets the size of the @component in terms of width and height.
348 * Deprecated: Since 2.12. Use atk_component_get_extents() instead.
351 atk_component_get_size (AtkComponent *component,
355 AtkComponentIface *iface = NULL;
356 gint local_width, local_height;
357 gint *real_width, *real_height;
359 g_return_if_fail (ATK_IS_COMPONENT (component));
364 real_width = &local_width;
366 real_height = height;
368 real_height = &local_height;
370 g_return_if_fail (ATK_IS_COMPONENT (component));
372 iface = ATK_COMPONENT_GET_IFACE (component);
375 (iface->get_size) (component, real_width, real_height);
379 * atk_component_get_layer:
380 * @component: an #AtkComponent
382 * Gets the layer of the component.
384 * Returns: an #AtkLayer which is the layer of the component
387 atk_component_get_layer (AtkComponent *component)
389 AtkComponentIface *iface;
391 g_return_val_if_fail (ATK_IS_COMPONENT (component), ATK_LAYER_INVALID);
393 iface = ATK_COMPONENT_GET_IFACE (component);
394 if (iface->get_layer)
395 return (iface->get_layer) (component);
397 return ATK_LAYER_WIDGET;
401 * atk_component_get_mdi_zorder:
402 * @component: an #AtkComponent
404 * Gets the zorder of the component. The value G_MININT will be returned
405 * if the layer of the component is not ATK_LAYER_MDI or ATK_LAYER_WINDOW.
407 * Returns: a gint which is the zorder of the component, i.e. the depth at
408 * which the component is shown in relation to other components in the same
412 atk_component_get_mdi_zorder (AtkComponent *component)
414 AtkComponentIface *iface;
416 g_return_val_if_fail (ATK_IS_COMPONENT (component), G_MININT);
418 iface = ATK_COMPONENT_GET_IFACE (component);
419 if (iface->get_mdi_zorder)
420 return (iface->get_mdi_zorder) (component);
426 * atk_component_get_alpha:
427 * @component: an #AtkComponent
429 * Returns the alpha value (i.e. the opacity) for this
430 * @component, on a scale from 0 (fully transparent) to 1.0
433 * Returns: An alpha value from 0 to 1.0, inclusive.
437 atk_component_get_alpha (AtkComponent *component)
439 AtkComponentIface *iface;
441 g_return_val_if_fail (ATK_IS_COMPONENT (component), G_MININT);
443 iface = ATK_COMPONENT_GET_IFACE (component);
444 if (iface->get_alpha)
445 return (iface->get_alpha) (component);
447 return (gdouble) 1.0;
451 * atk_component_grab_focus:
452 * @component: an #AtkComponent
454 * Grabs focus for this @component.
456 * Returns: %TRUE if successful, %FALSE otherwise.
459 atk_component_grab_focus (AtkComponent *component)
461 AtkComponentIface *iface = NULL;
462 g_return_val_if_fail (ATK_IS_COMPONENT (component), FALSE);
464 iface = ATK_COMPONENT_GET_IFACE (component);
466 if (iface->grab_focus)
467 return (iface->grab_focus) (component);
473 * atk_component_set_extents:
474 * @component: an #AtkComponent
477 * @width: width to set for @component
478 * @height: height to set for @component
479 * @coord_type: specifies whether the coordinates are relative to the screen
480 * or to the components top level window
482 * Sets the extents of @component.
484 * Returns: %TRUE or %FALSE whether the extents were set or not
487 atk_component_set_extents (AtkComponent *component,
492 AtkCoordType coord_type)
494 AtkComponentIface *iface = NULL;
495 g_return_val_if_fail (ATK_IS_COMPONENT (component), FALSE);
497 iface = ATK_COMPONENT_GET_IFACE (component);
499 if (iface->set_extents)
500 return (iface->set_extents) (component, x, y, width, height, coord_type);
506 * atk_component_set_position:
507 * @component: an #AtkComponent
510 * @coord_type: specifies whether the coordinates are relative to the screen
511 * or to the components top level window
513 * Sets the postition of @component.
515 * Returns: %TRUE or %FALSE whether or not the position was set or not
518 atk_component_set_position (AtkComponent *component,
521 AtkCoordType coord_type)
523 AtkComponentIface *iface = NULL;
524 g_return_val_if_fail (ATK_IS_COMPONENT (component), FALSE);
526 iface = ATK_COMPONENT_GET_IFACE (component);
528 if (iface->set_position)
529 return (iface->set_position) (component, x, y, coord_type);
535 * atk_component_set_size:
536 * @component: an #AtkComponent
537 * @width: width to set for @component
538 * @height: height to set for @component
540 * Set the size of the @component in terms of width and height.
542 * Returns: %TRUE or %FALSE whether the size was set or not
545 atk_component_set_size (AtkComponent *component,
549 AtkComponentIface *iface = NULL;
550 g_return_val_if_fail (ATK_IS_COMPONENT (component), FALSE);
552 iface = ATK_COMPONENT_GET_IFACE (component);
555 return (iface->set_size) (component, x, y);
561 atk_component_real_contains (AtkComponent *component,
564 AtkCoordType coord_type)
566 gint real_x, real_y, width, height;
568 real_x = real_y = width = height = 0;
570 atk_component_get_extents (component, &real_x, &real_y, &width, &height, coord_type);
573 (x < real_x + width) &&
575 (y < real_y + height))
582 atk_component_real_ref_accessible_at_point (AtkComponent *component,
585 AtkCoordType coord_type)
589 count = atk_object_get_n_accessible_children (ATK_OBJECT (component));
591 for (i = 0; i < count; i++)
595 obj = atk_object_ref_accessible_child (ATK_OBJECT (component), i);
599 if (atk_component_contains (ATK_COMPONENT (obj), x, y, coord_type))
605 g_object_unref (obj);
613 atk_component_real_get_position (AtkComponent *component,
616 AtkCoordType coord_type)
620 atk_component_get_extents (component, x, y, &width, &height, coord_type);
624 atk_component_real_get_size (AtkComponent *component,
629 AtkCoordType coord_type;
632 * Pick one coordinate type; it does not matter for size
634 coord_type = ATK_XY_WINDOW;
636 atk_component_get_extents (component, &x, &y, width, height, coord_type);
639 static AtkRectangle *
640 atk_rectangle_copy (const AtkRectangle *rectangle)
642 AtkRectangle *result = g_new (AtkRectangle, 1);
643 *result = *rectangle;
649 atk_rectangle_get_type (void)
651 static GType our_type = 0;
654 our_type = g_boxed_type_register_static ("AtkRectangle",
655 (GBoxedCopyFunc)atk_rectangle_copy,
656 (GBoxedFreeFunc)g_free);