path: root/docs/reference/pygtk-gtkbox.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-gtkbox">
  <refnamediv>
    <refname>gtk.Box</refname>
    <refpurpose>an abstract base class for box containers</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtk.Box</classname></ooclass>
      <ooclass><classname><link
linkend="class-gtkcontainer">gtk.Container</link></classname></ooclass>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkbox--pack-start">pack_start</link></methodname>
	<methodparam><parameter
		       role="keyword">child</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">expand</parameter><initializer>True</initializer></methodparam>
	<methodparam><parameter
		       role="keyword">fill</parameter><initializer>True</initializer></methodparam>
	<methodparam><parameter
		       role="keyword">padding</parameter><initializer>0</initializer></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkbox--pack-end">pack_end</link></methodname>
	<methodparam><parameter
		       role="keyword">child</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">expand</parameter><initializer>True</initializer></methodparam>
	<methodparam><parameter
		       role="keyword">fill</parameter><initializer>True</initializer></methodparam>
	<methodparam><parameter
		       role="keyword">padding</parameter><initializer>0</initializer></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkbox--pack-start-defaults">pack_start_defaults</link></methodname>
	<methodparam><parameter
		       role="keyword">widget</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkbox--pack-end-defaults">pack_end_defaults</link></methodname>
	<methodparam><parameter
		       role="keyword">widget</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkbox--set-homogeneous">set_homogeneous</link></methodname>
	<methodparam><parameter
		       role="keyword">homogeneous</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkbox--get-homogeneous">get_homogeneous</link></methodname>
	<methodparam></methodparam>  </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkbox--set-spacing">set_spacing</link></methodname>
	<methodparam><parameter
		       role="keyword">spacing</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkbox--get-spacing">get_spacing</link></methodname>
	<methodparam></methodparam>  </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkbox--reorder-child">reorder_child</link></methodname>
	<methodparam><parameter
		       role="keyword">child</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">position</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkbox--query-child-packing">query_child_packing</link></methodname>
	<methodparam><parameter
		       role="keyword">child</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkbox--set-child-packing">set_child_packing</link></methodname>
	<methodparam><parameter
		       role="keyword">child</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">expand</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">fill</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">padding</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">pack_type</parameter></methodparam>
      </methodsynopsis>
    </classsynopsis>

  </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>
        +-- <link linkend="class-gtkbox">gtk.Box</link>
</synopsis>

  </refsect1>
  
  <refsect1>
		<title>Implemented Interfaces</title>
		<para>
			<link linkend="class-gtkbox"><classname>gtk.Box</classname></link>
			implements 
			<link linkend="class-gtkbuildable"><classname>gtk.Buildable</classname></link>
		</para>
	</refsect1>


  <refsect1 id="properties-gtkbox">
    <title>gtk.Box Properties</title>

    <para><link linkend="properties-gtkobject">gtk.Object Properties</link></para>
    <para><link linkend="properties-gtkwidget">gtk.Widget Properties</link></para>
    <para><link linkend="properties-gtkcontainer">gtk.Container 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>"spacing"</entry>
	      <entry>Read/Write</entry>
	<entry>The amount of space between children.</entry>
	  </row>

	<row valign="top">
	  <entry>"homogeneous"</entry>
	  <entry>Read/Write</entry>
	  <entry>If True the children should all be the same size.</entry>
	</row>

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

  </refsect1>

  <refsect1 id="style-properties-gtkbox">
    <title>gtk.Box Style Properties</title>

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


  </refsect1>

  <refsect1 id="child-properties-gtkbox">
    <title>gtk.Box Child Properties</title>

    <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>"expand"</entry>
              <entry>Read/Write</entry>
              <entry>If <literal>True</literal> the child should receive
              extra space when the parent grows</entry>
            </row>

            <row valign="top">
              <entry>"fill"</entry>
              <entry>Read/Write</entry>
              <entry>If <literal>True</literal> extra space given to the
              child should be allocated to the child; if
              <literal>False</literal> extra space given to the child should
              be used as padding</entry>
            </row>

            <row valign="top">
              <entry>"padding"</entry>
              <entry>Read/Write</entry>
              <entry>The amount of extra space to put between the child and
              its neighbors, in pixels</entry>
            </row>

            <row valign="top">
              <entry>"pack-type"</entry>
              <entry>Read/Write</entry>
              <entry>Indicates whether the child is packed with reference to
              the start (<literal>gtk.PACK_START</literal>) or end
              (<literal>gtk.PACK_END</literal>) of the parent</entry>
            </row>

            <row valign="top">
              <entry>"position"</entry>
              <entry>Read/Write</entry>
              <entry>The index of the child in the parent</entry>
            </row>

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

  </refsect1>

  <refsect1 id="signal-prototypes-gtkbox">
    <title>gtk.Box 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>
    <para><link linkend="signal-prototypes-gtkcontainer">gtk.Container Signal Prototypes</link></para>
  </refsect1>

  <refsect1>
    <title>Description</title>

    <para>The <link
linkend="class-gtkbox"><classname>gtk.Box</classname></link> class is an
abstract base class defining a widget that encapsulates functionality for a
particular kind of container, one that organizes a variable number of
widgets into a rectangular area. <link
linkend="class-gtkbox"><classname>gtk.Box</classname></link> currently has
two families of derived classes: <link
linkend="class-gtkhbox"><classname>gtk.HBox</classname></link> and <link
linkend="class-gtkvbox"><classname>gtk.VBox</classname></link> being one,
and <link
linkend="class-gtkhbuttonbox"><classname>gtk.HButtonBox</classname></link> and <link
linkend="class-gtkvbuttonbox"><classname>gtk.VButtonBox</classname></link> --
the other.</para>

    <para>The rectangular area of a <link
linkend="class-gtkbox"><classname>gtk.Box</classname></link> is organized
into either a single row or a single column of child widgets depending upon
whether the box is of type <link
linkend="class-gtkhbox"><classname>gtk.HBox</classname></link> or <link
linkend="class-gtkvbox"><classname>gtk.VBox</classname></link>,
respectively. Thus, all children of a <link
linkend="class-gtkbox"><classname>gtk.Box</classname></link> are allocated
one dimension in common, which is the height of a row, or the width of a
column.</para>

    <para><link linkend="class-gtkbox"><classname>gtk.Box</classname></link>
uses a notion of packing. Packing refers to adding widgets with reference to
a particular position in a <link
linkend="class-gtkbox"><classname>gtk.Container</classname></link>. For a
<link linkend="class-gtkbox"><classname>gtk.Box</classname></link>, there
are two reference positions: the start and the end of the box. For a <link
linkend="class-gtkvbox"><classname>gtk.VBox</classname></link>, the start is
defined as the top of the box and the end is defined as the bottom. For a
<link linkend="class-gtkhbox"><classname>gtk.HBox</classname></link> the
start is defined as the left side and the end is defined as the right
side.</para>

    <para>Repeated calls to <link
linkend="method-gtkbox--pack-start"><methodname>pack_start</methodname>()</link> 
pack widgets into a <link
linkend="class-gtkbox"><classname>gtk.Box</classname></link> from start to
end. The <link
linkend="method-gtkbox--pack-end"><methodname>pack_end</methodname>()</link>
method adds widgets from end to start. You may intersperse these calls and
add widgets from both ends of the same <link
linkend="class-gtkbox"><classname>gtk.Box</classname></link>.</para>

    <para>Because <link
linkend="class-gtkbox"><classname>gtk.Box</classname></link> is a <link
linkend="class-gtkcontainer"><classname>gtk.Container</classname></link>,
you may also use <link
linkend="method-gtkcontainer--add"><methodname>add</methodname>()</link> to
insert widgets into the box, and they will be packed as if with the <link
linkend="method-gtkbox--pack-start-defaults"><methodname>pack_start</methodname>()</link> 
method. Use <link
linkend="method-gtkcontainer--remove"><methodname>remove</methodname>()</link> 
to remove widgets from the <link
linkend="class-gtkbox"><classname>gtk.Box</classname></link>.</para>

    <para>The <link
linkend="method-gtkbox--set-homogeneous"><methodname>set_homogeneous</methodname>()</link> 
method specifies whether or not all children of the <link
linkend="class-gtkbox"><classname>gtk.Box</classname></link> are forced to
get the same amount of space.</para>

    <para>The <link
linkend="method-gtkbox--set-spacing"><methodname>set_spacing</methodname>()</link> 
method determines how much space will be minimally placed between all
children in the <link
linkend="class-gtkbox"><classname>gtk.Box</classname></link>.</para>

    <para>The <link
linkend="method-gtkbox--reorder-child"><methodname>reorder_child</methodname>()</link> 
method moves a <link
linkend="class-gtkbox"><classname>gtk.Box</classname></link> child to a
different place in the box.</para>

    <para>The <link
linkend="method-gtkbox--set-child-packing"><methodname>set_child_packing</methodname>()</link> 
method resets the expand, fill, and padding attributes of any <link
linkend="class-gtkbox"><classname>gtk.Box</classname></link> child. Use the
<link
linkend="method-gtkbox--query-child-packing"><methodname>query_child_packing</methodname>()</link> 
to query these properties.</para>

  </refsect1>

  <refsect1>
    <title>Methods</title>

    <refsect2 id="method-gtkbox--pack-start">
      <title>gtk.Box.pack_start</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>pack_start</methodname>
	  <methodparam><parameter
			 role="keyword">child</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">expand</parameter><initializer>True</initializer></methodparam>
	  <methodparam><parameter
			 role="keyword">fill</parameter><initializer>True</initializer></methodparam>
	  <methodparam><parameter
			 role="keyword">padding</parameter><initializer>0</initializer></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">child</parameter>&nbsp;:</term>
	  <listitem><simpara>the widget to be added to the
box</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">expand</parameter>&nbsp;:</term>
	  <listitem><simpara>True if <parameter>child</parameter> is to be
given extra space allocated to box. The extra space will be divided evenly
between all children of box that use this option.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">fill</parameter>&nbsp;:</term>
	  <listitem><simpara>True if space given to
<parameter>child</parameter> by the <parameter>expand</parameter> option is
actually allocated to <parameter>child</parameter>, rather than just padding
it. This parameter has no effect if <parameter>expand</parameter> is set to
False. A child is always allocated the full height of a <link
linkend="class-gtkhbox"><classname>gtk.HBox</classname></link> and the full
width of a <link
linkend="class-gtkvbox"><classname>gtk.VBox</classname></link>. This option
affects the other dimension.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">padding</parameter>&nbsp;:</term>
	  <listitem><simpara>extra space in pixels to put between
<parameter>child</parameter> and its neighbors, over and above the global
amount specified by <parameter>spacing</parameter> in <link
linkend="class-gtkhbox"><classname>gtk.Box</classname></link>. If
<parameter>child</parameter> is a widget at one of the reference ends of
box, then <parameter>padding</parameter> pixels are also put between
<parameter>child</parameter> and the reference edge of
box.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>pack_start</methodname>() method adds
<parameter>child</parameter> to the box, packed with reference to the start
of box. The <parameter>child</parameter> is packed after any other child
packed with reference to the start of box. </para>

    </refsect2>

    <refsect2 id="method-gtkbox--pack-end">
      <title>gtk.Box.pack_end</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>pack_end</methodname>
	  <methodparam><parameter
			 role="keyword">child</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">expand</parameter><initializer>True</initializer></methodparam>
	  <methodparam><parameter
			 role="keyword">fill</parameter><initializer>True</initializer></methodparam>
	  <methodparam><parameter
			 role="keyword">padding</parameter><initializer>0</initializer></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">child</parameter>&nbsp;:</term>
	  <listitem><simpara>the widget to be added to the
box</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">expand</parameter>&nbsp;:</term>
	  <listitem><simpara>True if <parameter>child</parameter> is to be
given extra space allocated to box. The extra space will be divided evenly
between all children of box that use this option.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">fill</parameter>&nbsp;:</term>
	  <listitem><simpara>True if space given to
<parameter>child</parameter> by the <parameter>expand</parameter> option is
actually allocated to <parameter>child</parameter>, rather than just padding
it. This parameter has no effect if <parameter>expand</parameter> is set to
False. A child is always allocated the full height of a <link
linkend="class-gtkhbox"><classname>gtk.HBox</classname></link> and the full
width of a <link
linkend="class-gtkvbox"><classname>gtk.VBox</classname></link>. This option
affects the other dimension.</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">padding</parameter>&nbsp;:</term>
	  <listitem><simpara>extra space in pixels to put between
<parameter>child</parameter> and its neighbors, over and above the global
amount specified by <parameter>spacing</parameter> in <link
linkend="class-gtkhbox"><classname>gtk.Box</classname></link>. If
<parameter>child</parameter> is a widget at one of the reference ends of
box, then <parameter>padding</parameter> pixels are also put between
<parameter>child</parameter> and the reference edge of
box.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>pack_end</methodname>() method adds
<parameter>child</parameter> to the box, packed with reference to the end of
the box. The <parameter>child</parameter> is packed after (away from end of)
any other child packed with reference to the end of the box.</para>

    </refsect2>

    <refsect2 id="method-gtkbox--pack-start-defaults">
      <title>gtk.Box.pack_start_defaults</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>pack_start_defaults</methodname>
	  <methodparam><parameter
			 role="keyword">widget</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
	  <listitem><simpara>the widget to be added to the
box</simpara></listitem>
	</varlistentry>
      </variablelist>

      <warning>
	<para>This method is deprecated in PyGTK 2.4 and above.</para>
      </warning>

      <para>The <methodname>pack_start_defaults</methodname>() method adds
<parameter>widget</parameter> to the box, packed with reference to the start
of the box. The <parameter>widget</parameter> is packed after any other
child widget packed with reference to the start of box. The parameters for
packing the child widget: expand, fill, and padding are given their default
values, True, True, and 0, respectively.</para>

    </refsect2>

    <refsect2 id="method-gtkbox--pack-end-defaults">
      <title>gtk.Box.pack_end_defaults</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>pack_end_defaults</methodname>
	  <methodparam><parameter
			 role="keyword">widget</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">widget</parameter>&nbsp;:</term>
	  <listitem><simpara>the widget to be added to the
box</simpara></listitem>
	</varlistentry>
      </variablelist>

      <warning>
	<para>This method is deprecated in PyGTK 2.4 and above.</para>
      </warning>

      <para>The <methodname>pack_end_defaults</methodname>() method adds
<parameter>widget</parameter> to the box, packed with reference to the end
of the box. The <parameter>widget</parameter> is packed after (away from the
end of) any other child widget packed with reference to the end of the box.
The parameters for packing the child widget: expand, fill, and padding are
given their default values, True, True, and 0, respectively.</para>

    </refsect2>

    <refsect2 id="method-gtkbox--set-homogeneous">
      <title>gtk.Box.set_homogeneous</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_homogeneous</methodname>
	  <methodparam><parameter
			 role="keyword">homogeneous</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter
role="keyword">homogeneous</parameter>&nbsp;:</term>
	  <listitem><simpara>If <literal>True</literal> the box is
homogeneous i.e. all children are allocated the same space otherwise the
allocations vary for each child.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>set_homogeneous</methodname>() method sets the
homogeneous (all children are allocated the same space) property of the
box.</para>

    </refsect2>

    <refsect2 id="method-gtkbox--get-homogeneous">
      <title>gtk.Box.get_homogeneous</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_homogeneous</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara><literal>True</literal> if the box is
homogeneous.</simpara></listitem>
	</varlistentry>
      </variablelist>
      <para>The <methodname>get_homogeneous</methodname>() method returns
whether the box is homogeneous (all children are allocated the same space).
See <link
linkend="method-gtkbox--set-homogeneous"><methodname>gtk.Box.set_homogeneous()</methodname></link>.</para>

    </refsect2>

    <refsect2 id="method-gtkbox--set-spacing">
      <title>gtk.Box.set_spacing</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_spacing</methodname>
	  <methodparam><parameter
			 role="keyword">spacing</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">spacing</parameter>&nbsp;:</term>
	  <listitem><simpara>the number of pixels to put between
children.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>set_spacing</methodname>() method sets the
number of pixels to place between children of the box.</para>

    </refsect2>

    <refsect2 id="method-gtkbox--get-spacing">
      <title>gtk.Box.get_spacing</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_spacing</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the spacing in pixels between
children</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>get_spacing</methodname>() method returns the
number of pixels used as padding between children as set by the <link
linkend="method-gtkbox--set-spacing"><methodname>set_spacing</methodname>()</link>.</para>

    </refsect2>

    <refsect2 id="method-gtkbox--reorder-child">
      <title>gtk.Box.reorder_child</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>reorder_child</methodname>
	  <methodparam><parameter
			 role="keyword">child</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">position</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">child</parameter>&nbsp;:</term>
	  <listitem><simpara>the child widget to move</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">position</parameter>&nbsp;:</term>
	  <listitem><simpara>the new position for child in the children list
of the box starting from 0. If negative, indicates the end of the
list.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>Moves child to a new position in the list of the box children.
The list contains both widgets packed gtk.PACK_START as well as widgets
packed gtk.PACK_END, in the order that these widgets were added to
box.</para>

      <para>A widget's position in the box children list determines where
the widget is packed into box. A child widget at some position in the list
will be packed just after all other widgets of the same packing type that
appear earlier in the list.</para>

    </refsect2>

    <refsect2 id="method-gtkbox--query-child-packing">
      <title>gtk.Box.query_child_packing</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>query_child_packing</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 to be queried for its packing
information</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">expand</parameter>&nbsp;:</term>
	  <listitem><simpara>the child's expand value</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">fill</parameter>&nbsp;:</term>
	  <listitem><simpara>the child's fill value</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">padding</parameter>&nbsp;:</term>
	  <listitem><simpara>the child's padding value</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter
role="keyword">pack_type</parameter>&nbsp;:</term>
	  <listitem><simpara>the child's pack_type
value</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>query_child_packing</methodname>() method
returns a tuple containing information about how <parameter>child</parameter>
is packed into the box. The tuple members are: (expand, fill, padding,
pack_type) where: expand and fill are 0 or 1 (corresponding to False or
True); padding is the number of pixels of padding; and pack_type is
gtk.PACK_START or gtk.PACK_END.</para>

    </refsect2>

    <refsect2 id="method-gtkbox--set-child-packing">
      <title>gtk.Box.set_child_packing</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_child_packing</methodname>
	  <methodparam><parameter
			 role="keyword">child</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">expand</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">fill</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">padding</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">pack_type</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">child</parameter>&nbsp;:</term>
	  <listitem><simpara>the child widget to be queried for its packing
information</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">expand</parameter>&nbsp;:</term>
	  <listitem><simpara>the child's new expand
value</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">fill</parameter>&nbsp;:</term>
	  <listitem><simpara>the child's new fill value</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">padding</parameter>&nbsp;:</term>
	  <listitem><simpara>the child's new padding
value</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter
role="keyword">pack_type</parameter>&nbsp;:</term>
	  <listitem><simpara>the child's new pack_type
value</simpara></listitem>
	</varlistentry>
      </variablelist>
    </refsect2>

    <para>The <methodname>set_child_packing</methodname>() method sets the
way child is packed into the box.</para>

  </refsect1>

</refentry>