Changed IDL for State, Component, and Image to reduce use of out params.
[platform/core/uifw/at-spi2-atk.git] / cspi / spi_component.c
index 247a810..73f1556 100644 (file)
@@ -4,6 +4,8 @@
  *
  */
 
+#include <cspi/spi-private.h>
+
 /**
  * AccessibleComponent_ref:
  * @obj: a pointer to an object implementing #AccessibleComponent on which to operate.
@@ -16,7 +18,7 @@
 int
 AccessibleComponent_ref (AccessibleComponent *obj)
 {
-  Accessibility_Component_ref (*obj, &ev);
+  cspi_object_ref (obj);
   return 0;
 }
 
@@ -32,7 +34,7 @@ AccessibleComponent_ref (AccessibleComponent *obj)
 int
 AccessibleComponent_unref (AccessibleComponent *obj)
 {
-  Accessibility_Component_unref (*obj, &ev);
+  cspi_object_unref (obj);
   return 0;
 }
 
@@ -42,22 +44,24 @@ AccessibleComponent_unref (AccessibleComponent *obj)
  * @x: a #long specifying the x coordinate in question.
  * @y: a #long specifying the y coordinate in question.
  * @ctype: the desired coordinate system of the point (@x, @y)
- *         (e.g. COORD_TYPE_WINDOW, COORD_TYPE_SCREEN).
+ *         (e.g. CSPI_COORD_TYPE_WINDOW, CSPI_COORD_TYPE_SCREEN).
  *
  * Query whether a given #AccessibleComponent contains a particular point.
  *
+ * Returns: a #TRUE if the specified component contains the point (@x, @y),
+ *          otherwise #FALSE.
  **/
-boolean
+SPIBoolean
 AccessibleComponent_contains (AccessibleComponent *obj,
-                              long x,
-                              long y,
+                              long int x,
+                              long int y,
                               AccessibleCoordType ctype)
 {
-  return Accessibility_Component_contains (*obj,
+  return Accessibility_Component_contains (CSPI_OBJREF (obj),
                                            (CORBA_long) x,
                                            (CORBA_long) y,
                                            ctype,
-                                           &ev);
+                                           cspi_ev ());
 }
 
 /**
@@ -66,7 +70,7 @@ AccessibleComponent_contains (AccessibleComponent *obj,
  * @x: a #long specifying the x coordinate of the point in question.
  * @y: a #long specifying the y coordinate of the point in question.
  * @ctype: the coordinate system of the point (@x, @y)
- *         (e.g. COORD_TYPE_WINDOW, COORD_TYPE_SCREEN).
+ *         (e.g. CSPI_COORD_TYPE_WINDOW, CSPI_COORD_TYPE_SCREEN).
  *
  * Get the accessible child at a given coordinate within an #AccessibleComponent.
  *
@@ -75,17 +79,18 @@ AccessibleComponent_contains (AccessibleComponent *obj,
  **/
 Accessible *
 AccessibleComponent_getAccessibleAtPoint (AccessibleComponent *obj,
-                                          long x,
-                                          long y,
+                                          long int x,
+                                          long int y,
                                           AccessibleCoordType ctype)
 {
-  Accessible child;
-  child = Accessibility_Component_getAccessibleAtPoint(*obj,
+  Accessibility_Accessible child;
+
+  child = Accessibility_Component_getAccessibleAtPoint(CSPI_OBJREF (obj),
                                                        (CORBA_long) x,
                                                        (CORBA_long) y,
                                                        ctype,
-                                                       &ev);
-  return (child != NULL) ? Obj_Add (child) : NULL;
+                                                       cspi_ev ());
+  return cspi_object_add (child);
 }
 
 /**
@@ -96,32 +101,28 @@ AccessibleComponent_getAccessibleAtPoint (AccessibleComponent *obj,
  * @width: a pointer to a #long into which the x extents (width) will be returned.
  * @height: a pointer to a #long into which the y extents (height) will be returned.
  * @ctype: the desired coordinate system into which to return the results,
- *         (e.g. COORD_TYPE_WINDOW, COORD_TYPE_SCREEN).
+ *         (e.g. CSPI_COORD_TYPE_WINDOW, CSPI_COORD_TYPE_SCREEN).
  *
  * Get the bounding box of the specified #AccessibleComponent.
  *
  **/
 void
 AccessibleComponent_getExtents (AccessibleComponent *obj,
-                                long *x,
-                                long *y,
-                                long *width,
-                                long *height,
+                                long int *x,
+                                long int *y,
+                                long int *width,
+                                long int *height,
                                 AccessibleCoordType ctype)
 {
-  CORBA_long cx, cy, cw, ch;   
-  Accessibility_Component_getExtents (*obj,
-                                      &cx,
-                                      &cy,
-                                      &cw,
-                                      &ch,
-                                     ctype,
-                                     &ev);
-  spi_warn_ev (&ev, "AccessibleComponent_getExtents");
-  *x = (long) cx;
-  *y = (long) cy;
-  *width = (long) cw;
-  *height = (long) ch;
+  Accessibility_BoundingBox bbox;
+  bbox = Accessibility_Component_getExtents (CSPI_OBJREF (obj),
+                                            ctype,
+                                            cspi_ev ());
+  cspi_warn_ev (cspi_ev (), "AccessibleComponent_getExtents");
+  *x = bbox.x;
+  *y = bbox.y;
+  *width = bbox.width;
+  *height = bbox.height;
 }
 
 /**
@@ -130,22 +131,22 @@ AccessibleComponent_getExtents (AccessibleComponent *obj,
  * @x: a pointer to a #long into which the minimum x coordinate will be returned.
  * @y: a pointer to a #long into which the minimum y coordinate will be returned.
  * @ctype: the desired coordinate system into which to return the results,
- *         (e.g. COORD_TYPE_WINDOW, COORD_TYPE_SCREEN).
+ *         (e.g. CSPI_COORD_TYPE_WINDOW, CSPI_COORD_TYPE_SCREEN).
  *
  * Get the minimum x and y coordinates of the specified #AccessibleComponent.
  *
  **/
 void
 AccessibleComponent_getPosition (AccessibleComponent *obj,
-                                 long *x,
-                                 long *y,
+                                 long int *x,
+                                 long int *y,
                                  AccessibleCoordType ctype)
 {
-  Accessibility_Component_getPosition (*obj,
+  Accessibility_Component_getPosition (CSPI_OBJREF (obj),
                                        (CORBA_long *) x,
                                        (CORBA_long *) y,
                                        ctype,
-                                       &ev);
+                                       cspi_ev ());
 }
 
 /**
@@ -159,16 +160,83 @@ AccessibleComponent_getPosition (AccessibleComponent *obj,
  **/
 void
 AccessibleComponent_getSize (AccessibleComponent *obj,
-                             long *width,
-                             long *height)
+                             long int *width,
+                             long int *height)
 {
-  Accessibility_Component_getSize (*obj,
+  Accessibility_Component_getSize (CSPI_OBJREF (obj),
                                    (CORBA_long *) width,
                                    (CORBA_long *) height,
-                                   &ev);
+                                   cspi_ev ());
+}
+
+/**
+ * AccessibleComponent_getLayer:
+ * @obj: a pointer to the #AccessibleComponent to query.
+ *
+ * Query which layer the component is painted into, to help determine its 
+ *      visibility in terms of stacking order.
+ *
+ * Returns: the #AccessibleComponentLayer into which this component is painted.
+ **/
+AccessibleComponentLayer
+AccessibleComponent_getLayer (AccessibleComponent *obj)
+{
+  Accessibility_ComponentLayer zlayer;
+  AccessibleComponentLayer retval;
+  
+  zlayer = Accessibility_Component_getLayer (CSPI_OBJREF (obj),
+                                             cspi_ev ());
+  switch (retval)
+    {
+    case Accessibility_LAYER_BACKGROUND:
+      retval = SPI_LAYER_BACKGROUND;
+      break;
+    case Accessibility_LAYER_CANVAS:     
+      retval = SPI_LAYER_CANVAS;
+      break;
+    case Accessibility_LAYER_WIDGET:     
+      retval = SPI_LAYER_WIDGET;
+      break;
+    case Accessibility_LAYER_MDI:        
+      retval = SPI_LAYER_MDI;
+      break;
+    case Accessibility_LAYER_POPUP:      
+      retval = SPI_LAYER_POPUP;
+      break;
+    case Accessibility_LAYER_OVERLAY:    
+      retval = SPI_LAYER_OVERLAY;
+      break;
+    default:
+      retval = SPI_LAYER_INVALID;
+    }
+  return retval;
+}
+
+/**
+ * AccessibleComponent_getMDIZOrder:
+ * @obj: a pointer to the #AccessibleComponent to query.
+ *
+ * Query the z stacking order of a component which is in the MDI layer.
+ *       (Bigger z-order numbers mean nearer the top)
+ *
+ * Returns: a short integer indicating the stacking order of the component 
+ *       in the MDI layer, or -1 if the component is not in the MDI layer.
+ **/
+short
+AccessibleComponent_getMDIZOrder (AccessibleComponent *obj)
+{
+  return (short) Accessibility_Component_getMDIZOrder (CSPI_OBJREF (obj),
+                                                       cspi_ev ());
 }
 
-/* Not Yet Implemented */
+/**
+ * AccessibleComponent_grabFocus:
+ * @obj: a pointer to the #AccessibleComponent on which to operate.
+ *
+ * Attempt to set the keyboard input focus to the specified
+ *         #AccessibleComponent.
+ *
+ **/
 void
 AccessibleComponent_grabFocus (AccessibleComponent *obj)
 {