1 <node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
3 <tp:title>AT-SPI - Assistive Technology Service Provider Interface </tp:title>
4 <tp:copyright>Copyright 2008 Novell, Inc.</tp:copyright>
5 <tp:copyright>Copyright 2001 - 2005 Sun Microsystems, Inc.</tp:copyright>
6 <tp:license xmlns="http://www.w3.org/1999/xhtml">
7 <p>This library is free software; you can redistribute it and/or
8 modify it under the terms of the GNU Library General Public
9 License as published by the Free Software Foundation; either
10 version 2 of the License, or (at your option) any later version.</p>
12 <p>This library is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 Library General Public License for more details.</p>
17 <p>You should have received a copy of the GNU Library General Public
18 License along with this library; if not, write to the
19 Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA.</p>
22 <interface name="org.freedesktop.atspi.Image">
23 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
24 <p>An interface implemented by objects which render image data or
25 pictorial information to the screen. When onscreen components include
26 graphical information that is not purely intended to enhance "3d effect"
27 or visual layout, but which conveys some semantic or informational
28 content to the sighted user, they should implement Image, and that
29 semantic content should be conveyed textually to the extent possible
30 via the image description, as well as the Accessible::name and
31 Accessible::description properties. </p>
33 <tp:property name="imageDescription" type="s" access="read">
34 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
35 <p>A UTF-8 string providing a textual description
36 of what is visually depicted in the image. </p>
38 <p>@note It is recommended that imageDescription be the shorter
39 of the available image descriptions, for instance "alt text"
40 in HTML images, and a longer description be provided in
41 Accessible::accessible-description, if available.
42 A short, one or two word label for the image should be provided in
43 Accessible::accessible-name.</p>
46 <tp:property name="imageLocale" type="s" access="read">
47 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
48 <p>A string corresponding to the POSIX LC_MESSAGES locale used
49 by the imageDescription.
50 @since AT-SPI 1.7.0</p>
53 <method name="getImageExtents">
54 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
55 <p>Obtain a bounding box which entirely contains the image contents,
56 as displayed on screen. The bounds returned do not account for
57 any viewport clipping or the fact that the image may be
58 partially or wholly obscured by other onscreen content.
59 @note This method returns the bounds of the current onscreen
60 view, and not the nominal size of the source data in the
61 event that the original image has been rescaled. </p>
63 <p>@param coordType If 0, the returned bounding box position is returned
64 relative to the screen; if 1, the bounding box position is returned
65 relative to the containing window.</p>
67 <arg direction="in" name="coordType" type="n" tp:type="short"/>
68 <arg direction="out" type="(iiii)" tp:type="BoundingBox">
70 a BoundingBox enclosing the image's onscreen representation.
74 <method name="getImagePosition">
75 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
76 <p>Get the coordinates of the current image position on screen. </p>
78 <p>@param x Back-filled with the x coordinate of the
79 onscreen image (i.e. the minimum x coordinate)
80 @param y Back-filled with the y coordinate of the
81 onscreen image (i.e. the minimum y coordinate)
82 @param coordType If 0, the returned x and y coordinates are
83 returned relative to the screen;
84 if 1, they are returned relative to the containing window.</p>
86 <arg direction="out" name="x" type="i"/>
87 <arg direction="out" name="y" type="i"/>
88 <arg direction="in" name="coordType" type="n" tp:type="short"/>
90 <method name="getImageSize">
91 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
92 <p>Obtain the width and height of the current onscreen view of the
93 image. The extents returned do not account for
94 any viewport clipping or the fact that the image may be
95 partially or wholly obscured by other onscreen content.
96 @note This method returns the size of the current onscreen
97 view, and not the nominal or "original" size of the source
98 image, in the event that the original image has been rescaled. </p>
100 <p>@param width Back-filled with the x extents of the
101 onscreen image (i.e. the image width in pixels)
102 @param height Back-filled with the y extents of the
103 onscreen image (i.e. the image height in pixels)</p>
105 <arg direction="out" name="width" type="i"/>
106 <arg direction="out" name="height" type="i"/>
108 <method name="unImplemented">
109 <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
113 <p>placeholders for future expansion.</p>
116 <method name="unImplemented2">
118 <method name="unImplemented3">