Next: , Previous: AtkHypertext, Up: Top

10 AtkImage

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

10.1 Overview

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

10.2 Usage

— Class: <atk-image>

Derives from <ginterface>.

This class defines no direct slots.

— Function: atk-image-get-image-position (self <atk-image>) (coord_type <atk-coord-type>) ⇒  (x int) (y int)
— Method: get-image-position

Gets the position of the image in the form of a point specifying the images top-left corner.

image
a <gobject> instance that implements AtkImageIface
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.
coord-type
specifies whether the coordinates are relative to the screen or to the components top level window
— Function: atk-image-get-image-description (self <atk-image>) ⇒  (ret mchars)
— Method: get-image-description

Get a textual description of this image.

image
a <gobject> instance that implements AtkImageIface
ret
a string representing the image description
— Function: atk-image-set-image-description (self <atk-image>) (description mchars) ⇒  (ret bool)
— Method: set-image-description

Sets the textual description for this image.

image
a <gobject> instance that implements AtkImageIface
description
a string description to set for image
ret
boolean TRUE, or FALSE if operation could not be completed.
— Function: atk-image-get-image-size (self <atk-image>) ⇒  (width int) (height int)
— Method: get-image-size

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

image
a <gobject> instance that implements AtkImageIface
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.
— Function: atk-image-get-image-locale (self <atk-image>) ⇒  (ret mchars)
— Method: get-image-locale

Since ATK 1.12

image
An <atk-image>
ret
a string corresponding to the POSIX LC_MESSAGES locale used by the image description, or NULL if the image does not specify a locale.