/usr/share/gtk-doc/html/pygtk/class-atkeditabletext.html is in python-gtk2-doc 2.24.0-4ubuntu1.
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 | <html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>atk.EditableText</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.2"><link rel="home" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="atk-class-reference.html" title="The atk Class Reference"><link rel="prev" href="class-atkdocument.html" title="atk.Document"><link rel="next" href="class-atkgobjectaccessible.html" title="atk.GObjectAccessible"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">atk.EditableText</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-atkdocument.html">Prev</a> </td><th width="60%" align="center">The atk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-atkgobjectaccessible.html">Next</a></td></tr></table><hr></div><div class="refentry" title="atk.EditableText"><a name="class-atkeditabletext"></a><div class="titlepage"></div><div class="refnamediv"><h2>atk.EditableText</h2><p>atk.EditableText — the ATK interface implemented by components containing
user-editable text content. </p></div><div class="refsect1" title="Synopsis"><a name="id2969874"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">atk.EditableText</span></span>(<span class="ooclass"><span class="classname">gobject.GInterface</span></span>):
<code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkeditabletext.html#method-atkeditabletext--set-run-attributes" title="atk.EditableText.set_run_attributes">set_run_attributes</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>attrib_set</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>start_offset</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>end_offset</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkeditabletext.html#method-atkeditabletext--set-text-contents" title="atk.EditableText.set_text_contents">set_text_contents</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>string</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkeditabletext.html#method-atkeditabletext--insert-text" title="atk.EditableText.insert_text">insert_text</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>string</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>length</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>position</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkeditabletext.html#method-atkeditabletext--copy-text" title="atk.EditableText.copy_text">copy_text</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>start_pos</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>end_pos</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkeditabletext.html#method-atkeditabletext--cut-text" title="atk.EditableText.cut_text">cut_text</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>start_pos</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>end_pos</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkeditabletext.html#method-atkeditabletext--delete-text" title="atk.EditableText.delete_text">delete_text</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>start_pos</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>end_pos</code></strong></span></span>)</code><br><code class="methodsynopsis"> def <span class="methodname"><a class="link" href="class-atkeditabletext.html#method-atkeditabletext--paste-text" title="atk.EditableText.paste_text">paste_text</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>position</code></strong></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Description"><a name="id2952212"></a><h2>Description</h2><p><a class="link" href="class-atkeditabletext.html" title="atk.EditableText"><code class="classname">atk.EditableText</code></a>
should be implemented by UI components which contain text which the user
can edit, via the <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>
corresponding to that component (see <a class="link" href="class-atkobject.html" title="atk.Object"><code class="classname">atk.Object</code></a>).</p><p><a class="link" href="class-atkeditabletext.html" title="atk.EditableText"><code class="classname">atk.EditableText</code></a>
is a subclass of <a class="link" href="class-atktext.html" title="atk.Text"><code class="classname">atk.Text</code></a>, and as
such, an object which implements <a class="link" href="class-atkeditabletext.html" title="atk.EditableText"><code class="classname">atk.EditableText</code></a>
is by definition an <a class="link" href="class-atktext.html" title="atk.Text"><code class="classname">atk.Text</code></a>
implementor as well.</p></div><div class="refsect1" title="Methods"><a name="id2975428"></a><h2>Methods</h2><div class="refsect2" title="atk.EditableText.set_run_attributes"><a name="method-atkeditabletext--set-run-attributes"></a><h3>atk.EditableText.set_run_attributes</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_run_attributes</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>attrib_set</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>start_offset</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>end_offset</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>attrib_set</code></strong> :</span></p></td><td>a sequence of 2-tuples containing name-value
string pairs.</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>start_offset</code></strong> :</span></p></td><td>start of range in which to set
attributes</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>end_offset</code></strong> :</span></p></td><td>end of range in which to set
attributes</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td><code class="literal">True</code> if attributes were
successfully set for the specified range, otherwise
<code class="literal">False</code></td></tr></tbody></table><p>Sets the attributes for a specified range. See the <a class="xref" href="atk-constants.html#atk-text-attr-constants" title="Atk Text Attribute Constants">Atk Text Attribute Constants</a> (such as
<code class="literal">atk.TEXT_ATTR_LEFT_MARGIN</code>) for examples of
attributes that can be set. Note that other attributes that do not
have corresponding <a class="xref" href="atk-constants.html#atk-text-attr-constants" title="Atk Text Attribute Constants">Atk Text Attribute Constants</a> may also be set for
certain text widgets.</p></div><div class="refsect2" title="atk.EditableText.set_text_contents"><a name="method-atkeditabletext--set-text-contents"></a><h3>atk.EditableText.set_text_contents</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">set_text_contents</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>string</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>string</code></strong> :</span></p></td><td>string to set for text contents of the
text</td></tr></tbody></table><p>Set text contents of the text.</p></div><div class="refsect2" title="atk.EditableText.insert_text"><a name="method-atkeditabletext--insert-text"></a><h3>atk.EditableText.insert_text</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">insert_text</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>string</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>length</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>position</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>string</code></strong> :</span></p></td><td>the text to insert</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>length</code></strong> :</span></p></td><td>the length of text to insert, in bytes</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>position</code></strong> :</span></p></td><td>the position at which to insert the text</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>the position after the newly inserted
text.</td></tr></tbody></table><p>Insert text at a given position.</p></div><div class="refsect2" title="atk.EditableText.copy_text"><a name="method-atkeditabletext--copy-text"></a><h3>atk.EditableText.copy_text</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">copy_text</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>start_pos</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>end_pos</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>start_pos</code></strong> :</span></p></td><td>start position</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>end_pos</code></strong> :</span></p></td><td>end position</td></tr></tbody></table><p>Copy text from <em class="parameter"><code>start_pos</code></em> up to, but not
including <em class="parameter"><code>end_pos</code></em> to the clipboard.</p></div><div class="refsect2" title="atk.EditableText.cut_text"><a name="method-atkeditabletext--cut-text"></a><h3>atk.EditableText.cut_text</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">cut_text</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>start_pos</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>end_pos</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>start_pos</code></strong> :</span></p></td><td>start position</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>end_pos</code></strong> :</span></p></td><td>end position</td></tr></tbody></table><p>Copy text from <em class="parameter"><code>start_pos</code></em> up to, but not
including <em class="parameter"><code>end_pos</code></em> to the clipboard and then
delete from the widget.</p></div><div class="refsect2" title="atk.EditableText.delete_text"><a name="method-atkeditabletext--delete-text"></a><h3>atk.EditableText.delete_text</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">delete_text</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>start_pos</code></strong></span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>end_pos</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>start_pos</code></strong> :</span></p></td><td>start position</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>end_pos</code></strong> :</span></p></td><td>end position</td></tr></tbody></table><p>Delete text <em class="parameter"><code>start_pos</code></em> up to, but not
including <em class="parameter"><code>end_pos</code></em>.</p></div><div class="refsect2" title="atk.EditableText.paste_text"><a name="method-atkeditabletext--paste-text"></a><h3>atk.EditableText.paste_text</h3><pre class="programlisting"><code class="methodsynopsis"> def <span class="methodname">paste_text</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>position</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>position</code></strong> :</span></p></td><td>position to paste</td></tr></tbody></table><p>Paste text from clipboard to the specified
<em class="parameter"><code>position</code></em>.</p></div></div></div><div class="navfooter"><hr><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="class-atkdocument.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="atk-class-reference.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="class-atkgobjectaccessible.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">atk.Document </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> atk.GObjectAccessible</td></tr></table></div></body></html>
|