* 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 (void)
{
/**
* atk_image_get_image_size:
* @image: a #GObject instance that implements AtkImageIface
- * @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.
+ * @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 the width and height in pixels for the specified image.
* The values of @width and @height are returned as -1 if the
/**
* atk_image_get_image_position:
* @image: a #GObject instance that implements AtkImageIface
- * @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.
+ * @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
*
* atk_image_get_image_locale:
* @image: An #AtkImage
*
- * Since ATK 1.12
+ * Since: 1.12
*
- * Returns a string corresponding to the POSIX LC_MESSAGES locale used by the image description, or NULL if the image does not specify a locale.
+ * 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*