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
|
<?xml version="1.0" standalone="no"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="class-gtktextchildanchor">
<refnamediv>
<refname>gtk.TextChildAnchor</refname>
<refpurpose>a location in a textbuffer for placing widgets</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.TextChildAnchor</classname></ooclass>
<ooclass><classname><link
linkend="class-gobject">gobject.GObject</link></classname></ooclass>
<constructorsynopsis language="python">
<methodname><link
linkend="constructor-gtktextchildanchor">gtk.TextChildAnchor</link></methodname>
<methodparam></methodparam> </constructorsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtktextchildanchor--get-widgets">get_widgets</link></methodname>
<methodparam></methodparam> </methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gtktextchildanchor--get-deleted">get_deleted</link></methodname>
<methodparam></methodparam> </methodsynopsis>
</classsynopsis>
</refsect1>
<refsect1>
<title>Ancestry</title>
<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
+-- <link linkend="class-gtktextchildanchor">gtk.TextChildAnchor</link>
</synopsis>
</refsect1>
<refsect1 id="signal-prototypes-gtktextchildanchor">
<title>gtk.TextChildAnchor Signal Prototypes</title>
<para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
</refsect1>
<refsect1>
<title>Description</title>
<para>A <link
linkend="class-gtktextchildanchor"><classname>gtk.TextChildAnchor</classname></link>
provides a location in a <link
linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
for placing child widgets in a <link
linkend="class-gtktextview"><classname>gtk.TextView</classname></link>.
Since a <link
linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
can be associated with more than one <link
linkend="class-gtktextview"><classname>gtk.TextView</classname></link> a
<link
linkend="class-gtktextchildanchor"><classname>gtk.TextChildAnchor</classname></link>
can have a different child widget inserted for each textview it is displayed
in.</para>
</refsect1>
<refsect1 id="constructor-gtktextchildanchor">
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
<methodname>gtk.TextChildAnchor</methodname>
<methodparam></methodparam> </constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new <link
linkend="class-gtktextchildanchor"><classname>gtk.TextChildAnchor</classname></link>
object</simpara></listitem>
</varlistentry>
</variablelist>
<para>Creates a new <link
linkend="class-gtktextchildanchor"><classname>gtk.TextChildAnchor</classname></link>.
Usually you would then insert it into a <link
linkend="class-gtktextbuffer"><classname>gtk.TextBuffer</classname></link>
with the <link
linkend="method-gtktextbuffer--insert-child-anchor"><methodname>gtk.TextBuffer.insert_child_anchor</methodname>()</link>
method. To perform the creation and insertion in one step, use the
convenience method <link
linkend="method-gtktextbuffer--create-child-anchor"><methodname>gtk.TextBuffer.create_child_anchor</methodname>()</link>
method.</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gtktextchildanchor--get-widgets">
<title>gtk.TextChildAnchor.get_widgets</title>
<programlisting><methodsynopsis language="python">
<methodname>get_widgets</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a list of widgets anchored at the child
anchor</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>get_widgets</methodname>() method returns a list
of all widgets anchored at this child anchor from all the associated
textviews.</para>
</refsect2>
<refsect2 id="method-gtktextchildanchor--get-deleted">
<title>gtk.TextChildAnchor.get_deleted</title>
<programlisting><methodsynopsis language="python">
<methodname>get_deleted</methodname>
<methodparam></methodparam> </methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara><literal>True</literal> if the child anchor has
been deleted from its textbuffer</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>get_deleted</methodname>() method returns
<literal>True</literal> if the child anchor has been deleted from its
textbuffer.</para>
</refsect2>
</refsect1>
</refentry>
|