2001-11-20 Michael Meeks <michael@ximian.com>

[platform/core/uifw/at-spi2-atk.git] / cspi / spi_image.c

diff --git a/cspi/spi_image.c b/cspi/spi_image.c
index 8b340a5..ddd7955 100644 (file)
--- a/cspi/spi_image.c
+++ b/cspi/spi_image.c
@@ -1,3 +1,12 @@
+/**
+ * AccessibleImage_ref:
+ * @obj: a pointer to the #AccessibleImage implementor on which to operate.
+ *
+ * Increment the reference count for an #AccessibleImage object.
+ *
+ * Returns: (no return code implemented yet).
+ *
+ **/
 int
 AccessibleImage_ref (AccessibleImage *obj)
 {
@@ -7,6 +16,15 @@ AccessibleImage_ref (AccessibleImage *obj)
 
 
 
+/**
+ * AccessibleImage_unref:
+ * @obj: a pointer to the #AccessibleImage implementor on which to operate.
+ *
+ * Decrement the reference count for an #AccessibleImage object.
+ *
+ * Returns: (no return code implemented yet).
+ *
+ **/
 int
 AccessibleImage_unref (AccessibleImage *obj)
 {
@@ -15,7 +33,15 @@ AccessibleImage_unref (AccessibleImage *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)
 {
@@ -25,10 +51,19 @@ AccessibleImage_getImageDescription (AccessibleImage *obj)
 
 
 
+/**
+ * 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);
@@ -36,6 +71,18 @@ AccessibleImage_getImageSize (AccessibleImage *obj,
 
 
 
+/**
+ * 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,
@@ -46,6 +93,3 @@ AccessibleImage_getImagePosition (AccessibleImage *obj,
                                        (CORBA_long *) x, (CORBA_long *) y, (CORBA_short) ctype,
                                        &ev);
 }
-
-
-