File: class-gtktextchildanchor.html

package info (click to toggle)
python-gtk2-doc 2.5.2-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 8,304 kB
  • ctags: 3,741
  • sloc: makefile: 38
file content (23 lines) | stat: -rw-r--r-- 7,366 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>gtk.TextChildAnchor</title><meta name="generator" content="DocBook XSL Stylesheets V1.65.1"><link rel="home" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gtk-class-reference.html" title="The gtk Class Reference"><link rel="previous" href="class-gtktextbuffer.html" title="gtk.TextBuffer"><link rel="next" href="class-gtktextiter.html" title="gtk.TextIter"></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">gtk.TextChildAnchor</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gtktextbuffer.html">Prev</a></td><th width="60%" align="center">The gtk Class Reference</th><td width="20%" align="right"><a accesskey="n" href="class-gtktextiter.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gtktextchildanchor"></a><div class="titlepage"><div></div><div></div></div><div class="refnamediv"><h2>gtk.TextChildAnchor</h2><p>gtk.TextChildAnchor &#8212; a location in a textbuffer for placing widgets</p></div><div class="refsect1" lang="en"><a name="id3535876"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.TextChildAnchor</span></span>(<span class="ooclass"><span class="classname"><a href="class-gobject.html" title="gobject.GObject">gobject.GObject</a></span></span>):
<code class="constructorsynopsis">    <span class="methodname"><a href="class-gtktextchildanchor.html#constructor-gtktextchildanchor" title="Constructor">gtk.TextChildAnchor</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gtktextchildanchor.html#method-gtktextchildanchor--get-widgets" title="gtk.TextChildAnchor.get_widgets">get_widgets</a></span>(<span class="methodparam"></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a href="class-gtktextchildanchor.html#method-gtktextchildanchor--get-deleted" title="gtk.TextChildAnchor.get_deleted">get_deleted</a></span>(<span class="methodparam"></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3535951"></a><h2>Ancestry</h2><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="synopsis">+-- <a href="class-gobject.html" title="gobject.GObject">gobject.GObject</a>
  +-- <a href="class-gtktextchildanchor.html" title="gtk.TextChildAnchor">gtk.TextChildAnchor</a>
</pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3535975"></a><h2>Description</h2><p>A <a href="class-gtktextchildanchor.html" title="gtk.TextChildAnchor"><tt class="classname">gtk.TextChildAnchor</tt></a> 
provides a location in a <a href="class-gtktextbuffer.html" title="gtk.TextBuffer"><tt class="classname">gtk.TextBuffer</tt></a>
for placing child widgets in a <a href="class-gtktextview.html" title="gtk.TextView"><tt class="classname">gtk.TextView</tt></a>.
Since a <a href="class-gtktextbuffer.html" title="gtk.TextBuffer"><tt class="classname">gtk.TextBuffer</tt></a>
can be associated with more than one <a href="class-gtktextview.html" title="gtk.TextView"><tt class="classname">gtk.TextView</tt></a> a
<a href="class-gtktextchildanchor.html" title="gtk.TextChildAnchor"><tt class="classname">gtk.TextChildAnchor</tt></a> 
can have a different child widget inserted for each textview it is displayed
in.</p></div><div class="refsect1" lang="en"><a name="constructor-gtktextchildanchor"></a><h2>Constructor</h2><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="constructorsynopsis">    <span class="methodname">gtk.TextChildAnchor</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a new <a href="class-gtktextchildanchor.html" title="gtk.TextChildAnchor"><tt class="classname">gtk.TextChildAnchor</tt></a> 
object</td></tr></tbody></table><p>Creates a new <a href="class-gtktextchildanchor.html" title="gtk.TextChildAnchor"><tt class="classname">gtk.TextChildAnchor</tt></a>. 
Usually you would then insert it into a <a href="class-gtktextbuffer.html" title="gtk.TextBuffer"><tt class="classname">gtk.TextBuffer</tt></a>
with the <a href="class-gtktextbuffer.html#method-gtktextbuffer--insert-child-anchor" title="gtk.TextBuffer.insert_child_anchor"><tt class="methodname">gtk.TextBuffer.insert_child_anchor</tt>()</a> 
method. To perform the creation and insertion in one step, use the
convenience method <a href="class-gtktextbuffer.html#method-gtktextbuffer--create-child-anchor" title="gtk.TextBuffer.create_child_anchor"><tt class="methodname">gtk.TextBuffer.create_child_anchor</tt>()</a> 
method.</p></div><div class="refsect1" lang="en"><a name="id3536123"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gtktextchildanchor--get-widgets"></a><h3>gtk.TextChildAnchor.get_widgets</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_widgets</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td>a list of widgets anchored at the child
anchor</td></tr></tbody></table><p>The <tt class="methodname">get_widgets</tt>() method returns a list
of all widgets anchored at this child anchor from all the associated
textviews.</p></div><div class="refsect2" lang="en"><a name="method-gtktextchildanchor--get-deleted"></a><h3>gtk.TextChildAnchor.get_deleted</h3><table border="0" bgcolor="#E0E0E0" width="100%"><tr><td><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">get_deleted</span>(<span class="methodparam"></span>)</code></pre></td></tr></table><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span>:</span></td><td><tt class="literal">TRUE</tt> if the child anchor has
been deleted from its textbuffer</td></tr></tbody></table><p>The <tt class="methodname">get_deleted</tt>() method returns
<tt class="literal">TRUE</tt> if the child anchor has been deleted from its
textbuffer.</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-gtktextbuffer.html">Prev</a></td><td width="20%" align="center"><a accesskey="u" href="gtk-class-reference.html">Up</a></td><td width="40%" align="right"><a accesskey="n" href="class-gtktextiter.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top">gtk.TextBuffer</td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top">gtk.TextIter</td></tr></table></div></body></html>