xml/Accessibility_EditableText.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 2001 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.EditableText">
  23   <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  24     <p>Derived from interface Text, EditableText provides methods for
  25       modifying textual content of components which support editing.
  26       EditableText also interacts with the system clipboard via copyText,
  27       cutText, and pasteText.  </p>
  28
  29     <p>@note read-only instances of EditableText are possible;
  30       These may be instances of a general-purpose component type which are
  31       sometimes, but not always, user-editable, or may be
  32       components which are temporarily or circumstantially
  33       in a non-editable state. </p>
  34   </tp:docstring>
  35   <method name="setTextContents">
  36     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  37       <p>Replace the text contents with a new string, discarding the old contents.    </p>
  38
  39       <p>@param newContents a UTF-8 string with which the text object's contents will be replaced.</p>
  40     </tp:docstring>
  41     <arg direction="in" name="newContents" type="s"/>
  42     <arg direction="out" type="b" tp:type="boolean">
  43     <tp:docstring>
  44       \c True if the text content was successfully changed, \c False otherwise.
  45     </tp:docstring>
  46     </arg>
  47   </method>
  48   <method name="insertText">
  49     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  50       <p>Insert new text contents into an existing text object at a given location, while retaining
  51         the old contents.
  52         @param position the character offset into the Text implementor's content at which the
  53         new content will be inserted.
  54         @param text a UTF-8 string of which \c length characters will be inserted into the text
  55         object's text buffer.
  56         @param length the number of characters of \c text to insert.  If the character count
  57         of \c text is less than or equal to \c length, the entire contents of \c text
  58         will be inserted.    </p>
  59     </tp:docstring>
  60     <arg direction="in" name="position" type="i"/>
  61     <arg direction="in" name="text" type="s"/>
  62     <arg direction="in" name="length" type="i"/>
  63     <arg direction="out" type="b" tp:type="boolean">
  64     <tp:docstring>
  65       \c True if the text content was successfully inserted, \c False otherwise.
  66     </tp:docstring>
  67     </arg>
  68   </method>
  69   <method name="setAttributes">
  70     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  71       <p>Apply a particular set of attributes to a range of text.    </p>
  72     </tp:docstring>
  73     <arg direction="in" name="attributes" type="s"/>
  74     <arg direction="in" name="startPos" type="i"/>
  75     <arg direction="in" name="endPos" type="i"/>
  76     <arg direction="out" type="b" tp:type="boolean">
  77     <tp:docstring>
  78       \c True if the text attributes were successfully modified, \c False otherwise.
  79     </tp:docstring>
  80     </arg>
  81   </method>
  82   <method name="copyText">
  83     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  84       <p>Copy a range of text into the system clipboard.
  85         @param startPos the character offset of the first character in the range of text being
  86         copied.
  87         @param endPos the offset of the first character past the end of the range of text
  88         being copied.</p>
  89     </tp:docstring>
  90     <arg direction="in" name="startPos" type="i"/>
  91     <arg direction="in" name="endPos" type="i"/>
  92   </method>
  93   <method name="cutText">
  94     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
  95       <p>Excise a range of text from a Text object, copying it into the system clipboard.
  96         @param startPos the character offset of the first character in the range of text being
  97         cut.
  98         @param endPos the offset of the first character past the end of the range of text
  99         being cut.</p>
 100     </tp:docstring>
 101     <arg direction="in" name="startPos" type="i"/>
 102     <arg direction="in" name="endPos" type="i"/>
 103     <arg direction="out" type="b" tp:type="boolean">
 104     <tp:docstring>
 105       \c True if the text was successfully cut, \c False otherwise.
 106     </tp:docstring>
 107     </arg>
 108   </method>
 109   <method name="deleteText">
 110     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 111       <p>Excise a range of text from a Text object without copying it into the system clipboard.
 112         @param startPos the character offset of the first character in the range of text being
 113         deleted.
 114         @param endPos the offset of the first character past the end of the range of text
 115         being deleted.</p>
 116     </tp:docstring>
 117     <arg direction="in" name="startPos" type="i"/>
 118     <arg direction="in" name="endPos" type="i"/>
 119     <arg direction="out" type="b" tp:type="boolean">
 120     <tp:docstring>
 121       \c True if the text was successfully deleted, \c False otherwise.
 122     </tp:docstring>
 123     </arg>
 124   </method>
 125   <method name="pasteText">
 126     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 127       <p>Copy the text contents of the system clipboard, if any, into a Text object,
 128         inserting it at a particular character offset.    </p>
 129
 130       <p>@param position the character offset before which the text will be inserted.</p>
 131     </tp:docstring>
 132     <arg direction="in" name="position" type="i"/>
 133     <arg direction="out" type="b" tp:type="boolean">
 134     <tp:docstring>
 135       \c True if the text was successfully pasted into the Text object, \c False otherwise.
 136     </tp:docstring>
 137     </arg>
 138   </method>
 139   <method name="unImplemented5">
 140     <tp:docstring xmlns="http://www.w3.org/1999/xhtml">
 141       <p>unImplemented:    </p>
 142
 143       <p>placeholders for future expansion. Note that these are named
 144         'unimplemented5 and unimplemented6' to avoid conflict with
 145         placeholders from Accessibility::Text.</p>
 146     </tp:docstring>
 147   </method>
 148   <method name="unImplemented6">
 149   </method>
 150   <method name="unImplemented9">
 151   </method>
 152   <method name="unImplemented10">
 153   </method>
 154   <method name="unImplemented11">
 155   </method>
 156   <method name="unImplemented12">
 157   </method>
 158 </interface>
 159 </node>