doc/libatspi/html/libatspi-atspi-editabletext.html

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