path: root/docs/reference/pygtk-gtkcontainer.xml

<?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-gtkcontainer">
  <refnamediv>
    <refname>gtk.Container</refname>
    <refpurpose>a base class for widgets that contain other
widgets</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtk.Container</classname></ooclass>
      <ooclass><classname><link
linkend="class-gtkwidget">gtk.Widget</link></classname></ooclass>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkcontainer--set-border-width">set_border_width</link></methodname>
	<methodparam><parameter
		       role="keyword">border_width</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkcontainer--get-border-width">get_border_width</link></methodname>
	<methodparam></methodparam>  </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkcontainer--add">add</link></methodname>
	<methodparam><parameter
		       role="keyword">widget</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkcontainer--remove">remove</link></methodname>
	<methodparam><parameter
		       role="keyword">widget</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkcontainer--set-resize-mode">set_resize_mode</link></methodname>
	<methodparam><parameter
		       role="keyword">resize_mode</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkcontainer--get-resize-mode">get_resize_mode</link></methodname>
	<methodparam></methodparam>  </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkcontainer--check-resize">check_resize</link></methodname>
	<methodparam></methodparam>  </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkcontainer--forall">forall</link></methodname>
	<methodparam><parameter
		       role="keyword">callback</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">callback_data</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkcontainer--foreach">foreach</link></methodname>
	<methodparam><parameter
		       role="keyword">callback</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">callback_data</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkcontainer--get-children">get_children</link></methodname>
	<methodparam></methodparam>  </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkcontainer--propagate-expose">propagate_expose</link></methodname>
	<methodparam><parameter
		       role="keyword">child</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">event</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkcontainer--set-focus-chain">set_focus_chain</link></methodname>
	<methodparam><parameter
		       role="keyword">focusable_widgets</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkcontainer--get-focus-chain">get_focus_chain</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkcontainer--unset-focus-chain">unset_focus_chain</link></methodname>
	<methodparam></methodparam>  </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkcontainer--set-reallocate-redraws">set_reallocate_redraws</link></methodname>
	<methodparam><parameter
		       role="keyword">needs_redraws</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkcontainer--set-focus-child">set_focus_child</link></methodname>
	<methodparam><parameter
		       role="keyword">child</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkcontainer--set-focus-vadjustment">set_focus_vadjustment</link></methodname>
	<methodparam><parameter
		       role="keyword">adjustment</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkcontainer--get-focus-vadjustment">get_focus_vadjustment</link></methodname>
	<methodparam></methodparam>  </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkcontainer--set-focus-hadjustment">set_focus_hadjustment</link></methodname>
	<methodparam><parameter
		       role="keyword">adjustment</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkcontainer--get-focus-hadjustment">get_focus_hadjustment</link></methodname>
	<methodparam></methodparam>  </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkcontainer--resize-children">resize_children</link></methodname>
	<methodparam></methodparam>  </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkcontainer--child-type">child_type</link></methodname>
	<methodparam></methodparam>  </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkcontainer--add-with-properties">add_with_properties</link></methodname>
	<methodparam><parameter>widget</parameter></methodparam>
	<methodparam><parameter>first_prop_name</parameter></methodparam>
	<methodparam><parameter>first_prop_value</parameter></methodparam>
	<methodparam><parameter>...</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkcontainer--child-set">child_set</link></methodname>
	<methodparam><parameter>child</parameter></methodparam>
	<methodparam><parameter>first_prop_name</parameter></methodparam>
	<methodparam><parameter>first_prop_value</parameter></methodparam>
	<methodparam><parameter>...</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkcontainer--child-get">child_get</link></methodname>
	<methodparam><parameter>child</parameter></methodparam>
	<methodparam><parameter>first_prop_name</parameter></methodparam>
	<methodparam><parameter>...</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkcontainer--child-set-property">child_set_property</link></methodname>
	<methodparam><parameter>child</parameter></methodparam>
	<methodparam><parameter>property_name</parameter></methodparam>
	<methodparam><parameter>value</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkcontainer--child-get-property">child_get_property</link></methodname>
	<methodparam><parameter>child</parameter></methodparam>
	<methodparam><parameter>property_name</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link linkend="method-gtkcontainer--install-child-property">gtk.container_class_install_child_property</link></methodname>
        <methodparam><parameter role="keyword">property_id</parameter></methodparam>
        <methodparam><parameter role="keyword">pspec</parameter></methodparam>
        </methodsynopsis>
        <methodsynopsis language="python">
          <methodname><link linkend="method-gtkcontainer--list-child-properties">gtk.container_class_list_child_properties</link></methodname>
          <methodparam></methodparam>
        </methodsynopsis>
    </classsynopsis>

    <programlisting>
<emphasis role="bold">Functions</emphasis>

<methodsynopsis language="python">
        <methodname><link linkend="function-gtk--container-class-install-child-property">gtk.container_class_install_child_property</link></methodname>
        <methodparam><parameter role="keyword">klass</parameter></methodparam>
        <methodparam><parameter role="keyword">property_id</parameter></methodparam>
        <methodparam><parameter role="keyword">pspec</parameter></methodparam>
      </methodsynopsis><methodsynopsis language="python">
        <methodname><link linkend="function-gtk--container-class-list-child-properties">gtk.container_class_list_child_properties</link></methodname>
        <methodparam><parameter role="keyword">klass</parameter></methodparam>
      </methodsynopsis></programlisting>

  </refsect1>

  <refsect1>
    <title>Ancestry</title>

<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
  +-- <link linkend="class-gtkobject">gtk.Object</link>
    +-- <link linkend="class-gtkwidget">gtk.Widget</link>
      +-- <link linkend="class-gtkcontainer">gtk.Container</link>
</synopsis>

  </refsect1>

  <refsect1 id="properties-gtkcontainer">
    <title>gtk.Container Properties</title>

    <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
    <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>

    <blockquote role="properties">
      <informaltable pgwide="1" frame="none">
	<tgroup cols="3">

	  <colspec column="1" colwidth="1in"/>
	  <colspec column="2" colwidth="1in"/>
	  <colspec column="3" colwidth="3.5in"/>
	  <tbody>

	    <row valign="top">
	      <entry>"border-width"</entry>
	      <entry>Read/Write</entry>
	<entry>The width of the empty border outside the containers
	children.</entry>
	  </row>

	<row valign="top">
	  <entry>"child"</entry>
	  <entry>Read</entry>
	  <entry>The child widget in the container</entry>
	</row>

	<row valign="top">
	  <entry>"resize-mode"</entry>
	  <entry>Read/Write</entry>
	  <entry>Specify how resize events are handled. One of:
	  <literal>gtk.RESIZE_PARENT</literal>,
	  <literal>gtk.RESIZE_QUEUE</literal> or
	  <literal>gtk.RESIZE_IMMEDIATE</literal></entry>
	</row>

	</tbody>
      </tgroup>
      </informaltable>
    </blockquote>

  </refsect1>

  <refsect1 id="style-properties-gtkcontainer">
    <title>gtk.Container Style Properties</title>

    <para><link linkend="style-properties-gtkwidget">gtk.Widget Style Properties</link></para>

  </refsect1>

  <refsect1>
    <title>Attributes</title>

    <blockquote role="properties">
      <informaltable pgwide="1" frame="none">
	<tgroup cols="3">
	<?dbhtml cellpadding="10"?>
	  <colspec column="1" colwidth="1in"/>
	  <colspec column="2" colwidth="1in"/>
	  <colspec column="3" colwidth="3.5in"/>
	  <tbody>

	    <row valign="top">
	      <entry>"border_width"</entry>
	      <entry>Read</entry>
	      <entry>The width of the empty border outside the containers
children.</entry>
	    </row>

	    <row valign="top">
	      <entry>"resize_mode"</entry>
	      <entry>Read</entry>
	      <entry>Specify how resize events are handled. One of:
<literal>gtk.RESIZE_PARENT</literal>, <literal>gtk.RESIZE_QUEUE</literal> or
<literal>gtk.RESIZE_IMMEDIATE</literal></entry>
	    </row>

	    <row valign="top">
	      <entry>"focus_child"</entry>
	      <entry>Read</entry>
	      <entry>The child widget that has the focus</entry>
	    </row>

	    <row valign="top">
	      <entry>"need_resize"</entry>
	      <entry>Read</entry>
	      <entry>If True the container needs resizing</entry>
	    </row>

	    <row valign="top">
	      <entry>"reallocate_redraws"</entry>
	      <entry>Read</entry>
	      <entry>if True redraw the container when a child gets
reallocated</entry>
	    </row>

	    <row valign="top">
	      <entry>"has_focus_chain"</entry>
	      <entry>Read</entry>
	      <entry>If True the container had its focus chain explicitly
set</entry>
	    </row>

	  </tbody>
	</tgroup>
      </informaltable>
    </blockquote>

  </refsect1>

  <refsect1 id="signal-prototypes-gtkcontainer">
    <title>gtk.Container Signal Prototypes</title>

    <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkobject">gtk.Object Signal Prototypes</link></para>
    <para><link linkend="signal-prototypes-gtkwidget">gtk.Widget Signal Prototypes</link></para>

    <variablelist>
      <varlistentry>
        <term>"<link linkend="signal-gtkcontainer--add">add</link>"</term>
        <listitem>
          <methodsynopsis
	    language="python"><methodname>callback</methodname>
            <methodparam><parameter>container</parameter>
            </methodparam>
            <methodparam><parameter>widget</parameter>
            </methodparam>
            <methodparam><parameter>user_param1</parameter>
            </methodparam>
            <methodparam><parameter>...</parameter>
            </methodparam>
          </methodsynopsis>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>"<link
linkend="signal-gtkcontainer--check-resize">check-resize</link>"</term>
        <listitem>
          <methodsynopsis
	    language="python"><methodname>callback</methodname>
            <methodparam><parameter>container</parameter>
            </methodparam>
            <methodparam><parameter>user_param1</parameter>
            </methodparam>
            <methodparam><parameter>...</parameter>
            </methodparam>
          </methodsynopsis>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>"<link
linkend="signal-gtkcontainer--remove">remove</link>"</term>
        <listitem>
          <methodsynopsis
	    language="python"><methodname>callback</methodname>
            <methodparam><parameter>container</parameter>
            </methodparam>
            <methodparam><parameter>widget</parameter>
            </methodparam>
            <methodparam><parameter>user_param1</parameter>
            </methodparam>
            <methodparam><parameter>...</parameter>
            </methodparam>
          </methodsynopsis>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term>"<link
linkend="signal-gtkcontainer--set-focus-child">set-focus-child</link>"</term>
        <listitem>
          <methodsynopsis
	    language="python"><methodname>callback</methodname>
            <methodparam><parameter>container</parameter>
            </methodparam>
            <methodparam><parameter>widget</parameter>
            </methodparam>
            <methodparam><parameter>user_param1</parameter>
            </methodparam>
            <methodparam><parameter>...</parameter>
            </methodparam>
          </methodsynopsis>
        </listitem>
      </varlistentry>
    </variablelist>

  </refsect1>

  <refsect1>
    <title>Description</title>

    <para>The <link
linkend="class-gtkcontainer"><classname>gtk.Container</classname></link>
class provides common attributes and methods for a large number of widget
subclasses that manage the layout of other widgets within the area of a
window.</para>

    <para>A <literal>PyGTK</literal> user interface is constructed by
nesting widgets inside widgets. Container widgets are the inner nodes in the
resulting tree of widgets: they contain other widgets. So, for example, you
might have a <link
linkend="class-gtkwindow"><classname>gtk.Window</classname></link>
containing a <link
linkend="class-gtkframe"><classname>gtk.Frame</classname></link> containing
a <link linkend="class-gtklabel"><classname>gtk.Label</classname></link>. If
you wanted an image instead of a textual label inside the frame, you might
replace the <link
linkend="class-gtklabel"><classname>gtk.Label</classname></link> widget with
a <link linkend="class-gtkimage"><classname>gtk.Image</classname></link>
widget.</para>

    <para>There are two major kinds of container widgets. Both are
subclasses of the abstract <link
linkend="class-gtkcontainer"><classname>gtk.Container</classname></link>
base class.</para>

    <para>The first type of container widget has a single child widget and
derives from <link
linkend="class-gtkbin"><classname>gtk.Bin</classname></link>. These
containers are decorators, that add some kind of functionality to the
child. For example, a <link
linkend="class-gtkbutton"><classname>gtk.Button</classname></link> makes its
child into a clickable button; a <link
linkend="class-gtkframe"><classname>gtk.Frame</classname></link> draws a
frame around its child and a <link
linkend="class-gtkwindow"><classname>gtk.Window</classname></link> places
its child widget inside a top-level window.</para>

    <para>The second type of container can have more than one child; its
purpose is to manage layout. This means that these containers assign sizes
and positions to their children. For example, a <link
linkend="class-gtkhbox"><classname>gtk.HBox</classname></link> arranges its
children in a horizontal row, and a <link
linkend="class-gtktable"><classname>gtk.Table</classname></link> arranges
the widgets it contains in a two-dimensional grid.</para>

    <para>To fulfill its task, a layout container must negotiate the size
requirements with its parent and its children. This negotiation is carried
out in two phases, size requisition and size allocation.</para>

    <refsect2 id='sec-ContainerSizeRequisition'>
      <title>Size Requisition</title>

      <para>The size requisition of a widget is it's desired width and
height. This is represented by a <link
linkend="class-gtkrequisition"><classname>gtk.Requisition</classname></link>.</para>

      <para>How a widget determines its desired size depends on the
widget. A <link
linkend="class-gtklabel"><classname>gtk.Label</classname></link>, for
example, requests enough space to display all its text. Container widgets
generally base their size request on the requisitions of their
children.</para>

      <para>The size requisition phase of the widget layout process operates
top-down. It starts at a top-level widget, typically a GtkWindow. The
top-level widget asks its child for its size requisition by calling
gtk_widget_size_request(). To determine its requisition, the child asks its
own children for their requisitions and so on. Finally, the top-level widget
will get a requisition back from its child.</para>

    </refsect2>

    <refsect2 id="sec-ContainerSizeAllocation">
      <title>Size Allocation</title>

      <para>When the top-level widget has determined how much space its
child would like to have, the second phase of the size negotiation, size
allocation, begins. Depending on its configuration (see the <link
linkend="method-gtkwindow--set-resizable"><methodname>gtk.Window.set_resizable</methodname>()</link>
method), the top-level widget may be able to expand in order to satisfy the
size request or it may have to ignore the size request and keep its fixed
size. It then tells its child widget how much space it gets by calling the
<link
linkend="method-gtkwidget--size-allocate"><methodname>size_allocate</methodname>()</link>
method. The child widget divides the space among its children and tells each
child how much space it got, and so on. Under normal circumstances, a <link
linkend="class-gtkwindow"><classname>gtk.Window</classname></link> will
always give its child the amount of space the child requested.</para>

      <para>A child's size allocation is represented by a <link
linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
that contains not only a width and height, but also a position (i.e. X and Y
coordinates), so that containers can tell their children not only how much
space is available, but also where they are positioned inside the space
available to the container.</para>

      <para>Widgets are required to honor the size allocation they receive;
a size request is only a request, and widgets must be able to cope with any
size.</para>

    </refsect2>

    <refsect2 id="sec-ContainerChildProperties">
      <title>Child Properties</title>

      <para><link
linkend="class-gtkcontainer"><classname>gtk.Container</classname></link>
introduces child properties - these are object properties that are not
specific to either the container or the contained widget, but rather to
their relation. Typical examples of child properties are the "position" or
"pack-type" of a widget which is contained in a <link
linkend="class-gtkbox"><classname>gtk.Box</classname></link>.</para>

      <para>Use the <link
linkend="method-gtkcontainer--install-child-property"><methodname>install_child_property</methodname>()</link>
method to install child properties for a container class and the <link
linkend="method-gtkcontainer--list-child-properties"><methodname>list_child_properties</methodname>()</link>
function to get information about existing child properties.</para>

      <para>To set the value of a child property, use the <link
linkend="method-gtkcontainer--child-set-property"><methodname>child_set_property</methodname>()</link>,
or <link
linkend="method-gtkcontainer--child-set"><methodname>child_set</methodname>()</link>
methods. To obtain the value of a child property, use the <link
linkend="method-gtkcontainer--child-get-property"><methodname>child_get_property</methodname>()</link>,
or <link
linkend="method-gtkcontainer--child-get"><methodname>child_get</methodname>()</link>
methods. To emit notification about child property changes, use the <link
linkend="method-gtkwidget--child-notify"><methodname>gtk.Widget.child_notify</methodname>()</link>
method.</para>

    </refsect2>

  </refsect1>

  <refsect1>
    <title>Methods</title>

    <refsect2 id="method-gtkcontainer--set-border-width">
      <title>gtk.Container.set_border_width</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_border_width</methodname>
	  <methodparam><parameter
			 role="keyword">border_width</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter
role="keyword">border_width</parameter>&nbsp;:</term>
	  <listitem><simpara>The amount of blank space to leave
<emphasis>outside</emphasis> the container. Valid values are in the range
0-65535 pixels.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>set_border_width</methodname>() method sets the
"border-width" property of the container. The border width of a container is
the amount of space to leave around the outside of the container. The only
exception to this is <link
linkend="class-gtkwindow"><classname>gtk.Window</classname></link>; because
toplevel windows can't leave space outside, they leave the space inside. The
border is added on all sides of the container.</para>

    </refsect2>

    <refsect2 id="method-gtkcontainer--get-border-width">
      <title>gtk.Container.get_border_width</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_border_width</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the current border width</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>get_border_width</methodname>() method retrieves
the value of the "border-width" property of the container. See <link
linkend="method-gtkcontainer--set-border-width"><methodname>set_border_width</methodname>()</link>.</para>

    </refsect2>

    <refsect2 id="method-gtkcontainer--add">
      <title>gtk.Container.add</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>add</methodname>
	  <methodparam><parameter
			 role="keyword">widget</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
	  <listitem><simpara>a widget to be placed inside the
container</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>add</methodname>() method adds
<parameter>widget</parameter> to the container. This method is typically
used for simple containers such as <link
linkend="class-gtkwindow"><classname>gtk.Window</classname></link>, <link
linkend="class-gtkframe"><classname>gtk.Frame</classname></link>, or <link
linkend="class-gtkbutton"><classname>gtk.Button</classname></link> that hold
a single child widget. For layout containers that handle multiple children
such as <link linkend="class-gtkbox"><classname>gtk.Box</classname></link>
or <link linkend="class-gtktable"><classname>gtk.Table</classname></link>,
this function will pick default packing parameters that may not be correct.
Containers that handle multiple children usually have additional methods
such as <link
linkend="method-gtkbox--pack-start"><methodname>gtk.Box.pack_start</methodname>()</link> 
and <link
linkend="method-gtktable--attach"><methodname>gtk.Table.attach</methodname>()</link> 
as an alternative to <methodname>add</methodname>(). Adding a widget to a
container usually results in the resizing and redrawing of the container
contents.</para>

    </refsect2>

    <refsect2 id="method-gtkcontainer--remove">
      <title>gtk.Container.remove</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>remove</methodname>
	  <methodparam><parameter
			 role="keyword">widget</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
	  <listitem><simpara>a current child of
<parameter>container</parameter></simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>remove</methodname>() method removes
<parameter>widget</parameter> from the container.
<parameter>widget</parameter> must be inside the container. Note that the
container will own a reference to <parameter>widget</parameter>, and that
this may be the last reference held; so removing a widget from its container
can cause that widget to be destroyed. If you want to use
<parameter>widget</parameter> again, you should add a reference to
it.</para>

    </refsect2>

    <refsect2 id="method-gtkcontainer--set-resize-mode">
      <title>gtk.Container.set_resize_mode</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_resize_mode</methodname>
	  <methodparam><parameter
			 role="keyword">resize_mode</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter
role="keyword">resize_mode</parameter>&nbsp;:</term>
	  <listitem><simpara>the new resize mode.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>set-resize_mode</methodname>() method sets the
"resize=mode" property of the container. The resize mode of a container
determines whether a resize request will be passed to the container's parent
(<literal>gtk.RESIZE_PARENT</literal>), queued for later execution
(<literal>gtk.RESIZE_QUEUE</literal>) or executed immediately
(<literal>gtk.RESIZE_IMMEDIATE</literal>).</para>

    </refsect2>

    <refsect2 id="method-gtkcontainer--get-resize-mode">
      <title>gtk.Container.get_resize_mode</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_resize_mode</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the current resize mode</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The get_resize_mode() method returns the value of the
"resize-mode" property for of the container. See <link
linkend="method-gtkcontainer--set-resize-mode"><methodname>set_resize_mode()</methodname></link>.</para>

    </refsect2>

    <refsect2 id="method-gtkcontainer--check-resize">
      <title>gtk.Container.check_resize</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>check_resize</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>

      <para>The <methodname>check_resize</methodname>() method emits the
"check-resize" signal on the container.</para>

    </refsect2>

    <refsect2 id="method-gtkcontainer--forall">
      <title>gtk.Container.forall</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>forall</methodname>
	  <methodparam><parameter
			 role="keyword">callback</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">callback_data</parameter><initializer>None</initializer></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">callback</parameter>&nbsp;:</term>
	  <listitem><simpara>a callback</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter
role="keyword">callback_data</parameter>&nbsp;:</term>
	  <listitem><simpara>the callback user data</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>forall</methodname>() method arranges to invoke
<parameter>callback</parameter> on each child of the container including
children that are considered "internal" (implementation details of the
container). "Internal" children generally weren't added by the user of the
container, but were added by the container implementation itself. Most
applications should use the <link
linkend="method-gtkcontainer--foreach"><methodname>foreach</methodname>()</link> 
method, rather than the <methodname>forall</methodname>() method.</para>

    </refsect2>

    <refsect2 id="method-gtkcontainer--foreach">
      <title>gtk.Container.foreach</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>foreach</methodname>
	  <methodparam><parameter
			 role="keyword">callback</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">callback_data</parameter><initializer>None</initializer></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">callback</parameter>&nbsp;:</term>
	  <listitem><simpara>a callback</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter
role="keyword">callback_data</parameter>&nbsp;:</term>
	  <listitem><simpara>the callback user data</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>foreach</methodname>() method arranges to invoke
<parameter>callback</parameter> on each non-internal child of the
container.</para>

    </refsect2>

    <refsect2 id="method-gtkcontainer--get-children">
      <title>gtk.Container.get_children</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_children</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>a list of the container's non-internal
children.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>get_children</methodname>() method returns the
the container's non-internal children.</para>

    </refsect2>

    <refsect2 id="method-gtkcontainer--propagate-expose">
      <title>gtk.Container.propagate_expose</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>propagate_expose</methodname>
	  <methodparam><parameter
			 role="keyword">child</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">event</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">child</parameter>&nbsp;:</term>
	  <listitem><simpara>a child of the container</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">event</parameter>&nbsp;:</term>
	  <listitem><simpara>a expose event sent to the
container</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>propagate_expose</methodname>() method sends
synthetic expose events to all children that don't have their own <link
linkend="class-gdkwindow"><classname>gtk.gdk.Window</classname></link>s when
the container receives an expose event.</para>

      <para>The <link
linkend="method-gtkcontainer--propagate-expose"><methodname>propagate_expose</methodname>()</link> 
takes care of deciding whether an expose event needs to be sent to the
child, intersecting the event's area with the child area, and sending the
event.</para>

      <para>In most cases, a container can simply either simply inherit the
expose implementation from <link
linkend="class-gtkcontainer"><classname>gtk.Container</classname></link>,
or, do some drawing and then chain to the expose implementation from <link
linkend="class-gtkcontainer"><classname>gtk.Container</classname></link>.</para>

    </refsect2>

    <refsect2 id="method-gtkcontainer--set-focus-chain">
      <title>gtk.Container.set_focus_chain</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_focus_chain</methodname>
	  <methodparam><parameter
			 role="keyword">focusable_widgets</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter
role="keyword">focusable_widgets</parameter>&nbsp;:</term>
	  <listitem><simpara>a list or tuple containing a chain of focusable
widgets.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>set_focus_chain</methodname>() method sets a
focus chain, overriding the one computed automatically by GTK. In principle
each widget in the chain should be a descendant of the container, but this
is not enforced by this method, since it's allowed to set the focus chain
before you pack the widgets, or have a widget in the chain that isn't always
packed. The necessary checks are done when the focus chain is actually
traversed.</para>

    </refsect2>

    <refsect2 id="method-gtkcontainer--get-focus-chain">
      <title>gtk.Container.get_focus_chain</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_focus_chain</methodname>
	  <methodparam></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>a list containing the widgets in the focus
chain if the focus chain of the container has been set explicitly or None if
no focus chain has been explicitly set.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>get_focus_chain</methodname>() method retrieves
the focus chain of the container, if one has been set explicitly. If no
focus chain has been explicitly set, GTK computes the focus chain based on
the positions of the children. In that case, the method returns None.</para>

    </refsect2>

    <refsect2 id="method-gtkcontainer--unset-focus-chain">
      <title>gtk.Container.unset_focus_chain</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>unset_focus_chain</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>

      <para>The <methodname>unset_focus_chain</methodname>() method removes
a focus chain explicitly set with <link
linkend="method-gtkcontainer--set-focus-chain"><methodname>set_focus_chain</methodname>()</link>.</para>

    </refsect2>

    <refsect2 id="method-gtkcontainer--set-reallocate-redraws">
      <title>gtk.Container.set_reallocate_redraws</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_reallocate_redraws</methodname>
	  <methodparam><parameter
			 role="keyword">needs_redraws</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter
role="keyword">needs_redraws</parameter>&nbsp;:</term>
	  <listitem><simpara>the new value for the container's
reallocate_redraws attribute.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>set_reallocate_redraws</methodname>() method
sets the reallocate_redraws attribute of the container to the value of
<parameter>needs_redraws</parameter>. Containers requesting reallocation
redraws get automatically redrawn if any of their children change
allocation.</para>

    </refsect2>

    <refsect2 id="method-gtkcontainer--set-focus-child">
      <title>gtk.Container.set_focus_child</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_focus_child</methodname>
	  <methodparam><parameter
			 role="keyword">child</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">child</parameter>&nbsp;:</term>
	  <listitem><simpara>the child widget that will get the
focus.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>set_focus_child</methodname>() method emits the
"set-focus-child" signal that arranges for the child widget referenced by
<parameter>child</parameter> to get the focus and recalculates the container
adjustments.</para>

    </refsect2>

    <refsect2 id="method-gtkcontainer--set-focus-vadjustment">
      <title>gtk.Container.set_focus_vadjustment</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_focus_vadjustment</methodname>
	  <methodparam><parameter
			 role="keyword">adjustment</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter
role="keyword">adjustment</parameter>&nbsp;:</term>
	  <listitem><simpara>The new vertical focus
adjustment</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>set_focus_vadjustment</methodname>() method sets
the vertical focus adjustment to the value of
<parameter>adjustment</parameter>.</para>

    </refsect2>

    <refsect2 id="method-gtkcontainer--get-focus-vadjustment">
      <title>gtk.Container.get_focus_vadjustment</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_focus_vadjustment</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the vertical focus adjustment, or
<literal>None</literal> if none has been set.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The get_focus_vadjustment() method retrieves the vertical focus
adjustment for the container. See the <link
linkend="method-gtkcontainer--set-focus-vadjustment"><methodname>set_focus_vadjustment</methodname>()</link> 
method.</para>

    </refsect2>

    <refsect2 id="method-gtkcontainer--set-focus-hadjustment">
      <title>gtk.Container.set_focus_hadjustment</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_focus_hadjustment</methodname>
	  <methodparam><parameter
			 role="keyword">adjustment</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter
role="keyword">adjustment</parameter>&nbsp;:</term>
	  <listitem><simpara>The new horizontal focus
adjustment</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>set_focus_hadjustment</methodname>() method sets
the horizontal focus adjustment to the value of
<parameter>adjustment</parameter>.</para>

    </refsect2>

    <refsect2 id="method-gtkcontainer--get-focus-hadjustment">
      <title>gtk.Container.get_focus_hadjustment</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_focus_hadjustment</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the horizontal focus adjustment, or
<literal>None</literal> if none has been set.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>get_focus_hadjustment</methodname>() method
retrieves the horizontal focus adjustment for the container. See <link
linkend="method-gtkcontainer--set-focus-hadjustment"><methodname>set_focus_hadjustment</methodname>()</link>.</para>

    </refsect2>

    <refsect2 id="method-gtkcontainer--resize-children">
      <title>gtk.Container.resize_children</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>resize_children</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>

      <para>The <methodname>resize_children</methodname>() method causes the
container to recalculate its size and its children's sizes.</para>

    </refsect2>


    <refsect2 id="method-gtkcontainer--child-type">
      <title>gtk.Container.child_type</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>child_type</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>a type.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>child_type</methodname>() method returns the
type of the children that can be added to the container. Note that this may
return a void type to indicate that no more children can be added, e.g. for
a <link linkend="class-gtkpaned"><classname>gtk.Paned</classname></link>
which already has two children or a <link
linkend="class-gtkwindow"><classname>gtk.Window</classname></link> that
already has a child.</para>

    </refsect2>

    <refsect2 id="method-gtkcontainer--add-with-properties">
      <title>gtk.Container.add_with_properties</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>add_with_properties</methodname>
	  <methodparam><parameter>widget</parameter></methodparam>
	  <methodparam><parameter>first_prop_name</parameter></methodparam>
	  <methodparam><parameter>first_prop_value</parameter></methodparam>
	  <methodparam><parameter>...</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter>widget</parameter>&nbsp;:</term>
	  <listitem><simpara>a widget to be added</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>first_prop_name</parameter>&nbsp;:</term>
	  <listitem><simpara>the first property name</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>first_prop_value</parameter>&nbsp;:</term>
	  <listitem><simpara>a value for the first
property</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>...</parameter>&nbsp;:</term>
	  <listitem><simpara>additional property name and value
pairs</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>add_with_properties</methodname>() method adds
the child widget specified by <parameter>widget</parameter> to the container
while allowing the setting of zero or more container child property values
at the same time. Containers supporting add with settable child properties
are: <link linkend="class-gtkbox"><classname>gtk.Box</classname></link>,
<link linkend="class-gtkfixed"><classname>gtk.Fixed</classname></link>,
<link linkend="class-gtknotebook"><classname>gtk.Notebook</classname></link>
and <link
linkend="class-gtktable"><classname>gtk.Table</classname></link>.</para>

      <para>For example the following adds a button to a <link
linkend="class-gtkfixed"><classname>gtk.Fixed</classname></link> layout
widget and sets the child properties "x" and "y" specifying the child
position in the layout:</para>

      <programlisting>
  fixed.add_with_properties(button, "x", 10, "y", 20")
</programlisting>

    </refsect2>

    <refsect2 id="method-gtkcontainer--child-set">
      <title>gtk.Container.child_set</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>child_set</methodname>
	  <methodparam><parameter>child</parameter></methodparam>
	  <methodparam><parameter>first_prop_name</parameter></methodparam>
	  <methodparam><parameter>...</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter>child</parameter>&nbsp;:</term>
	  <listitem><simpara>the child widget</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>first_prop_name</parameter>&nbsp;:</term>
	  <listitem><simpara>the first property name</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>first_prop_value</parameter>&nbsp;:</term>
	  <listitem><simpara>the value of the first
property</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>...</parameter>&nbsp;:</term>
	  <listitem><simpara>additional property name and value
pairs</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>child_set</methodname>() method sets the
properties for <parameter>child</parameter> using the given property name
and value pairs.</para>

    </refsect2>

    <refsect2 id="method-gtkcontainer--child-get">
      <title>gtk.Container.child_get</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>child_get</methodname>
	  <methodparam><parameter>child</parameter></methodparam>
	  <methodparam><parameter>first_prop_name</parameter></methodparam>
	  <methodparam><parameter>...</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter>child</parameter>&nbsp;:</term>
	  <listitem><simpara>the child widget to get the child properties
for</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>first_prop_name</parameter>&nbsp;:</term>
	  <listitem><simpara>the first property name</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>...</parameter>&nbsp;:</term>
	  <listitem><simpara>additional property names</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>a tuple containing the property values
requested</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>child_get</methodname>() method retrieves the
requested container child properties for
<parameter>child</parameter>.</para>

    </refsect2>

    <refsect2 id="method-gtkcontainer--child-set-property">
      <title>gtk.Container.child_set_property</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>child_set_property</methodname>
	  <methodparam><parameter>child</parameter></methodparam>
	  <methodparam><parameter>property_name</parameter></methodparam>
	  <methodparam><parameter>value</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter>child</parameter>&nbsp;:</term>
	  <listitem><simpara>the child widget</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>property_name</parameter>&nbsp;:</term>
	  <listitem><simpara>the child property name</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>value</parameter>&nbsp;:</term>
	  <listitem><simpara>a value to associate with the
property</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>child_set_property</methodname>() method sets
the property name specified by <parameter>property_name</parameter> with the
value specified in <parameter>value</parameter>.</para>

    </refsect2>

    <refsect2 id="method-gtkcontainer--child-get-property">
      <title>gtk.Container.child_get_property</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>child_get_property</methodname>
	  <methodparam><parameter>child</parameter></methodparam>
	  <methodparam><parameter>property_name</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter>child</parameter>&nbsp;:</term>
	  <listitem><simpara>the child widget</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>property_name</parameter>&nbsp;:</term>
	  <listitem><simpara>the child property name</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the value of the child property for the
widget</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>child_get_property</methodname>() method
retrieves the value of the child property specified by
<parameter>property_name</parameter> for the widget
<parameter>child</parameter>.</para>

    </refsect2>

    <refsect2 id="method-gtkcontainer--install-child-property">
      <title>gtk.Container.install_child_property</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>install_child_property</methodname>
        <methodparam><parameter role="keyword">property_id</parameter></methodparam>
        <methodparam><parameter role="keyword">pspec</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">property_id</parameter>&nbsp;:</term>
	  <listitem><simpara>an integer property ID</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">pspec</parameter>&nbsp;:</term>
	  <listitem><simpara>a tuple containing a parameter
specifications</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <methodname>install_child_property</methodname>() method
      installs a child property for the container class using the integer ID
      specified by
      <parameter>property_id</parameter>. <parameter>pspec</parameter> is a
      tuple containing at least 5 items. The first 4 items contain the
      following parameter specification items:</para>

      <itemizedlist>
        <listitem>
          <simpara>a string specifying the name of the property</simpara>
        </listitem>
        <listitem>
          <simpara>an object specifying the property type</simpara>
        </listitem>
        <listitem>
          <simpara>a string specifying the nickname for the property or
<literal>None</literal></simpara>
        </listitem>
        <listitem>
          <simpara>a string specifying the short description for the property
or <literal>None</literal></simpara>
        </listitem>
      </itemizedlist>

      <para>The last item must be a integer containing a combination of the
      <link linkend="gobject-param-constants">GObject Param Flag
      Constants</link>. Additional tuple items (if needed) are inserted
      between the fourth item and the last item depending on the property
      type:</para>

      <variablelist>
        <varlistentry>
          <term><literal>gobject.TYPE_CHAR</literal></term>
          <listitem>
            <simpara>minimum, maximum and default values</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_CHAR</literal></term>
          <listitem>
            <simpara>minimum, maximum and default values</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_BOOLEAN</literal></term>
          <listitem>
            <simpara>default value</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_INT</literal></term>
          <listitem>
            <simpara>minimum, maximum and default values</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_UINT</literal></term>
          <listitem>
            <simpara>minimum, maximum and default values</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_LONG</literal></term>
          <listitem>
            <simpara>minimum, maximum and default values</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_ULONG</literal></term>
          <listitem>
            <simpara>minimum, maximum and default values</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_INT64</literal></term>
          <listitem>
            <simpara>minimum, maximum and default values</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_UINT64</literal></term>
          <listitem>
            <simpara>minimum, maximum and default values</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_ENUM</literal></term>
          <listitem>
            <simpara>default value</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_FLAGS</literal></term>
          <listitem>
            <simpara>default value</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_FLOAT</literal></term>
          <listitem>
            <simpara>minimum, maximum and default values</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_DOUBLE</literal></term>
          <listitem>
            <simpara>minimum, maximum and default values</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_STRING</literal></term>
          <listitem>
            <simpara>default value</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_PARAM</literal></term>
          <listitem>
            <simpara>Not applicable</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_BOXED</literal></term>
          <listitem>
            <simpara>Not applicable</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_POINTER</literal></term>
          <listitem>
            <simpara>Not applicable</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_OBJECT</literal></term>
          <listitem>
            <simpara>Not applicable</simpara>
          </listitem>
        </varlistentry>
      </variablelist>

    </refsect2>

    <refsect2 id="method-gtkcontainer--list-child-properties">
      <title>gtk.Container.list_child_properties</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>list_child_properties</methodname>
	  <methodparam></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the list of child properties</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
        <para>This method is available in PyGTK 2.10 and above.</para>
      </note>

      <para>The <methodname>list_child_properties</methodname>() method
      returns a list containing the child properties of the container
      class. See the <link
      linkend="method-gtkcontainer--install-child-property"><methodname>install_child_property</methodname>()</link>
      method for more information.</para>

    </refsect2>

  </refsect1>

  <refsect1>
    <title>Functions</title>

    <refsect2 id="function-gtk--container-class-install-child-property">
      <title>gtk.container_class_install_child_property</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>gtk.container_class_install_child_property</methodname>
	  <methodparam><parameter
			 role="keyword">klass</parameter></methodparam>
        <methodparam><parameter role="keyword">property_id</parameter></methodparam>
        <methodparam><parameter role="keyword">pspec</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">klass</parameter>&nbsp;:</term>
	  <listitem><simpara>a <link
	  linkend="class-gtkcontainer"><classname>gtk.Container</classname></link>
	  class or instance.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">property_id</parameter>&nbsp;:</term>
	  <listitem><simpara>an integer property ID</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">pspec</parameter>&nbsp;:</term>
	  <listitem><simpara>a tuple containing a parameter
specification</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
        <para>This function is available in PyGTK 2.4 and above.</para>
      </note>

      <warning>
        <para>This function is deprecated in PyGTK 2.10 and above.</para>
      </warning>
 
      <para>The
      <function>gtk.container_class_install_child_property</function>()
      function installs a child property for the container class specified
      by <parameter>klass</parameter> using the integer ID specified by
      <parameter>property_id</parameter>. <parameter>pspec</parameter> is a
      tuple containing at least 5 items. The first 4 items contain the
      following parameter specification items:</para>

      <itemizedlist>
        <listitem>
          <simpara>a string specifying the name of the property</simpara>
        </listitem>
        <listitem>
          <simpara>an object specifying the property type</simpara>
        </listitem>
        <listitem>
          <simpara>a string specifying the nickname for the property or
<literal>None</literal></simpara>
        </listitem>
        <listitem>
          <simpara>a string specifying the short description for the property
or <literal>None</literal></simpara>
        </listitem>
      </itemizedlist>

      <para>The last item must be a integer containing a combination of the
      <link linkend="gobject-param-constants">GObject Param Flag
      Constants</link>. Additional tuple items (if needed) are inserted
      between the fourth item and the last item depending on the property
      type:</para>

      <variablelist>
        <varlistentry>
          <term><literal>gobject.TYPE_CHAR</literal></term>
          <listitem>
            <simpara>minimum, maximum and default values</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_CHAR</literal></term>
          <listitem>
            <simpara>minimum, maximum and default values</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_BOOLEAN</literal></term>
          <listitem>
            <simpara>default value</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_INT</literal></term>
          <listitem>
            <simpara>minimum, maximum and default values</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_UINT</literal></term>
          <listitem>
            <simpara>minimum, maximum and default values</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_LONG</literal></term>
          <listitem>
            <simpara>minimum, maximum and default values</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_ULONG</literal></term>
          <listitem>
            <simpara>minimum, maximum and default values</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_INT64</literal></term>
          <listitem>
            <simpara>minimum, maximum and default values</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_UINT64</literal></term>
          <listitem>
            <simpara>minimum, maximum and default values</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_ENUM</literal></term>
          <listitem>
            <simpara>default value</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_FLAGS</literal></term>
          <listitem>
            <simpara>default value</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_FLOAT</literal></term>
          <listitem>
            <simpara>minimum, maximum and default values</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_DOUBLE</literal></term>
          <listitem>
            <simpara>minimum, maximum and default values</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_STRING</literal></term>
          <listitem>
            <simpara>default value</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_PARAM</literal></term>
          <listitem>
            <simpara>Not applicable</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_BOXED</literal></term>
          <listitem>
            <simpara>Not applicable</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_POINTER</literal></term>
          <listitem>
            <simpara>Not applicable</simpara>
          </listitem>
        </varlistentry>
        <varlistentry>
          <term><literal>gobject.TYPE_OBJECT</literal></term>
          <listitem>
            <simpara>Not applicable</simpara>
          </listitem>
        </varlistentry>
      </variablelist>

    </refsect2>

    <refsect2 id="function-gtk--container-class-list-child-properties">
      <title>gtk.container_class_list_child_properties</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>gtk.container_class_list_child_properties</methodname>
	  <methodparam><parameter
			 role="keyword">klass</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">klass</parameter>&nbsp;:</term>
	  <listitem><simpara>a <link
	  linkend="class-gtkcontainer"><classname>gtk.Container</classname></link>
	  class or instance.</simpara></listitem>
	</varlistentry>
	<varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>a tuple containing the list of child properties</simpara></listitem>
	</varlistentry>
      </variablelist>

      <note>
        <para>This function is available in PyGTK 2.4 and above.</para>
      </note>

      <warning>
        <para>This function is deprecated in PyGTK 2.10 and above.</para>
      </warning>
 
      <para>The
      <function>gtk.container_class_list_child_properties</function>()
      function returns a tuple containing the child properties of the
      container class specified by <parameter>klass</parameter>.</para>

    </refsect2>

  </refsect1>

  <refsect1>
    <title>Signals</title>

    <refsect2 id="signal-gtkcontainer--add">
      <title>The "add" gtk.Container Signal</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>callback</methodname>
	  <methodparam><parameter>container</parameter></methodparam>
	  <methodparam><parameter>widget</parameter></methodparam>
	  <methodparam><parameter>user_param1</parameter></methodparam>
	  <methodparam><parameter>...</parameter></methodparam>
	</methodsynopsis></programlisting>

      <variablelist>
	<varlistentry>
	  <term><parameter>container</parameter>&nbsp;:</term>
	  <listitem><simpara>the container that received the
signal</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>widget</parameter>&nbsp;:</term>
	  <listitem><simpara>the child widget</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>user_param1</parameter>&nbsp;:</term>
          <listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>...</parameter>&nbsp;:</term>
	  <listitem><simpara>additional user parameters (if
any)</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The "add" signal is emitted when <parameter>widget</parameter>
is added to the <parameter>container</parameter>.</para>

    </refsect2>

    <refsect2 id="signal-gtkcontainer--check-resize">
      <title>The "check-resize" gtk.Container Signal</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>callback</methodname>
	  <methodparam><parameter>container</parameter></methodparam>
	  <methodparam><parameter>user_param1</parameter></methodparam>
	  <methodparam><parameter>...</parameter></methodparam>
	</methodsynopsis></programlisting>

      <variablelist>
	<varlistentry>
	  <term><parameter>container</parameter>&nbsp;:</term>
	  <listitem><simpara>the container that received the
signal</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>user_param1</parameter>&nbsp;:</term>
          <listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>...</parameter>&nbsp;:</term>
	  <listitem><simpara>additional user parameters (if
any)</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The "check-resize" signal is emitted when the
<methodname>check_resize</methodname>() method is called forcing the
recalculation of the container and its children. See the <link
linkend="method-gtkcontainer--set-resize-mode"><methodname>set_resize_mode</methodname>()</link> 
method for details.</para>

    </refsect2>

    <refsect2 id="signal-gtkcontainer--remove">
      <title>The "remove" gtk.Container Signal</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>callback</methodname>
	  <methodparam><parameter>container</parameter></methodparam>
	  <methodparam><parameter>widget</parameter></methodparam>
	  <methodparam><parameter>user_param1</parameter></methodparam>
	  <methodparam><parameter>...</parameter></methodparam>
	</methodsynopsis></programlisting>

      <variablelist>
	<varlistentry>
	  <term><parameter>container</parameter>&nbsp;:</term>
	  <listitem><simpara>the container that received the
signal</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>widget</parameter>&nbsp;:</term>
	  <listitem><simpara>the child widget</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>user_param1</parameter>&nbsp;:</term>
          <listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>...</parameter>&nbsp;:</term>
	  <listitem><simpara>additional user parameters (if
any)</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The "remove" signal is emitted when
<parameter>widget</parameter> is removed from
<parameter>container</parameter>.</para>

    </refsect2>

    <refsect2 id="signal-gtkcontainer--set-focus-child">
      <title>The "set-focus-child" gtk.Container Signal</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>callback</methodname>
	  <methodparam><parameter>container</parameter></methodparam>
	  <methodparam><parameter>widget</parameter></methodparam>
	  <methodparam><parameter>user_param1</parameter></methodparam>
	  <methodparam><parameter>...</parameter></methodparam>
	</methodsynopsis></programlisting>

      <variablelist>
	<varlistentry>
	  <term><parameter>container</parameter>&nbsp;:</term>
	  <listitem><simpara>the container that received the
signal</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>widget</parameter>&nbsp;:</term>
	  <listitem><simpara>the child widget</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>user_param1</parameter>&nbsp;:</term>
          <listitem><simpara>the first user parameter (if any) specified
with the <link
linkend="method-gobject--connect"><methodname>connect</methodname>()</link>
method</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>...</parameter>&nbsp;:</term>
	  <listitem><simpara>additional user parameters (if
any)</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The "set-focus-child" signal is emitted when the <link
linkend="method-gtkcontainer--set-focus-child"><methodname>set_focus_child</methodname>()</link> 
method is called. <parameter>widget</parameter> is set as the child in
<parameter>container</parameter> with the focus.</para>

    </refsect2>

  </refsect1>

</refentry>