1 <?xml version="1.0" encoding="UTF-8"?>
2 <node xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" name="/node">
3 <interface name="org.freedesktop.atspi.Image">
4 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
5 <p>An interface implemented by objects which render image data or
6 pictorial information to the screen. When onscreen components include
7 graphical information that is not purely intended to enhance "3d effect"
8 or visual layout, but which conveys some semantic or informational
9 content to the sighted user, they should implement Image, and that
10 semantic content should be conveyed textually to the extent possible
11 via the image description, as well as the Accessible.name and
12 Accessible.description properties. </p>
14 <tp:property name="imageDescription" type="s" access="read">
15 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
16 <p>A UTF-8 string providing a textual description
17 of what is visually depicted in the image. </p>
19 <p>It is recommended that imageDescription be the shorter
20 of the available image descriptions, for instance "alt text"
21 in HTML images, and a longer description be provided in
22 Accessible.description, if available.
23 A short, one or two word label for the image should be provided in
27 <tp:property name="imageLocale" type="s" access="read">
28 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
29 <p>A string corresponding to the POSIX LC_MESSAGES locale used
30 by the imageDescription.</p>
33 <method name="getImageExtents">
34 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
35 <p>Obtain a bounding box which entirely contains the image contents,
36 as displayed on screen. The bounds returned do not account for
37 any viewport clipping or the fact that the image may be
38 partially or wholly obscured by other onscreen content.
40 <p>This method returns the bounds of the current onscreen
41 view, and not the nominal size of the source data in the
42 event that the original image has been rescaled. </p>
44 <arg direction="in" name="coordType" type="u" tp:type="COORD_TYPE">
46 <p>If 0, the returned bounding box position is returned
47 relative to the screen; if 1, the bounding box position is returned
48 relative to the containing window.</p>
51 <arg direction="out" type="(iiii)" tp:type="BoundingBox">
53 A BoundingBox enclosing the image's onscreen representation.
57 <method name="getImagePosition">
58 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
59 <p>Get the coordinates of the current image position on screen. </p>
62 <arg direction="out" name="x" type="i">
64 Back-filled with the x coordinate of the
65 onscreen image (i.e. the minimum x coordinate)
68 <arg direction="out" name="y" type="i">
70 Back-filled with the y coordinate of the
71 onscreen image (i.e. the minimum y coordinate)
74 <arg direction="in" name="coordType" type="u" tp:type="COORD_TYPE">
76 If 0, the returned x and y coordinates are
77 returned relative to the screen;
78 if 1, they are returned relative to the containing window.
82 <method name="getImageSize">
83 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
84 <p>Obtain the width and height of the current onscreen view of the
85 image. The extents returned do not account for
86 any viewport clipping or the fact that the image may be
87 partially or wholly obscured by other onscreen content.
89 <p>This method returns the size of the current onscreen
90 view, and not the nominal or "original" size of the source
91 image, in the event that the original image has been rescaled.
95 <arg direction="out" name="width" type="i">
97 Back-filled with the x extents of the
98 onscreen image (i.e. the image width in pixels)
101 <arg direction="out" name="height" type="i">
103 Back-filled with the y extents of the
104 onscreen image (i.e. the image height in pixels)