Interface
AtkImage
Description [src]
interface Atk.Image : GObject.Object
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.
Prerequisite
In order to implement Image, your type must inherit from
GObject
.
Instance methods
atk_image_get_image_description
Get a textual description of this image.
atk_image_get_image_locale
Retrieves the locale identifier associated to the AtkImage
.
Available since: 1.12
atk_image_get_image_position
Gets the position of the image in the form of a point specifying the images top-left corner.
atk_image_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).
atk_image_set_image_description
Sets the textual description for this image.
Interface structure
struct AtkImageIface {
GTypeInterface parent;
void (* get_image_position) (
AtkImage* image,
gint* x,
gint* y,
AtkCoordType coord_type
);
const gchar* (* get_image_description) (
AtkImage* image
);
void (* get_image_size) (
AtkImage* image,
gint* width,
gint* height
);
gboolean (* set_image_description) (
AtkImage* image,
const gchar* description
);
const gchar* (* get_image_locale) (
AtkImage* image
);
}
Interface members
parent |
|
No description available. | |
get_image_position |
|
No description available. | |
get_image_description |
|
No description available. | |
get_image_size |
|
No description available. | |
set_image_description |
|
No description available. | |
get_image_locale |
|
No description available. |
Virtual methods
Atk.Image.get_image_description
Get a textual description of this image.
Atk.Image.get_image_locale
Retrieves the locale identifier associated to the AtkImage
.
Atk.Image.get_image_position
Gets the position of the image in the form of a point specifying the images top-left corner.
Atk.Image.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).
Atk.Image.set_image_description
Sets the textual description for this image.