/usr/share/gtk-doc/html/libatspi/libatspi-atspi-editabletext.html is in at-spi2-doc 2.4.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>atspi-editabletext</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="libatspi Reference Manual">
<link rel="up" href="ch01.html" title="API reference">
<link rel="prev" href="AtspiHyperlink.html" title="atspi-hyperlink">
<link rel="next" href="libatspi-atspi-value.html" title="atspi-value">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="AtspiHyperlink.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">libatspi Reference Manual</th>
<td><a accesskey="n" href="libatspi-atspi-value.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libatspi-atspi-editabletext.synopsis" class="shortcut">Top</a>
|
<a href="#libatspi-atspi-editabletext.description" class="shortcut">Description</a>
|
<a href="#libatspi-atspi-editabletext.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#libatspi-atspi-editabletext.implementations" class="shortcut">Known Implementations</a>
</td></tr>
</table>
<div class="refentry">
<a name="libatspi-atspi-editabletext"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libatspi-atspi-editabletext.top_of_page"></a>atspi-editabletext</span></h2>
<p>atspi-editabletext — An interface that provides methods for modifying textual content
of components which support editing.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libatspi-atspi-editabletext.synopsis"></a><h2>Synopsis</h2>
<a name="AtspiEditableText"></a><pre class="synopsis"> <a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText-struct" title="AtspiEditableText">AtspiEditableText</a>;
<span class="returnvalue">gboolean</span> <a class="link" href="libatspi-atspi-editabletext.html#atspi-editable-text-set-attributes" title="atspi_editable_text_set_attributes ()">atspi_editable_text_set_attributes</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText"><span class="type">AtspiEditableText</span></a> *obj</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *attributes</code></em>,
<em class="parameter"><code><span class="type">gint</span> start_pos</code></em>,
<em class="parameter"><code><span class="type">gint</span> end_pos</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libatspi-atspi-editabletext.html#atspi-editable-text-insert-text" title="atspi_editable_text_insert_text ()">atspi_editable_text_insert_text</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText"><span class="type">AtspiEditableText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> position</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>,
<em class="parameter"><code><span class="type">gint</span> length</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libatspi-atspi-editabletext.html#atspi-editable-text-copy-text" title="atspi_editable_text_copy_text ()">atspi_editable_text_copy_text</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText"><span class="type">AtspiEditableText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> start_pos</code></em>,
<em class="parameter"><code><span class="type">gint</span> end_pos</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libatspi-atspi-editabletext.html#atspi-editable-text-cut-text" title="atspi_editable_text_cut_text ()">atspi_editable_text_cut_text</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText"><span class="type">AtspiEditableText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> start_pos</code></em>,
<em class="parameter"><code><span class="type">gint</span> end_pos</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libatspi-atspi-editabletext.html#atspi-editable-text-delete-text" title="atspi_editable_text_delete_text ()">atspi_editable_text_delete_text</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText"><span class="type">AtspiEditableText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> start_pos</code></em>,
<em class="parameter"><code><span class="type">gint</span> end_pos</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
<span class="returnvalue">gboolean</span> <a class="link" href="libatspi-atspi-editabletext.html#atspi-editable-text-paste-text" title="atspi_editable_text_paste_text ()">atspi_editable_text_paste_text</a> (<em class="parameter"><code><a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText"><span class="type">AtspiEditableText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> position</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libatspi-atspi-editabletext.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GInterface
+----AtspiEditableText
</pre>
</div>
<div class="refsect1">
<a name="libatspi-atspi-editabletext.implementations"></a><h2>Known Implementations</h2>
<p>
AtspiEditableText is implemented by
<a class="link" href="AtspiAccessible.html" title="AtspiAccessible">AtspiAccessible</a>.</p>
</div>
<div class="refsect1">
<a name="libatspi-atspi-editabletext.description"></a><h2>Description</h2>
<p>
Derived from atspi-text, the atspi-editabletext interface
provides methods for modifying textual content of components
which support editing. EditableText also interacts with the
system clipboard via copy, cut, and paste methods.
</p>
</div>
<div class="refsect1">
<a name="libatspi-atspi-editabletext.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="AtspiEditableText-struct"></a><h3>AtspiEditableText</h3>
<pre class="programlisting">typedef struct _AtspiEditableText AtspiEditableText;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="atspi-editable-text-set-attributes"></a><h3>atspi_editable_text_set_attributes ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> atspi_editable_text_set_attributes (<em class="parameter"><code><a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText"><span class="type">AtspiEditableText</span></a> *obj</code></em>,
<em class="parameter"><code>const <span class="type">char</span> *attributes</code></em>,
<em class="parameter"><code><span class="type">gint</span> start_pos</code></em>,
<em class="parameter"><code><span class="type">gint</span> end_pos</code></em>);</pre>
<p>
Sets the attributes applied to a range of text from an <a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText"><span class="type">AtspiEditableText</span></a>
object, and the bounds of the range.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText"><span class="type">AtspiEditableText</span></a> object to modify.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>attributes</code></em> :</span></p></td>
<td>a string indicating the attributes to apply to the range,
delimited by ':'.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if the operation was successful, otherwise <span class="type">FALSE</span>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-editable-text-insert-text"></a><h3>atspi_editable_text_insert_text ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> atspi_editable_text_insert_text (<em class="parameter"><code><a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText"><span class="type">AtspiEditableText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> position</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>,
<em class="parameter"><code><span class="type">gint</span> length</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Inserts text into an <a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText"><span class="type">AtspiEditableText</span></a> object.
As with all character offsets, the specified <em class="parameter"><code>position</code></em> may not be the
same as the resulting byte offset, since the text is in a
variable-width encoding.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText"><span class="type">AtspiEditableText</span></a> object to modify.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
<td>a <span class="type">gint</span> indicating the character offset at which to insert
the new text.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>text</code></em> :</span></p></td>
<td>a string representing the text to insert, in UTF-8 encoding.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>length</code></em> :</span></p></td>
<td>the number of characters of text to insert. If the character
count of text is less than or equal to length, the entire contents
of text will be inserted.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if the operation was successful, otherwise <span class="type">FALSE</span>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-editable-text-copy-text"></a><h3>atspi_editable_text_copy_text ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> atspi_editable_text_copy_text (<em class="parameter"><code><a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText"><span class="type">AtspiEditableText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> start_pos</code></em>,
<em class="parameter"><code><span class="type">gint</span> end_pos</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Copies text from an <a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText"><span class="type">AtspiEditableText</span></a> object into the system clipboard.
</p>
<p>
see: <a class="link" href="libatspi-atspi-editabletext.html#atspi-editable-text-paste-text" title="atspi_editable_text_paste_text ()"><span class="type">atspi_editable_text_paste_text</span></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText"><span class="type">AtspiEditableText</span></a> object to modify.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>start_pos</code></em> :</span></p></td>
<td>a <span class="type">gint</span> indicating the starting character offset
of the text to copy.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>end_pos</code></em> :</span></p></td>
<td>a <span class="type">gint</span> indicating the offset of the first character
past the end of the text section to be copied.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if the operation was successful, otherwise <span class="type">FALSE</span>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-editable-text-cut-text"></a><h3>atspi_editable_text_cut_text ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> atspi_editable_text_cut_text (<em class="parameter"><code><a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText"><span class="type">AtspiEditableText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> start_pos</code></em>,
<em class="parameter"><code><span class="type">gint</span> end_pos</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Deletes text from an <a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText"><span class="type">AtspiEditableText</span></a> object, copying the
excised portion into the system clipboard.
</p>
<p>
see: <a class="link" href="libatspi-atspi-editabletext.html#atspi-editable-text-paste-text" title="atspi_editable_text_paste_text ()"><span class="type">atspi_editable_text_paste_text</span></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText"><span class="type">AtspiEditableText</span></a> object to modify.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>start_pos</code></em> :</span></p></td>
<td>a <span class="type">gint</span> indicating the starting character offset
of the text to cut.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>end_pos</code></em> :</span></p></td>
<td>a <span class="type">gint</span> indicating the offset of the first character
past the end of the text section to be cut.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if operation was successful, <span class="type">FALSE</span> otherwise.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-editable-text-delete-text"></a><h3>atspi_editable_text_delete_text ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> atspi_editable_text_delete_text (<em class="parameter"><code><a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText"><span class="type">AtspiEditableText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> start_pos</code></em>,
<em class="parameter"><code><span class="type">gint</span> end_pos</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Deletes text from an <a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText"><span class="type">AtspiEditableText</span></a> object, without copying the
excised portion into the system clipboard.
</p>
<p>
see: <a class="link" href="libatspi-atspi-editabletext.html#atspi-editable-text-cut-text" title="atspi_editable_text_cut_text ()"><span class="type">atspi_editable_text_cut_text</span></a>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText"><span class="type">AtspiEditableText</span></a> object to modify.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>start_pos</code></em> :</span></p></td>
<td>a <span class="type">gint</span> indicating the starting character offset
of the text to delete.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>end_pos</code></em> :</span></p></td>
<td>a <span class="type">gint</span> indicating the offset of the first character
past the end of the text section to be deleted.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if the operation was successful, otherwise <span class="type">FALSE</span>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="atspi-editable-text-paste-text"></a><h3>atspi_editable_text_paste_text ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span> atspi_editable_text_paste_text (<em class="parameter"><code><a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText"><span class="type">AtspiEditableText</span></a> *obj</code></em>,
<em class="parameter"><code><span class="type">gint</span> position</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>
Inserts text from the system clipboard into an <a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText"><span class="type">AtspiEditableText</span></a> object.
As with all character offsets, the specified <em class="parameter"><code>position</code></em> may not be the
same as the resulting byte offset, since the text is in a
variable-width encoding.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>obj</code></em> :</span></p></td>
<td>a pointer to the <a class="link" href="libatspi-atspi-editabletext.html#AtspiEditableText"><span class="type">AtspiEditableText</span></a> object to modify.</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>position</code></em> :</span></p></td>
<td>a <span class="type">gint</span> indicating the character offset at which to insert
the new text.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>
<span class="type">TRUE</span> if the operation was successful, otherwise <span class="type">FALSE</span>.</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|