xml/org.freedesktop.atspi.EditableText.xml

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