<?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>&nbsp;:</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>&nbsp;:</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>&nbsp;:</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>
