2 * AT-SPI - Assistive Technology Service Provider Interface
3 * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
5 * Copyright 2001, 2002 Sun Microsystems Inc.,
6 * Copyright 2001, 2002 Ximian, Inc.
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
26 * AtspiComponent function implementations
30 #include "atspi-private.h"
33 atspi_rect_free (AtspiRect *rect)
39 atspi_rect_copy (AtspiRect *src)
41 AtspiRect *dst = g_new (AtspiRect, 1);
44 dst->height = src->height;
45 dst->width = src->width;
49 G_DEFINE_BOXED_TYPE (AtspiRect, atspi_rect, atspi_rect_copy, atspi_rect_free)
52 atspi_point_copy (AtspiPoint *src)
54 AtspiPoint *dst = g_new (AtspiPoint, 1);
60 G_DEFINE_BOXED_TYPE (AtspiPoint, atspi_point, atspi_point_copy, g_free)
63 * atspi_component_contains:
64 * @obj: a pointer to the #AtspiComponent to query.
65 * @x: a #gint specifying the x coordinate in question.
66 * @y: a #gint specifying the y coordinate in question.
67 * @ctype: the desired coordinate system of the point (@x, @y)
68 * (e.g. CSPI_COORD_TYPE_WINDOW, CSPI_COORD_TYPE_SCREEN).
70 * Queries whether a given #AtspiComponent contains a particular point.
72 * Returns: #TRUE if the specified component contains the point (@x, @y),
76 atspi_component_contains (AtspiComponent *obj,
79 AtspiCoordType ctype, GError **error)
81 dbus_bool_t retval = FALSE;
82 dbus_int32_t d_x = x, d_y = y;
83 dbus_uint32_t d_ctype = ctype;
85 g_return_val_if_fail (obj != NULL, FALSE);
87 _atspi_dbus_call (obj, atspi_interface_component, "Contains", error, "iin=>b", d_x, d_y, d_ctype, &retval);
93 * atspi_component_get_accessible_at_point:
94 * @obj: a pointer to the #AtspiComponent to query.
95 * @x: a #gint specifying the x coordinate of the point in question.
96 * @y: a #gint specifying the y coordinate of the point in question.
97 * @ctype: the coordinate system of the point (@x, @y)
98 * (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
100 * Gets the accessible child at a given coordinate within an #AtspiComponent.
102 * Returns: (transfer full): a pointer to an #AtspiAccessible child of the
103 * specified component which contains the point (@x, @y), or NULL if
104 * no child contains the point.
107 atspi_component_get_accessible_at_point (AtspiComponent *obj,
110 AtspiCoordType ctype, GError **error)
112 dbus_int32_t d_x = x, d_y = y;
113 dbus_uint32_t d_ctype = ctype;
116 g_return_val_if_fail (obj != NULL, FALSE);
118 reply = _atspi_dbus_call_partial (obj, atspi_interface_component, "GetAccessibleAtPoint", error, "iiu", d_x, d_y, d_ctype);
120 return _atspi_dbus_return_accessible_from_message (reply);
124 * atspi_component_get_extents:
125 * @obj: a pointer to the #AtspiComponent to query.
126 * @ctype: the desired coordinate system into which to return the results,
127 * (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
129 * Gets the bounding box of the specified #AtspiComponent.
131 * Returns: An #AtspiRect giving the accessible's extents.
134 atspi_component_get_extents (AtspiComponent *obj,
135 AtspiCoordType ctype, GError **error)
137 dbus_uint32_t d_ctype = ctype;
140 bbox.x = bbox.y = bbox.width = bbox.height = -1;
141 g_return_val_if_fail (obj != NULL, atspi_rect_copy (&bbox));
143 _atspi_dbus_call (obj, atspi_interface_component, "GetExtents", error, "u=>(iiii)", d_ctype, &bbox);
144 return atspi_rect_copy (&bbox);
148 * atspi_component_get_position:
149 * @obj: a pointer to the #AtspiComponent to query.
150 * @ctype: the desired coordinate system into which to return the results,
151 * (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
153 * Gets the minimum x and y coordinates of the specified #AtspiComponent.
155 * returns: An #AtspiPoint giving the @obj's position.
158 atspi_component_get_position (AtspiComponent *obj,
159 AtspiCoordType ctype, GError **error)
161 dbus_int32_t d_x, d_y;
162 dbus_uint32_t d_ctype = ctype;
168 return atspi_point_copy (&ret);
170 _atspi_dbus_call (obj, atspi_interface_component, "GetPosition", error, "u=>ii", d_ctype, &d_x, &d_y);
174 return atspi_point_copy (&ret);
178 * atspi_component_get_size:
179 * @obj: a pointer to the #AtspiComponent to query.
181 * Gets the size of the specified #AtspiComponent.
183 * returns: An #AtspiPoint giving the @obj's size.
186 atspi_component_get_size (AtspiComponent *obj, GError **error)
188 dbus_int32_t d_w, d_h;
193 return atspi_point_copy (&ret);
195 _atspi_dbus_call (obj, atspi_interface_component, "GetSize", error, "=>ii", &d_w, &d_h);
198 return atspi_point_copy (&ret);
202 * atspi_component_get_layer:
203 * @obj: a pointer to the #AtspiComponent to query.
205 * Queries which layer the component is painted into, to help determine its
206 * visibility in terms of stacking order.
208 * Returns: the #AtspiComponentLayer into which this component is painted.
211 atspi_component_get_layer (AtspiComponent *obj, GError **error)
213 dbus_uint32_t zlayer = -1;
215 _atspi_dbus_call (obj, atspi_interface_component, "GetLayer", error, "=>u", &zlayer);
221 * atspi_component_get_mdi_z_order:
222 * @obj: a pointer to the #AtspiComponent to query.
224 * Queries the z stacking order of a component which is in the MDI or window
225 * layer. (Bigger z-order numbers mean nearer the top)
227 * Returns: a #gshort indicating the stacking order of the component
228 * in the MDI layer, or -1 if the component is not in the MDI layer.
231 atspi_component_get_mdi_z_order (AtspiComponent *obj, GError **error)
233 dbus_uint16_t retval = -1;
235 _atspi_dbus_call (obj, atspi_interface_component, "GetMDIZOrder", error, "=>n", &retval);
241 * atspi_component_grab_focus:
242 * @obj: a pointer to the #AtspiComponent on which to operate.
244 * Attempts to set the keyboard input focus to the specified
247 * Returns: #TRUE if successful, #FALSE otherwise.
251 atspi_component_grab_focus (AtspiComponent *obj, GError **error)
253 dbus_bool_t retval = FALSE;
255 _atspi_dbus_call (obj, atspi_interface_component, "GrabFocus", error, "=>b", &retval);
261 * atspi_component_get_alpha:
262 * @obj: The #AtspiComponent to be queried.
264 * Gets the opacity/alpha value of a component, if alpha blending is in use.
266 * Returns: the opacity value of a component, as a #gdouble between 0.0 and 1.0.
269 atspi_component_get_alpha (AtspiComponent *obj, GError **error)
273 _atspi_dbus_call (obj, atspi_interface_component, "GetAlpha", error, "=>d", &retval);
279 * atspi_component_set_extents:
280 * @obj: a pointer to the #AtspiComponent to move.
281 * @x: the new vertical position to which the component should be moved.
282 * @y: the new horizontal position to which the component should be moved.
283 * @width: the width to which the component should be resized.
284 * @height: the height to which the component should be resized.
285 * @ctype: the coordinate system in which the position is specified.
286 * (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
288 * Moves and resizes the specified component.
290 * Returns: #TRUE if successful; #FALSE otherwise.
293 atspi_component_set_extents (AtspiComponent *obj,
298 AtspiCoordType ctype,
301 dbus_int32_t d_x = x, d_y = y, d_width = width, d_height = height;
302 dbus_uint32_t d_ctype = ctype;
303 DBusMessageIter iter, iter_struct;
304 DBusMessage *message, *reply;
305 dbus_bool_t retval = FALSE;
306 AtspiAccessible *aobj = ATSPI_ACCESSIBLE (obj);
308 g_return_val_if_fail (obj != NULL, FALSE);
310 if (!aobj->parent.app || !aobj->parent.app->bus_name)
312 g_set_error_literal (error, ATSPI_ERROR, ATSPI_ERROR_APPLICATION_GONE,
313 _("The application no longer exists"));
317 message = dbus_message_new_method_call (aobj->parent.app->bus_name,
319 atspi_interface_component,
324 dbus_message_iter_init_append (message, &iter);
325 if (!dbus_message_iter_open_container (&iter, DBUS_TYPE_STRUCT, NULL, &iter_struct))
327 dbus_message_unref (message);
330 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_INT32, &d_x);
331 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_INT32, &d_y);
332 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_INT32, &d_width);
333 dbus_message_iter_append_basic (&iter_struct, DBUS_TYPE_INT32, &d_height);
334 dbus_message_iter_close_container (&iter, &iter_struct);
335 dbus_message_iter_append_basic (&iter, DBUS_TYPE_UINT32, &d_ctype);
337 reply = _atspi_dbus_send_with_reply_and_block (message, error);
338 dbus_message_get_args (reply, NULL, DBUS_TYPE_BOOLEAN, &retval,
340 dbus_message_unref (reply);
345 * atspi_component_set_position:
346 * @obj: a pointer to the #AtspiComponent to move.
347 * @x: the new vertical position to which the component should be moved.
348 * @y: the new horizontal position to which the component should be moved.
349 * @ctype: the coordinate system in which the position is specified.
350 * (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
352 * Returns: #TRUE if successful; #FALSE otherwise.
354 * Moves the component to the specified position.
357 atspi_component_set_position (AtspiComponent *obj,
360 AtspiCoordType ctype,
363 dbus_int32_t d_x = x, d_y = y;
364 dbus_uint32_t d_ctype = ctype;
365 dbus_bool_t ret = FALSE;
367 g_return_val_if_fail (obj != NULL, FALSE);
369 _atspi_dbus_call (obj, atspi_interface_component, "SetPosition", error,
370 "iiu=>b", d_x, d_y, d_ctype, &ret);
376 * atspi_component_set_size:
377 * @obj: a pointer to the #AtspiComponent to query.
378 * @width: the width to which the component should be resized.
379 * @height: the height to which the component should be resized.
381 * Returns: #TRUE if successful; #FALSE otherwise.
383 * Resizes the specified component to the given coordinates.
386 atspi_component_set_size (AtspiComponent *obj,
391 dbus_int32_t d_width = width, d_height = height;
392 dbus_bool_t ret = FALSE;
394 g_return_val_if_fail (obj != NULL, FALSE);
396 _atspi_dbus_call (obj, atspi_interface_component, "SetSize", error, "ii=>b",
397 d_width, d_height, &ret);
403 atspi_component_base_init (AtspiComponent *klass)
408 atspi_component_get_type (void)
410 static GType type = 0;
413 static const GTypeInfo tinfo =
415 sizeof (AtspiComponent),
416 (GBaseInitFunc) atspi_component_base_init,
417 (GBaseFinalizeFunc) NULL,
420 type = g_type_register_static (G_TYPE_INTERFACE, "AtspiComponent", &tinfo, 0);