<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>AtkEditableText</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.64.1">
<link rel="home" href="index.html" title="ATK - Accessibility Toolkit">
<link rel="up" href="atk.html" title="ATK Library">
<link rel="previous" href="AtkDocument.html" title="AtkDocument">
<link rel="next" href="AtkGObjectAccessible.html" title="AtkGObjectAccessible">
<meta name="generator" content="GTK-Doc V1.4 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
<link rel="chapter" href="atk.html" title="ATK Library">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle">
<td><a accesskey="p" href="AtkDocument.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="atk.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">ATK - Accessibility Toolkit</th>
<td><a accesskey="n" href="AtkGObjectAccessible.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry" lang="en">
<a name="AtkEditableText"></a><div class="titlepage">
<div></div>
<div></div>
</div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle">AtkEditableText</span></h2>
<p>AtkEditableText — The ATK interface implemented by components containing user-editable text content.</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Synopsis</h2>
<pre class="synopsis">
<a href="AtkEditableText.html#AtkEditableText-struct">AtkEditableText</a>;
<a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> <a href="AtkEditableText.html#atk-editable-text-set-run-attributes">atk_editable_text_set_run_attributes</a>
(<a href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
<a href="AtkText.html#AtkAttributeSet">AtkAttributeSet</a> *attrib_set,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> start_offset,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> end_offset);
<a
href="../gss/gss-ext.html#void"
>void</a> <a href="AtkEditableText.html#atk-editable-text-set-text-contents">atk_editable_text_set_text_contents</a>
(<a href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *string);
<a
href="../gss/gss-ext.html#void"
>void</a> <a href="AtkEditableText.html#atk-editable-text-insert-text">atk_editable_text_insert_text</a> (<a href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *string,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> length,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *position);
<a
href="../gss/gss-ext.html#void"
>void</a> <a href="AtkEditableText.html#atk-editable-text-copy-text">atk_editable_text_copy_text</a> (<a href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> start_pos,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> end_pos);
<a
href="../gss/gss-ext.html#void"
>void</a> <a href="AtkEditableText.html#atk-editable-text-cut-text">atk_editable_text_cut_text</a> (<a href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> start_pos,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> end_pos);
<a
href="../gss/gss-ext.html#void"
>void</a> <a href="AtkEditableText.html#atk-editable-text-delete-text">atk_editable_text_delete_text</a> (<a href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> start_pos,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> end_pos);
<a
href="../gss/gss-ext.html#void"
>void</a> <a href="AtkEditableText.html#atk-editable-text-paste-text">atk_editable_text_paste_text</a> (<a href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> position);
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id268689"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GInterface
+----AtkEditableText
</pre>
</div>
<div class="refsect1" lang="en">
<a name="id268708"></a><h2>Known Implementations</h2>
<p>
AtkEditableText is implemented by
<a href="AtkNoOpObject.html" title="AtkNoOpObject">AtkNoOpObject</a>.</p>
</div>
<div class="refsect1" lang="en">
<a name="id268725"></a><h2>Description</h2>
<p>
<a href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> should be implemented by UI components which contain
text which the user can edit, via the <a href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a> corresponding to that
component (see <a href="AtkObject.html" title="AtkObject"><span class="type">AtkObject</span></a>).
</p>
<p>
<a href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> is a subclass of <a href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>, and as such, an object which
implements <a href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a> is by definition an <a href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a> implementor as well.
</p>
</div>
<div class="refsect1" lang="en">
<a name="id268795"></a><h2>Details</h2>
<div class="refsect2" lang="en">
<a name="id268800"></a><h3>
<a name="AtkEditableText-struct"></a>AtkEditableText</h3>
<a class="indexterm" name="id268810"></a><pre class="programlisting">typedef struct _AtkEditableText AtkEditableText;</pre>
<p>
The AtkEditableText structure does not contain any fields.
</p>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id268826"></a><h3>
<a name="atk-editable-text-set-run-attributes"></a>atk_editable_text_set_run_attributes ()</h3>
<a class="indexterm" name="id268836"></a><pre class="programlisting"><a
href="../glib/glib-Basic-Types.html#gboolean"
>gboolean</a> atk_editable_text_set_run_attributes
(<a href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
<a href="AtkText.html#AtkAttributeSet">AtkAttributeSet</a> *attrib_set,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> start_offset,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> end_offset);</pre>
<p>
Sets the attributes for a specified range. See the ATK_ATTRIBUTE
macros (such as <span class="type">ATK_ATTRIBUTE_LEFT_MARGIN</span>) for examples of attributes
that can be set. Note that other attributes that do not have corresponding
ATK_ATTRIBUTE macros may also be set for certain text widgets.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><i class="parameter"><tt>text</tt></i> :</span></td>
<td> an <a href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>attrib_set</tt></i> :</span></td>
<td> an <a href="AtkText.html#AtkAttributeSet"><span class="type">AtkAttributeSet</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>start_offset</tt></i> :</span></td>
<td> start of range in which to set attributes
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>end_offset</tt></i> :</span></td>
<td> end of range in which to set attributes
</td>
</tr>
<tr>
<td>
<span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>
<td> <tt class="literal">TRUE</tt> if attributes successfully set for the specified
range, otherwise <tt class="literal">FALSE</tt>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id268998"></a><h3>
<a name="atk-editable-text-set-text-contents"></a>atk_editable_text_set_text_contents ()</h3>
<a class="indexterm" name="id269008"></a><pre class="programlisting"><a
href="../gss/gss-ext.html#void"
>void</a> atk_editable_text_set_text_contents
(<a href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *string);</pre>
<p>
Set text contents of <i class="parameter"><tt>text</tt></i>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><i class="parameter"><tt>text</tt></i> :</span></td>
<td> an <a href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>string</tt></i> :</span></td>
<td> string to set for text contents of <i class="parameter"><tt>text</tt></i>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id269098"></a><h3>
<a name="atk-editable-text-insert-text"></a>atk_editable_text_insert_text ()</h3>
<a class="indexterm" name="id269108"></a><pre class="programlisting"><a
href="../gss/gss-ext.html#void"
>void</a> atk_editable_text_insert_text (<a href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
const <a
href="../glib/glib-Basic-Types.html#gchar"
>gchar</a> *string,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> length,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> *position);</pre>
<p>
Insert text at a given position.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><i class="parameter"><tt>text</tt></i> :</span></td>
<td> an <a href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>string</tt></i> :</span></td>
<td> the text to insert
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>length</tt></i> :</span></td>
<td> the length of text to insert, in bytes
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>position</tt></i> :</span></td>
<td> The caller initializes this to
the position at which to insert the text. After the call it
points at the position after the newly inserted text.
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id269229"></a><h3>
<a name="atk-editable-text-copy-text"></a>atk_editable_text_copy_text ()</h3>
<a class="indexterm" name="id269239"></a><pre class="programlisting"><a
href="../gss/gss-ext.html#void"
>void</a> atk_editable_text_copy_text (<a href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> start_pos,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> end_pos);</pre>
<p>
Copy text from <i class="parameter"><tt>start_pos</tt></i> up to, but not including <i class="parameter"><tt>end_pos</tt></i>
to the clipboard.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><i class="parameter"><tt>text</tt></i> :</span></td>
<td> an <a href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>start_pos</tt></i> :</span></td>
<td> start position
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>end_pos</tt></i> :</span></td>
<td> end position
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id269350"></a><h3>
<a name="atk-editable-text-cut-text"></a>atk_editable_text_cut_text ()</h3>
<a class="indexterm" name="id269361"></a><pre class="programlisting"><a
href="../gss/gss-ext.html#void"
>void</a> atk_editable_text_cut_text (<a href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> start_pos,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> end_pos);</pre>
<p>
Copy text from <i class="parameter"><tt>start_pos</tt></i> up to, but not including <i class="parameter"><tt>end_pos</tt></i>
to the clipboard and then delete from the widget.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><i class="parameter"><tt>text</tt></i> :</span></td>
<td> an <a href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>start_pos</tt></i> :</span></td>
<td> start position
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>end_pos</tt></i> :</span></td>
<td> end position
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id269472"></a><h3>
<a name="atk-editable-text-delete-text"></a>atk_editable_text_delete_text ()</h3>
<a class="indexterm" name="id269482"></a><pre class="programlisting"><a
href="../gss/gss-ext.html#void"
>void</a> atk_editable_text_delete_text (<a href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> start_pos,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> end_pos);</pre>
<p>
Delete text <i class="parameter"><tt>start_pos</tt></i> up to, but not including <i class="parameter"><tt>end_pos</tt></i>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><i class="parameter"><tt>text</tt></i> :</span></td>
<td> an <a href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>start_pos</tt></i> :</span></td>
<td> start position
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>end_pos</tt></i> :</span></td>
<td> end position
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2" lang="en">
<a name="id269593"></a><h3>
<a name="atk-editable-text-paste-text"></a>atk_editable_text_paste_text ()</h3>
<a class="indexterm" name="id269603"></a><pre class="programlisting"><a
href="../gss/gss-ext.html#void"
>void</a> atk_editable_text_paste_text (<a href="AtkEditableText.html" title="AtkEditableText">AtkEditableText</a> *text,
<a
href="../glib/glib-Basic-Types.html#gint"
>gint</a> position);</pre>
<p>
Paste text from clipboard to specified <i class="parameter"><tt>position</tt></i>.</p>
<p>
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td>
<span class="term"><i class="parameter"><tt>text</tt></i> :</span></td>
<td> an <a href="AtkEditableText.html" title="AtkEditableText"><span class="type">AtkEditableText</span></a>
</td>
</tr>
<tr>
<td>
<span class="term"><i class="parameter"><tt>position</tt></i> :</span></td>
<td> position to paste
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="refsect1" lang="en">
<a name="id269688"></a><h2>See Also</h2>
<p>
<a href="AtkText.html" title="AtkText"><span class="type">AtkText</span></a>
</p>
</div>
</div>
<table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle">
<td align="left"><a accesskey="p" href="AtkDocument.html"><b><< AtkDocument</b></a></td>
<td align="right"><a accesskey="n" href="AtkGObjectAccessible.html"><b>AtkGObjectAccessible >></b></a></td>
</tr></table>
</body>
</html>
