AtkImage
AtkImage — The ATK Interface implemented by components
which expose image or pixmap content on-screen.
|
|
Includes
#include <atk/atk.h>
Description
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.
Functions
atk_image_get_image_position ()
void
atk_image_get_image_position (AtkImage *image,
gint *x,
gint *y,
AtkCoordType coord_type);
Gets the position of the image in the form of a point specifying the
images top-left corner.
If the position can not be obtained (e.g. missing support), x and y are set
to -1.
atk_image_get_image_description ()
const gchar *
atk_image_get_image_description (AtkImage *image);
Get a textual description of this image.
Returns
a string representing the image description
atk_image_set_image_description ()
gboolean
atk_image_set_image_description (AtkImage *image,
const gchar *description);
Sets the textual description for this image.
Returns
boolean TRUE, or FALSE if operation could
not be completed.
atk_image_get_image_size ()
void
atk_image_get_image_size (AtkImage *image,
gint *width,
gint *height);
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).
If the size can not be obtained (e.g. missing support), x and y are set
to -1.
atk_image_get_image_locale ()
const gchar *
atk_image_get_image_locale (AtkImage *image);
Retrieves the locale identifier associated to the AtkImage.
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.
[nullable]
Since: 1.12
Types and Values
AtkImage
typedef struct _AtkImage AtkImage;