atspi/atspi-component.c

   1 /*
   2  * AT-SPI - Assistive Technology Service Provider Interface
   3  * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
   4  *
   5  * Copyright 2001, 2002 Sun Microsystems Inc.,
   6  * Copyright 2001, 2002 Ximian, Inc.
   7  *
   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.
  12  *
  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.
  17  *
  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.
  22  */
  23
  24 /*
  25  *
  26  * AtspiComponent function implementations
  27  *
  28  */
  29
  30 #include "atspi-private.h"
  31
  32 void
  33 atspi_rect_free (AtspiRect *rect)
  34 {
  35   g_free (rect);
  36 }
  37
  38 AtspiRect *
  39 atspi_rect_copy (AtspiRect *src)
  40 {
  41   AtspiRect *dst = g_new (AtspiRect, 1);
  42   if (dst)
  43   {
  44     dst->x = src->x;
  45     dst->y = src->y;
  46     dst->height = src->height;
  47     dst->width = src->width;
  48   }
  49   return dst;
  50 }
  51
  52 G_DEFINE_BOXED_TYPE (AtspiRect, atspi_rect, atspi_rect_copy, atspi_rect_free)
  53
  54 AtspiPoint *
  55 atspi_point_copy (AtspiPoint *src)
  56 {
  57   AtspiPoint *dst = g_new (AtspiPoint, 1);
  58   if (dst)
  59   {
  60     dst->x = src->x;
  61     dst->y = src->y;
  62   }
  63   return dst;
  64 }
  65
  66 G_DEFINE_BOXED_TYPE (AtspiPoint, atspi_point, atspi_point_copy, g_free)
  67
  68 /**
  69  * atspi_component_contains:
  70  * @obj: a pointer to the #AtspiComponent to query.
  71  * @x: a #long specifying the x coordinate in question.
  72  * @y: a #long specifying the y coordinate in question.
  73  * @ctype: the desired coordinate system of the point (@x, @y)
  74  *         (e.g. CSPI_COORD_TYPE_WINDOW, CSPI_COORD_TYPE_SCREEN).
  75  *
  76  * Query whether a given #AtspiComponent contains a particular point.
  77  *
  78  * Returns: a #TRUE if the specified component contains the point (@x, @y),
  79  *          otherwise #FALSE.
  80  **/
  81 gboolean
  82 atspi_component_contains (AtspiComponent *obj,
  83                               gint x,
  84                               gint y,
  85                               AtspiCoordType ctype, GError **error)
  86 {
  87   dbus_bool_t retval = FALSE;
  88   dbus_int32_t d_x = x, d_y = y;
  89   dbus_uint32_t d_ctype = ctype;
  90
  91   g_return_val_if_fail (obj != NULL, FALSE);
  92
  93   _atspi_dbus_call (obj, atspi_interface_component, "Contains", error, "iin=>b", d_x, d_y, d_ctype, &retval);
  94
  95   return retval;
  96 }
  97
  98 /**
  99  * atspi_component_get_accessible_at_point:
 100  * @obj: a pointer to the #AtspiComponent to query.
 101  * @x: a #gint specifying the x coordinate of the point in question.
 102  * @y: a #gint specifying the y coordinate of the point in question.
 103  * @ctype: the coordinate system of the point (@x, @y)
 104  *         (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
 105  *
 106  * Get the accessible child at a given coordinate within an #AtspiComponent.
 107  *
 108  * Returns: (transfer full): a pointer to an #AtspiAccessible child of the
 109  *          specified component which contains the point (@x, @y), or NULL of
 110  *         no child contains the point.
 111  **/
 112 AtspiAccessible *
 113 atspi_component_get_accessible_at_point (AtspiComponent *obj,
 114                                           gint x,
 115                                           gint y,
 116                                           AtspiCoordType ctype, GError **error)
 117 {
 118   dbus_int32_t d_x = x, d_y = y;
 119   dbus_uint16_t d_ctype = ctype;
 120   DBusMessage *reply;
 121   char *path = NULL;
 122   AtspiAccessible *retval = NULL;
 123
 124   g_return_val_if_fail (obj != NULL, FALSE);
 125
 126   reply = _atspi_dbus_call_partial (obj, atspi_interface_component, "GetAccessibleAtPoint", error, "iin", d_x, d_y, d_ctype);
 127
 128   return _atspi_dbus_return_accessible_from_message (reply);
 129 }
 130
 131 /**
 132  * atspi_component_get_extents:
 133  * @obj: a pointer to the #AtspiComponent to query.
 134  * @ctype: the desired coordinate system into which to return the results,
 135  *         (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
 136  *
 137  * Returns: A #AtspiRect giving the accessible's extents.
 138  *
 139  * Get the bounding box of the specified #AtspiComponent.
 140  *
 141  **/
 142 AtspiRect *
 143 atspi_component_get_extents (AtspiComponent *obj,
 144                                 AtspiCoordType ctype, GError **error)
 145 {
 146   dbus_uint32_t d_ctype = ctype;
 147   AtspiRect bbox;
 148
 149   bbox.x = bbox.y = bbox.width = bbox.height = -1;
 150   g_return_val_if_fail (obj != NULL, atspi_rect_copy (&bbox));
 151
 152   _atspi_dbus_call (obj, atspi_interface_component, "GetExtents", error, "u=>(iiii)", d_ctype, &bbox);
 153   return atspi_rect_copy (&bbox);
 154 }
 155
 156 /**
 157  * atspi_component_get_position:
 158  * @obj: a pointer to the #AtspiComponent to query.
 159  * @ctype: the desired coordinate system into which to return the results,
 160  *         (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
 161  *
 162  * returns: A #AtspiPoint giving the position.
 163  * Get the minimum x and y coordinates of the specified #AtspiComponent.
 164  *
 165  **/
 166 AtspiPoint *
 167 atspi_component_get_position (AtspiComponent *obj,
 168                                  AtspiCoordType ctype, GError **error)
 169 {
 170   dbus_int32_t d_x, d_y;
 171   dbus_uint16_t d_ctype = ctype;
 172   AtspiPoint ret;
 173
 174   ret.x = ret.y = -1;
 175
 176   if (!obj)
 177     return atspi_point_copy (&ret);
 178
 179   _atspi_dbus_call (obj, atspi_interface_component, "GetPosition", error, "u=>ii", d_ctype, &d_x, &d_y);
 180
 181   ret.x = d_x;
 182   ret.y = d_y;
 183   return atspi_point_copy (&ret);
 184 }
 185
 186 /**
 187  * atspi_component_get_size:
 188  * @obj: a pointer to the #AtspiComponent to query.
 189  * returns: A #AtspiPoint giving the size.
 190  *
 191  * Get the size of the specified #AtspiComponent.
 192  *
 193  **/
 194 AtspiPoint *
 195 atspi_component_get_size (AtspiComponent *obj, GError **error)
 196 {
 197   dbus_int32_t d_w, d_h;
 198   AtspiPoint ret;
 199
 200   ret.x = ret.y = -1;
 201   if (!obj)
 202     return atspi_point_copy (&ret);
 203
 204   _atspi_dbus_call (obj, atspi_interface_component, "GetSize", error, "=>ii", &d_w, &d_h);
 205   ret.x = d_w;
 206   ret.y = d_h;
 207   return atspi_point_copy (&ret);
 208 }
 209
 210 /**
 211  * atspi_component_get_layer:
 212  * @obj: a pointer to the #AtspiComponent to query.
 213  *
 214  * Query which layer the component is painted into, to help determine its
 215  *      visibility in terms of stacking order.
 216  *
 217  * Returns: the #AtspiComponentLayer into which this component is painted.
 218  **/
 219 AtspiComponentLayer
 220 atspi_component_get_layer (AtspiComponent *obj, GError **error)
 221 {
 222   dbus_uint32_t zlayer = -1;
 223
 224   _atspi_dbus_call (obj, atspi_interface_component, "GetLayer", error, "=>u", &zlayer);
 225
 226   return zlayer;
 227 }
 228
 229 /**
 230  * atspi_component_get_mdi_z_order:
 231  * @obj: a pointer to the #AtspiComponent to query.
 232  *
 233  * Query the z stacking order of a component which is in the MDI or window
 234  *       layer. (Bigger z-order numbers mean nearer the top)
 235  *
 236  * Returns: a short integer indicating the stacking order of the component
 237  *       in the MDI layer, or -1 if the component is not in the MDI layer.
 238  **/
 239 gshort
 240 atspi_component_get_mdi_z_order (AtspiComponent *obj, GError **error)
 241 {
 242   dbus_uint16_t retval = -1;
 243
 244   _atspi_dbus_call (obj, atspi_interface_component, "GetMDIZOrder", error, "=>n", &retval);
 245
 246   return retval;
 247 }
 248
 249 /**
 250  * atspi_component_grab_focus:
 251  * @obj: a pointer to the #AtspiComponent on which to operate.
 252  *
 253  * Attempt to set the keyboard input focus to the specified
 254  *         #AtspiComponent.
 255  *
 256  * Returns: #TRUE if successful, #FALSE otherwise.
 257  *
 258  **/
 259 gboolean
 260 atspi_component_grab_focus (AtspiComponent *obj, GError **error)
 261 {
 262   dbus_bool_t retval = FALSE;
 263
 264   _atspi_dbus_call (obj, atspi_interface_component, "GrabFocus", error, "=>b", &retval);
 265
 266   return retval;
 267 }
 268
 269 /**
 270  * atspi_component_get_alpha:
 271  * @obj: The #AtspiComponent to be queried.
 272  *
 273  * Get the opacity/alpha value of a component, if alpha blending is in use.
 274  *
 275  * Returns: the opacity value of a component, as a double between 0.0 and 1.0.
 276  **/
 277 gdouble
 278 atspi_component_get_alpha    (AtspiComponent *obj, GError **error)
 279 {
 280   double retval = 1;
 281
 282   _atspi_dbus_call (obj, atspi_interface_component, "GetAlpha", error, "=>d", &retval);
 283
 284   return retval;
 285 }
 286
 287 static void
 288 atspi_component_base_init (AtspiComponent *klass)
 289 {
 290 }
 291
 292 GType
 293 atspi_component_get_type (void)
 294 {
 295   static GType type = 0;
 296
 297   if (!type) {
 298     static const GTypeInfo tinfo =
 299     {
 300       sizeof (AtspiComponent),
 301       (GBaseInitFunc) atspi_component_base_init,
 302       (GBaseFinalizeFunc) NULL,
 303     };
 304
 305     type = g_type_register_static (G_TYPE_INTERFACE, "AtspiComponent", &tinfo, 0);
 306
 307   }
 308   return type;
 309 }