X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=atk%2Fatkimage.c;h=2ba59091bbf59b9fe48b8acf2d59b176a2dd7afb;hb=e91d02fcd860bd758e8ec9b85b19a16cdffba2bc;hp=dc53bd8dde3c9f52bb502a48b69a05aec8eb5b57;hpb=55e900f66517384b33eadece7100d86b90aca7a8;p=platform%2Fupstream%2Fatk.git

diff --git a/atk/atkimage.c b/atk/atkimage.c
index dc53bd8..2ba5909 100755
--- a/atk/atkimage.c
+++ b/atk/atkimage.c
@@ -17,10 +17,33 @@
  * Boston, MA 02111-1307, USA.
  */
 
+#include "config.h"
+
 #include "atkimage.h"
 
+/**
+ * SECTION:atkimage
+ * @Short_description: The ATK Interface implemented by components
+ *  which expose image or pixmap content on-screen.
+ * @Title:AtkImage
+ *
+ * #AtkImage should be implemented by #AtkObject subtypes on behalf of
+ * components which display image/pixmap information onscreen, and
+ * which provide information (other than just widget borders, etc.)
+ * via that image content.  For instance, icons, buttons with icons,
+ * toolbar elements, and image viewing panes typically should
+ * implement #AtkImage.
+ *
+ * #AtkImage primarily provides two types of information: coordinate
+ * information (useful for screen review mode of screenreaders, and
+ * for use by onscreen magnifiers), and descriptive information.  The
+ * descriptive information is provided for alternative, text-only
+ * presentation of the most significant information present in the
+ * image.
+ */
+
 GType
-atk_image_get_type ()
+atk_image_get_type (void)
 {
   static GType type = 0;
 
@@ -29,8 +52,7 @@ atk_image_get_type ()
     {
       sizeof (AtkImageIface),
       (GBaseInitFunc) NULL,
-      (GBaseFinalizeFunc) NULL,
-
+      (GBaseFinalizeFunc) NULL
     };
 
     type = g_type_register_static (G_TYPE_INTERFACE, "AtkImage", &tinfo, 0);
@@ -47,12 +69,11 @@ atk_image_get_type ()
  *
  * Returns: a string representing the image description
  **/
-G_CONST_RETURN gchar*
+const gchar*
 atk_image_get_image_description (AtkImage *image)
 {
   AtkImageIface *iface;
 
-  g_return_val_if_fail (image != NULL, NULL);
   g_return_val_if_fail (ATK_IS_IMAGE (image), NULL);
 
   iface = ATK_IMAGE_GET_IFACE (image);
@@ -70,23 +91,44 @@ atk_image_get_image_description (AtkImage *image)
 /**
  * atk_image_get_image_size:
  * @image: a #GObject instance that implements AtkImageIface
- * @height: filled with the image height
- * @width: filled with the image width
+ * @width: filled with the image width, or -1 if the value cannot be obtained.
+ * @height: filled with the image height, or -1 if the value cannot be obtained.
  *
- * Get the height and width in pixels for the specified image.
+ * Get the width and height in pixels for the specified image.
+ * The values of @width and @height are returned as -1 if the
+ * values cannot be obtained (for instance, if the object is not onscreen).
  **/
 void
-atk_image_get_image_size (AtkImage *image, int *height, int *width)
+atk_image_get_image_size (AtkImage *image, 
+                          int      *width,
+                          int      *height)
 {
   AtkImageIface *iface;
+  gint local_width, local_height;
+  gint *real_width, *real_height;
 
-  g_return_if_fail (image != NULL);
   g_return_if_fail (ATK_IS_IMAGE (image));
 
+  if (width)
+    real_width = width;
+  else
+    real_width = &local_width;
+  if (height)
+    real_height = height;
+  else
+    real_height = &local_height;
+  
   iface = ATK_IMAGE_GET_IFACE (image);
 
   if (iface->get_image_size)
-    iface->get_image_size (image, height, width);
+  {
+    iface->get_image_size (image, real_width, real_height);
+  }
+  else
+  {
+    *real_width = -1;
+    *real_height = -1;
+  }
 }
 
 /**
@@ -101,11 +143,10 @@ atk_image_get_image_size (AtkImage *image, int *height, int *width)
  **/
 gboolean
 atk_image_set_image_description (AtkImage        *image,
-                              const gchar     *description)
+                                 const gchar     *description)
 {
   AtkImageIface *iface;
 
-  g_return_val_if_fail (image != NULL, FALSE);
   g_return_val_if_fail (ATK_IS_IMAGE (image), FALSE);
 
   iface = ATK_IMAGE_GET_IFACE (image);
@@ -121,35 +162,77 @@ atk_image_set_image_description (AtkImage        *image,
 }
 
 /**
- * atk_image_get_position:
+ * atk_image_get_image_position:
  * @image: a #GObject instance that implements AtkImageIface
- * @x: address of #gint to put x coordinate position
- * @y: address of #gint to put y coordinate position
+ * @x: address of #gint to put x coordinate position; otherwise, -1 if value cannot be obtained.
+ * @y: address of #gint to put y coordinate position; otherwise, -1 if value cannot be obtained.
  * @coord_type: specifies whether the coordinates are relative to the screen
  * or to the components top level window
  * 
  * Gets the position of the image in the form of a point specifying the
- * images top-left corner
+ * images top-left corner.
  **/
 void     
-atk_image_get_position (AtkImage *image,
+atk_image_get_image_position (AtkImage *image,
                         gint *x,
 		        gint *y,
     		        AtkCoordType coord_type)
 {
   AtkImageIface *iface;
+  gint local_x, local_y;
+  gint *real_x, *real_y;
 
-  g_return_if_fail (image != NULL);
   g_return_if_fail (ATK_IS_IMAGE (image));
 
+  if (x)
+    real_x = x;
+  else
+    real_x = &local_x;
+  if (y)
+    real_y = y;
+  else
+    real_y = &local_y;
+
   iface = ATK_IMAGE_GET_IFACE (image);
 
-  if (iface->get_position)
-    (iface->get_position) (image, x, y, coord_type);
+  if (iface->get_image_position)
+  {
+    (iface->get_image_position) (image, real_x, real_y, coord_type);
+  }
+  else
+  {
+    *real_x = -1;
+    *real_y = -1;
+  }
 }
 
+/**
+ * atk_image_get_image_locale: 
+ * @image: An #AtkImage
+ *
+ * Since: 1.12
+ *
+ * Returns: (nullable): a string corresponding to the POSIX
+ * LC_MESSAGES locale used by the image description, or %NULL if the
+ * image does not specify a locale.
+ *
+ */
+const gchar*
+atk_image_get_image_locale (AtkImage   *image)
+{
+	
+  AtkImageIface *iface;
 
+  g_return_val_if_fail (ATK_IS_IMAGE (image), NULL);
 
+  iface = ATK_IMAGE_GET_IFACE (image);
 
-
-
+  if (iface->get_image_locale)
+    {
+      return (iface->get_image_locale) (image);
+    }
+  else
+    {
+      return NULL;
+    }
+}