Atspi.Image

g Atspi.Image Atspi.Image GObject.GInterface GObject.GInterface GObject.GInterface->Atspi.Image

Implementations:

Atspi.Accessible

Methods

get_image_description ()

get_image_extents (ctype)

get_image_locale ()

get_image_position (ctype)

get_image_size ()

Virtual Methods

None

Properties

None

Signals

None

Fields

None

Class Details

class Atspi.Image
Bases:

GObject.GInterface

get_image_description()
Raises:

GLib.Error

Returns:

a UTF-8 string describing the image.

Return type:

str

Gets the description of the image displayed in an Atspi.Image object.

get_image_extents(ctype)
Parameters:

ctype (Atspi.CoordType) – the desired coordinate system into which to return the results, (e.g. Atspi.CoordType.WINDOW, Atspi.CoordType.SCREEN).

Raises:

GLib.Error

Returns:

a pointer to an Atspi.Rect corresponding to the image’s bounding box. The minimum x and y coordinates, width, and height are specified.

Return type:

Atspi.Rect

Gets the bounding box of the image displayed in a specified Atspi.Image implementor. The returned values are meaningful only if the Image has both STATE_VISIBLE and STATE_SHOWING.

get_image_locale()
Raises:

GLib.Error

Returns:

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

Return type:

str

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

get_image_position(ctype)
Parameters:

ctype (Atspi.CoordType) – the desired coordinate system into which to return the results, (e.g. Atspi.CoordType.WINDOW, Atspi.CoordType.SCREEN).

Raises:

GLib.Error

Returns:

a pointer to an Atspi.Point where x and y correspond to the minimum coordinates of the displayed image.

Return type:

Atspi.Point

Gets the minimum x and y coordinates of the image displayed in a specified Atspi.Image implementor. The returned values are meaningful only if the Image has both STATE_VISIBLE and STATE_SHOWING.

get_image_size()
Raises:

GLib.Error

Returns:

a pointer to an Atspi.Point where x corresponds to the image’s width and y corresponds to the image’s height.

Return type:

Atspi.Point

Gets the size of the image displayed in a specified Atspi.Image object. The returned values are meaningful only if the Image has both STATE_VISIBLE and STATE_SHOWING.