xml/org.freedesktop.atspi.Image.xml

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