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);

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

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

### atspi_image_get_image_size ()

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

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

`obj` : | a pointer to the AtspiImage to query.
`error` : |
Returns : |

### atspi_image_get_image_position ()

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

Get 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).
`error` : |
Returns : |

### atspi_image_get_image_extents ()

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

Get 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).
`error` : |
Returns : |

### atspi_image_get_image_locale ()

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

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

`obj` : | The AtspiImage being queried.
`error` : |
Returns : | A POSIX LC_MESSAGES-style Locale value for image description and text.