atspi-image

## atspi-image atspi-image |

## Synopsis

                        AtspiImage;
    gchar *             atspi_image_get_image_description   (AtspiImage *obj,
                                                             GError **error);
    AtspiPoint *        atspi_image_get_image_size          (AtspiImage *obj,
                                                             GError **error);
    AtspiPoint *        atspi_image_get_image_position      (AtspiImage *obj,
                                                             AtspiCoordType ctype,
                                                             GError **error);
    AtspiRect *         atspi_image_get_image_extents       (AtspiImage *obj,
                                                             AtspiCoordType ctype,
                                                             GError **error);
    gchar *             atspi_image_get_image_locale        (AtspiImage *obj,
                                                             GError **error);

## Object Hierarchy

      GInterface
       +----AtspiImage

## Known Implementations

AtspiImage is implemented by AtspiAccessible.

## Description

## Details

### AtspiImage

    typedef struct _AtspiImage AtspiImage;

### atspi_image_get_image_description ()

    gchar *             atspi_image_get_image_description   (AtspiImage *obj,
                                                             GError **error);

Gets the description of the image displayed in an AtspiImage object.

`obj` : | a pointer to the AtspiImage implementor on which to operate.
Returns : | a UTF-8 string describing the image.

### atspi_image_get_image_size ()

    AtspiPoint *        atspi_image_get_image_size          (AtspiImage *obj,
                                                             GError **error);

Gets the size of the image displayed in a specified AtspiImage object.

`obj` : | a pointer to the AtspiImage to query.
Returns : | a pointer to an AtspiPoint where x corresponds to the image's width and y corresponds to the image's height.

### atspi_image_get_image_position ()

    AtspiPoint *        atspi_image_get_image_position      (AtspiImage *obj,
                                                             AtspiCoordType ctype,
                                                             GError **error);

Gets the minimum x and y coordinates of the image displayed in a specified AtspiImage implementor.

`obj` : | a pointer to the AtspiImage implementor to query.
`ctype` : | the desired coordinate system into which to return the results, (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
Returns : | a pointer to an AtspiPoint where x and y correspond to the minimum coordinates of the displayed image.

### atspi_image_get_image_extents ()

    AtspiRect *         atspi_image_get_image_extents       (AtspiImage *obj,
                                                             AtspiCoordType ctype,
                                                             GError **error);

Gets the bounding box of the image displayed in a specified AtspiImage implementor.

`obj` : | a pointer to the AtspiImage implementor to query.
`ctype` : | the desired coordinate system into which to return the results, (e.g. ATSPI_COORD_TYPE_WINDOW, ATSPI_COORD_TYPE_SCREEN).
Returns : | a pointer to an AtspiRect corresponding to the image's bounding box. The minimum x and y coordinates, width, and height are specified.

### atspi_image_get_image_locale ()

    gchar *             atspi_image_get_image_locale        (AtspiImage *obj,
                                                             GError **error);

Gets the locale associated with an image and its textual representation.

`obj` : | a pointer to the AtspiImage to query.
Returns : | A POSIX LC_MESSAGES-style locale value for image description and text.