Add atk-bridge
[platform/core/uifw/at-spi2-atk.git] / cspi / spi_image.c
index a4ede04..94d78ad 100644 (file)
-#include "spi-util.h"
-
-
-int
+/*
+ * AT-SPI - Assistive Technology Service Provider Interface
+ * (Gnome Accessibility Project; http://developer.gnome.org/projects/gap)
+ *
+ * Copyright 2001, 2002 Sun Microsystems Inc.,
+ * Copyright 2001, 2002 Ximian, 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
+ * License along with this library; if not, write to the
+ * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ * Boston, MA 02111-1307, USA.
+ */
+
+#include <cspi/spi-private.h>
+
+/**
+ * AccessibleImage_ref:
+ * @obj: a pointer to the #AccessibleImage implementor on which to operate.
+ *
+ * Increment the reference count for an #AccessibleImage object.
+ **/
+void
 AccessibleImage_ref (AccessibleImage *obj)
 {
-  Accessibility_Image_ref (*obj, &ev);
-  return 0;
+  cspi_object_ref (obj);
 }
 
-
-
-int
+/**
+ * AccessibleImage_unref:
+ * @obj: a pointer to the #AccessibleImage implementor on which to operate.
+ *
+ * Decrement the reference count for an #AccessibleImage object.
+ **/
+void
 AccessibleImage_unref (AccessibleImage *obj)
 {
-  Accessibility_Image_unref (*obj, &ev);
-  return 0;
+  cspi_object_unref (obj);
 }
 
-
-
+/**
+ * AccessibleImage_getImageDescription:
+ * @obj: a pointer to the #AccessibleImage implementor on which to operate.
+ *
+ * Get the description of the image displayed in an #AccessibleImage object.
+ *
+ * Returns: a UTF-8 string describing the image.
+ **/
 char *
 AccessibleImage_getImageDescription (AccessibleImage *obj)
 {
-  return string_from_corba_string (
-                                  Accessibility_Image__get_imageDescription (*obj, &ev));
-}
+  char *retval;
 
+  cspi_return_val_if_fail (obj != NULL, NULL);
 
+  retval = 
+    Accessibility_Image__get_imageDescription (CSPI_OBJREF (obj),
+                                              cspi_ev ());
+
+  cspi_return_val_if_ev ("getImageDescription", NULL);
+
+  return retval;
+}
 
+/**
+ * AccessibleImage_getImageSize:
+ * @obj: a pointer to the #AccessibleImage to query.
+ * @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.
+ *
+ * Get the size of the image displayed in a specified #AccessibleImage object.
+ **/
 void
 AccessibleImage_getImageSize (AccessibleImage *obj,
-                              long *width,
-                              long *height)
+                              long int *width,
+                              long int *height)
 {
-  Accessibility_Image_getImageSize (*obj,
-                                   (CORBA_long *) width, (CORBA_long *) height, &ev);
+  CORBA_long w, h;
+
+  cspi_return_if_fail (obj != NULL);
+
+  Accessibility_Image_getImageSize (CSPI_OBJREF (obj),
+                                   &w, &h, cspi_ev ());
+
+  if (!cspi_check_ev ("getImageSize"))
+    {
+      *width = 0;
+      *height = 0;
+    }
+  else
+    {
+      *width = w;
+      *height = h;
+    }
 }
 
-
-
+/**
+ * AccessibleImage_getImagePosition:
+ * @obj: a pointer to the #AccessibleImage implementor to query.
+ * @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. SPI_COORD_TYPE_WINDOW, SPI_COORD_TYPE_SCREEN).
+ *
+ * Get the minimum x and y coordinates of the image displayed in a
+ *         specified #AccessibleImage implementor.
+ **/
 void
 AccessibleImage_getImagePosition (AccessibleImage *obj,
                                   long *x,
                                   long *y,
                                   AccessibleCoordType ctype)
 {
-  Accessibility_Image_getImagePosition (*obj,
-                                       (CORBA_long *) x, (CORBA_long *) y, (CORBA_short) ctype,
-                                       &ev);
+  CORBA_long cx, cy;
+
+  cspi_return_if_fail (obj != NULL);
+
+  Accessibility_Image_getImagePosition (CSPI_OBJREF (obj),
+                                       &cx, &cy, ctype, cspi_ev ());
+
+  if (!cspi_check_ev ("getImagePosition"))
+    {
+      *x = 0;
+      *y = 0;
+    }
+  else
+    {
+      *x = cx;
+      *y = cy;
+    }
+}
+
+/**
+ * AccessibleImage_getImageExtents:
+ * @obj: a pointer to the #AccessibleImage implementor to query.
+ * @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.
+ * @width: a pointer to a #long into which the image x extent will be returned.
+ * @height: a pointer to a #long into which the image y extent will be returned.
+ * @ctype: the desired coordinate system into which to return the results,
+ *         (e.g. SPI_COORD_TYPE_WINDOW, SPI_COORD_TYPE_SCREEN).
+ *
+ * Get the bounding box of the image displayed in a
+ *         specified #AccessibleImage implementor.
+ **/
+void
+AccessibleImage_getImageExtents (AccessibleImage *obj,
+                                long *x,
+                                long *y,
+                                long *width,
+                                long *height,
+                                AccessibleCoordType ctype)
+{
+  Accessibility_BoundingBox bbox;
+
+  cspi_return_if_fail (obj != NULL);
+
+  bbox = Accessibility_Image_getImageExtents (CSPI_OBJREF (obj),
+                                             ctype,
+                                             cspi_ev ());
+
+  if (!cspi_check_ev ("getImageExtents"))
+    {
+      *x = *y = *width = *height = 0;
+    }
+  else
+    {
+      *x = bbox.x;
+      *y = bbox.y;
+      *width = bbox.width;
+      *height = bbox.height;
+    }
 }
 
+/**
+ * AccessibleImage_getImageLocale:
+ * @obj: The #AccessibleImage being queried.
+ *
+ * Get the locale associated with an image and its textual representation.
+ *
+ * Returns: A POSIX LC_MESSAGES-style Locale value for image description and text.
+ **/
+char *
+AccessibleImage_getImageLocale  (AccessibleImage *obj)
+{
+    char *retval = "C";
+
+    cspi_return_val_if_fail (obj != NULL, "C");
 
+    retval = Accessibility_Image__get_imageLocale (CSPI_OBJREF (obj), cspi_ev ());
+
+    cspi_return_val_if_ev ("getImageLocale", NULL);
+
+    return retval;
+}