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