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>
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>
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>
20 <arg direction="in" name="newContents" type="s">
22 A UTF-8 string with which the text object's contents will be replaced.
25 <arg direction="out" type="b" tp:type="boolean">
27 <code>True</code> if the text content was successfully changed, <code>False</code> otherwise.
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
37 <arg direction="in" name="position" type="i">
39 The character offset into the Text implementor's content at which the
40 new content will be inserted.
43 <arg direction="in" name="text" type="s">
45 A UTF-8 string of which <code>length</code> characters will be inserted into the text
49 <arg direction="in" name="length" type="i">
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.
56 <arg direction="out" type="b" tp:type="boolean">
58 <code>True</code> if the text content was successfully inserted, <code>False</code> otherwise.
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>
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">
71 <code>True</code> if the text attributes were successfully modified, <code>False</code> otherwise.
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.
80 <arg direction="in" name="startPos" type="i">
82 The character offset of the first character in the range of text being
86 <arg direction="in" name="endPos" type="i">
88 The offset of the first character past the end of the range of text
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>
97 <arg direction="in" name="startPos" type="i">
99 The character offset of the first character in the range of text being
103 <arg direction="in" name="endPos" type="i">
105 The offset of the first character past the end of the range of text
109 <arg direction="out" type="b" tp:type="boolean">
111 <code>True</code> if the text was successfully cut, <code>False</code> otherwise.
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>
119 <arg direction="in" name="startPos" type="i">
121 The character offset of the first character in the range of text being
125 <arg direction="in" name="endPos" type="i">
127 The offset of the first character past the end of the range of text
131 <arg direction="out" type="b" tp:type="boolean">
133 <code>True</code> if the text was successfully deleted, <code>False</code> otherwise.
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>
142 <arg direction="in" name="position" type="i">
144 <p>The character offset before which the text will be inserted.</p>
147 <arg direction="out" type="b" tp:type="boolean">
149 <code>True</code> if the text was successfully pasted into the Text object, <code>False</code> otherwise.