xml/Accessibility_Document.xml

   1 <node name="/node" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
   2
   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 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>
  11
  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>
  16
  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>
  21 </tp:license>
  22 <interface name="org.freedesktop.accessibility.Document">
  23   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  24     <p>Primarily a 'tagging' interface which indicates the start of
  25       document content in the Accessibility hierarchy.
  26       Accessible objects below the node implementing
  27       Document are normally assumed to be part of the document content.
  28       Attributes of Document are those attributes associated with the document
  29       as a whole.  Objects that implement Document are normally expected to
  30       implement Collection as well.  </p>
  31
  32     <p>\see Accessibility::Collection</p>
  33   </tp:docstring>
  34   <method name="getLocale">
  35     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  36       <p>Gets the locale associated with the document's content.
  37         e.g. the locale for LOCALE_TYPE_MESSAGES.    </p>
  38     </tp:docstring>
  39     <arg direction="out" type="s">
  40     <tp:docstring>
  41       a string compliant with the POSIX standard for locale description.
  42     </tp:docstring>
  43     </arg>
  44   </method>
  45   <method name="getAttributeValue">
  46     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  47       <p>Gets the value of a single attribute, if specified for the document as a whole.    </p>
  48     </tp:docstring>
  49     <arg direction="in" name="attributename" type="s">
  50     <tp:docstring>
  51       a string indicating the name of a specific attribute (name-value pair) being queried.
  52     </tp:docstring>
  53     </arg>
  54     <arg direction="out" type="s">
  55     <tp:docstring>
  56       a string corresponding to the value of the specified attribute, oran empty string if the attribute is unspecified for the object.
  57     </tp:docstring>
  58     </arg>
  59   </method>
  60   <method name="getAttributes">
  61     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  62       <p>Gets all attributes specified for a document as a whole.
  63         For attributes which change within
  64         the document content, see Accessibility::Text::getAttributes instead.    </p>
  65     </tp:docstring>
  66     <arg direction="out" type="as" tp:type="AttributeSet">
  67     <tp:docstring>
  68       an ::AttributeSet containing the attributes of the document, as name-value pairs.@since AT-SPI 1.8.0
  69     </tp:docstring>
  70     </arg>
  71   </method>
  72   <method name="unImplemented_">
  73     <tp:docstring>
  74       \cond
  75     </tp:docstring>
  76   </method>
  77   <method name="unImplemented2_">
  78   </method>
  79   <method name="unImplemented3_">
  80   </method>
  81   <method name="unImplemented4_">
  82   </method>
  83 </interface>
  84 </node>