Atk.Image¶

Implementations:
	`Atk.NoOpObject`

Methods¶

	`get_image_description` ()
	`get_image_locale` ()
	`get_image_position` (coord_type)
	`get_image_size` ()
	`set_image_description` (description)

Virtual Methods¶

	`do_get_image_description` ()
	`do_get_image_locale` ()
	`do_get_image_position` (coord_type)
	`do_get_image_size` ()
	`do_set_image_description` (description)

Properties¶

None

Signals¶

None

Fields¶

None

Class Details¶

class Atk.Image¶

Bases:	`GObject.GInterface`
Structure:	`Atk.ImageIface`

Atk.Image should be implemented by Atk.Object 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 Atk.Image.

Atk.Image 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.

get_image_description()[source]¶

Returns:	a string representing the image description
Return type:	`str`

Get a textual description of this image.

get_image_locale()[source]¶

Returns:	a string corresponding to the POSIX `LC_MESSAGES` locale used by the image description, or `None` if the image does not specify a locale.
Return type:	`str` or `None`

Retrieves the locale identifier associated to the Atk.Image.

New in version 1.12.

get_image_position(coord_type)[source]¶

Parameters: coord_type (Atk.CoordType) – specifies whether the coordinates are relative to the screen or to the components top level window

Returns:

x:	address of `int` to put x coordinate position; otherwise, -1 if value cannot be obtained.
y:	address of `int` to put y coordinate position; otherwise, -1 if value cannot be obtained.

Return type: (x: int, y: int)

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.

get_image_size()[source]¶

Returns:

width:	filled with the image width, or -1 if the value cannot be obtained.
height:	filled with the image height, or -1 if the value cannot be obtained.

Return type: (width: int, height: int)

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.

set_image_description(description)[source]¶

Parameters:	description (`str`) – a string description to set for self
Returns:	boolean `True`, or `False` if operation could not be completed.
Return type:	`bool`

Sets the textual description for this image.

do_get_image_description() virtual¶

Returns:	a string representing the image description
Return type:	`str`

Get a textual description of this image.

do_get_image_locale() virtual¶

Returns:	a string corresponding to the POSIX `LC_MESSAGES` locale used by the image description, or `None` if the image does not specify a locale.
Return type:	`str` or `None`

Retrieves the locale identifier associated to the Atk.Image.

New in version 1.12.

do_get_image_position(coord_type) virtual¶

Parameters: coord_type (Atk.CoordType) – specifies whether the coordinates are relative to the screen or to the components top level window

Returns:

x:	address of `int` to put x coordinate position; otherwise, -1 if value cannot be obtained.
y:	address of `int` to put y coordinate position; otherwise, -1 if value cannot be obtained.

Return type: (x: int, y: int)

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.

do_get_image_size() virtual¶

Returns:

width:	filled with the image width, or -1 if the value cannot be obtained.
height:	filled with the image height, or -1 if the value cannot be obtained.

Return type: (width: int, height: int)

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.

do_set_image_description(description) virtual¶

Parameters:	description (`str`) – a string description to set for image
Returns:	boolean `True`, or `False` if operation could not be completed.
Return type:	`bool`

Sets the textual description for this image.