AccessibleImage Interface
3
AT-SPI-CSPI Library

# AccessibleImage Interface

## Synopsis

    void                AccessibleImage_ref                 (AccessibleImage *obj);
    void                AccessibleImage_unref               (AccessibleImage *obj);
    char*               AccessibleImage_getImageDescription (AccessibleImage *obj);
    void                AccessibleImage_getImageSize        (AccessibleImage *obj,
                                                             long int *width,
                                                             long int *height);
    void                AccessibleImage_getImagePosition    (AccessibleImage *obj,
                                                             long int *x,
                                                             long int *y,
                                                             AccessibleCoordType ctype);
    void                AccessibleImage_getImageExtents     (AccessibleImage *obj,
                                                             long int *x,
                                                             long int *y,
                                                             long int *width,
                                                             long int *height,
                                                             AccessibleCoordType ctype);
    char*               AccessibleImage_getImageLocale      (AccessibleImage *obj);

## Description

## Details

### AccessibleImage_ref ()

    void                AccessibleImage_ref                 (AccessibleImage *obj);

Increment the reference count for an AccessibleImage object.

`obj` :

  a pointer to the AccessibleImage implementor on which to operate.

### AccessibleImage_unref ()

    void                AccessibleImage_unref               (AccessibleImage *obj);

Decrement the reference count for an AccessibleImage object.

`obj` :

  a pointer to the AccessibleImage implementor on which to operate.

### AccessibleImage_getImageDescription ()

    char*               AccessibleImage_getImageDescription (AccessibleImage *obj);

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

`obj` :

  a pointer to the AccessibleImage implementor on which to operate.

Returns :

  a UTF-8 string describing the image.

### AccessibleImage_getImageSize ()

    void                AccessibleImage_getImageSize        (AccessibleImage *obj,
                                                             long int *width,
                                                             long int *height);

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

`obj` :

  a pointer to the AccessibleImage to query.

`width` :

  a pointer to a long into which the x extents (width) will be returned.

`height` :

  a pointer to a long into which the y extents (height) will be returned.

### AccessibleImage_getImagePosition ()

    void                AccessibleImage_getImagePosition    (AccessibleImage *obj,
                                                             long int *x,
                                                             long int *y,
                                                             AccessibleCoordType ctype);

Get the minimum x and y coordinates of the image displayed in a specified AccessibleImage implementor.

`obj` :

  a pointer to the AccessibleImage implementor to query.

`x` :

  a pointer to a long into which the minimum x coordinate will be returned.

`y` :

  a pointer to a long into which the minimum y coordinate will be returned.

`ctype` :

  the desired coordinate system into which to return the results, (e.g. SPI_COORD_TYPE_WINDOW, SPI_COORD_TYPE_SCREEN).

### AccessibleImage_getImageExtents ()

    void                AccessibleImage_getImageExtents     (AccessibleImage *obj,
                                                             long int *x,
                                                             long int *y,
                                                             long int *width,
                                                             long int *height,
                                                             AccessibleCoordType ctype);

Get the bounding box of the image displayed in a specified AccessibleImage implementor.

`obj` :

  a pointer to the AccessibleImage implementor to query.

`x` :

  a pointer to a long into which the minimum x coordinate will be returned.

`y` :

  a pointer to a long into which the minimum y coordinate will be returned.

`width` :

  a pointer to a long into which the image x extent will be returned.

`height` :

  a pointer to a long into which the image y extent will be returned.

`ctype` :

  the desired coordinate system into which to return the results, (e.g. SPI_COORD_TYPE_WINDOW, SPI_COORD_TYPE_SCREEN).

### AccessibleImage_getImageLocale ()

    char*               AccessibleImage_getImageLocale      (AccessibleImage *obj);

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

`obj` :

  The AccessibleImage being queried.

Returns :

  A POSIX LC_MESSAGES-style Locale value for image description and text.