* 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;
static const GTypeInfo tinfo =
{
sizeof (AtkImageIface),
- NULL,
- NULL,
-
+ (GBaseInitFunc) NULL,
+ (GBaseFinalizeFunc) NULL
};
type = g_type_register_static (G_TYPE_INTERFACE, "AtkImage", &tinfo, 0);
}
/**
- * atk_image_get_storage_type:
- * @obj: a GObject instance that implements AtkImageIface
- * return values: a AtkStorageType representing the image storage type
+ * atk_image_get_image_description:
+ * @image: a #GObject instance that implements AtkImageIface
*
- * [maybe this method will be replaced, watch this space.]
+ * Get a textual description of this image.
*
+ * Returns: a string representing the image description
**/
-AtkImageType
-atk_image_get_storage_type (AtkImage *obj)
+const gchar*
+atk_image_get_image_description (AtkImage *image)
{
AtkImageIface *iface;
- g_return_val_if_fail (obj != NULL, 0);
- g_return_val_if_fail (ATK_IS_IMAGE (obj), 0);
+ g_return_val_if_fail (ATK_IS_IMAGE (image), NULL);
- iface = ATK_IMAGE_GET_IFACE (obj);
+ iface = ATK_IMAGE_GET_IFACE (image);
- if (iface->get_storage_type)
+ if (iface->get_image_description)
{
- return (iface->get_storage_type) (obj);
+ return (iface->get_image_description) (image);
}
else
{
- return 0;
+ return NULL;
}
}
/**
- * atk_image_get_image_description:
- * @obj: a GObject instance that implements AtkImageIface
- * return values: a gchar* representing the image description
+ * atk_image_get_image_size:
+ * @image: a #GObject instance that implements AtkImageIface
+ * @width: (out) (optional): filled with the image width, or -1 if the value cannot be obtained.
+ * @height: (out) (optional): filled with the image height, or -1 if the value cannot be obtained.
*
- * Get a textual description of this 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).
**/
-G_CONST_RETURN gchar*
-atk_image_get_image_description (AtkImage *obj)
+void
+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_val_if_fail (obj != NULL, NULL);
- g_return_val_if_fail (ATK_IS_IMAGE (obj), NULL);
+ g_return_if_fail (ATK_IS_IMAGE (image));
- iface = ATK_IMAGE_GET_IFACE (obj);
+ 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_description)
- {
- return (iface->get_image_description) (obj);
- }
+ if (iface->get_image_size)
+ {
+ iface->get_image_size (image, real_width, real_height);
+ }
else
- {
- return NULL;
- }
+ {
+ *real_width = -1;
+ *real_height = -1;
+ }
}
/**
- * atk_image_get_image_height:
- * @obj: a GObject instance that implements AtkImageIface
- * return values: a gint representing the image height in pixel coords
+ * atk_image_set_image_description:
+ * @image: a #GObject instance that implements AtkImageIface
+ * @description: a string description to set for @image
*
- * Get the height, in pixels/screen coords, of this image.
+ * Sets the textual description for this image.
*
+ * Returns: boolean TRUE, or FALSE if operation could
+ * not be completed.
**/
-gint
-atk_image_get_image_height (AtkImage *obj)
+gboolean
+atk_image_set_image_description (AtkImage *image,
+ const gchar *description)
{
AtkImageIface *iface;
- g_return_val_if_fail (obj != NULL, 0);
- g_return_val_if_fail (ATK_IS_IMAGE (obj), 0);
+ g_return_val_if_fail (ATK_IS_IMAGE (image), FALSE);
- iface = ATK_IMAGE_GET_IFACE (obj);
+ iface = ATK_IMAGE_GET_IFACE (image);
- if (iface->get_image_height)
+ if (iface->set_image_description)
{
- return (iface->get_image_height) (obj);
+ return (iface->set_image_description) (image, description);
}
else
{
- return 0;
+ return FALSE;
}
}
/**
- * atk_image_get_image_width:
- * @obj: a GObject instance that implements AtkImageIface
- * return values: a gint representing the image width
- *
- * Get the width, in pixel/screen coords, of this image.
- *
+ * atk_image_get_image_position:
+ * @image: a #GObject instance that implements AtkImageIface
+ * @x: (out) (optional): address of #gint to put x coordinate position; otherwise, -1 if value cannot be obtained.
+ * @y: (out) (optional): 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.
**/
-gint
-atk_image_get_image_width (AtkImage *obj)
+void
+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_val_if_fail (obj != NULL, 0);
- g_return_val_if_fail (ATK_IS_IMAGE (obj), 0);
+ g_return_if_fail (ATK_IS_IMAGE (image));
- iface = ATK_IMAGE_GET_IFACE (obj);
+ if (x)
+ real_x = x;
+ else
+ real_x = &local_x;
+ if (y)
+ real_y = y;
+ else
+ real_y = &local_y;
- if (iface->get_image_width)
- {
- return (iface->get_image_width) (obj);
- }
+ iface = ATK_IMAGE_GET_IFACE (image);
+
+ if (iface->get_image_position)
+ {
+ (iface->get_image_position) (image, real_x, real_y, coord_type);
+ }
else
- {
- return 0;
- }
+ {
+ *real_x = -1;
+ *real_y = -1;
+ }
}
/**
- * atk_image_set_image_description:
- * @obj: a GObject instance that implements AtkImageIface
- * return values: boolean TRUE, or FALSE if operation could
- * not be completed.
+ * atk_image_get_image_locale:
+ * @image: An #AtkImage
*
- * Sets the textual description for this image.
+ * Since: 1.12
*
- **/
-gboolean
-atk_image_set_image_description (AtkImage *obj,
- const gchar *description)
+ * 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 (obj != NULL, FALSE);
- g_return_val_if_fail (ATK_IS_IMAGE (obj), FALSE);
+ g_return_val_if_fail (ATK_IS_IMAGE (image), NULL);
- iface = ATK_IMAGE_GET_IFACE (obj);
+ iface = ATK_IMAGE_GET_IFACE (image);
- if (iface->set_image_description)
+ if (iface->get_image_locale)
{
- return (iface->set_image_description) (obj, description);
+ return (iface->get_image_locale) (image);
}
else
{
- return FALSE;
+ return NULL;
}
}
projects / platform / upstream / atk.git / blobdiff