atk.image_mixin

Module for [Image] interface mixin

Templates 2

tmplImageT()

The ATK Interface implemented by components which expose image or pixmap content on-screen.

#AtkImage should be implemented by #AtkObject 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 #AtkImage.

#AtkImage 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.

Functions

string getImageDescription()

Get a textual description of this image.

Returns

a string representing the image description

string getImageLocale()

Retrieves the locale identifier associated to the #AtkImage.

Returns

a string corresponding to the POSIX

LC_MESSAGES locale used by the image description, or null if the image does not specify a locale.

void getImagePosition(out int x, out int y, atk.types.CoordType coordType)

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.

Parameters

`x`	address of #gint to put x coordinate position; otherwise, -1 if value cannot be obtained.
`y`	address of #gint to put y coordinate position; otherwise, -1 if value cannot be obtained.
`coordType`	specifies whether the coordinates are relative to the screen or to the components top level window

void getImageSize(out int width, out int height)

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.

Parameters

`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.

bool setImageDescription(string description)

Sets the textual description for this image.

Parameters

description a string description to set for image

Returns

boolean TRUE, or FALSE if operation could

not be completed.

tmplImageGidBuilderT()