path: root/docs/reference/pygtk-gtkpaned.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-gtkpaned">
  <refnamediv>
    <refname>gtk.Paned</refname>
    <refpurpose>a base class for widgets with two adjustable
panes</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtk.Paned</classname></ooclass>
      <ooclass><classname><link
linkend="class-gtkcontainer">gtk.Container</link></classname></ooclass>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkpaned--add1">add1</link></methodname>
	<methodparam><parameter
		       role="keyword">child</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkpaned--add2">add2</link></methodname>
	<methodparam><parameter
		       role="keyword">child</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkpaned--pack1">pack1</link></methodname>
	<methodparam><parameter
		       role="keyword">child</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">resize</parameter><initializer>False</initializer></methodparam>
	<methodparam><parameter
		       role="keyword">shrink</parameter><initializer>True</initializer></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkpaned--pack2">pack2</link></methodname>
	<methodparam><parameter
		       role="keyword">child</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">resize</parameter><initializer>True</initializer></methodparam>
	<methodparam><parameter
		       role="keyword">shrink</parameter><initializer>True</initializer></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkpaned--get-position">get_position</link></methodname>
	<methodparam></methodparam>  </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkpaned--set-position">set_position</link></methodname>
	<methodparam><parameter
		       role="keyword">position</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkpaned--compute-position">compute_position</link></methodname>
	<methodparam><parameter
		       role="keyword">allocation</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">child1_req</parameter></methodparam>
	<methodparam><parameter
		       role="keyword">child2_req</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link linkend="method-gtkpaned--get-child1">get_child1</link></methodname>
	<methodparam></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link linkend="method-gtkpaned--get-child2">get_child2</link></methodname>
	<methodparam></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-gtkpaned">gtk.Paned</link>
</synopsis>

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

  <refsect1 id="properties-gtkpaned">
    <title>gtk.Paned 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="4in"/>
	  <tbody>

	    <row valign="top">
	      <entry>"max-position"</entry>
	      <entry>Read</entry>
	      <entry>The largest possible value for the position property.
This property is derived from the size and shrinkability of the widget's
children. Available in GTK+ 2.4 and above.</entry>
	    </row>

	    <row valign="top">
	      <entry>"min-position"</entry>
	      <entry>Read</entry>
	      <entry>The smallest possible value for the position property.
This property is derived from the size and shrinkability of the widget's
children. Available in GTK+ 2.4 and above.</entry>
	    </row>

	    <row valign="top">
	      <entry>"position"</entry>
	      <entry>Read-Write</entry>
	      <entry>The position of the paned separator in pixels (0 means
all the way to the left or top).</entry>
	    </row>

	    <row valign="top">
	      <entry>"position-set"</entry>
	      <entry>Read-Write</entry>
	      <entry>If <literal>True</literal>, the "position" property is
valid.</entry>
	    </row>

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

  </refsect1>

  <refsect1 id="child-properties-gtkpaned">
    <title>gtk.Paned 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="4in"/>
	  <tbody>

	    <row valign="top">
	      <entry>"resize"</entry>
	      <entry>Read-Write</entry>
	      <entry>If <literal>True</literal>, the child expands and
shrinks along with the paned widget. Available in GTK+ 2.4 and above.</entry>
	    </row>

	    <row valign="top">
	      <entry>"shrink"</entry>
	      <entry>Read-Write</entry>
	      <entry>If <literal>True</literal>, the child can be made
smaller than its requisition. Available in GTK+ 2.4 and above.</entry>
	    </row>

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

  </refsect1>

  <refsect1 id="style-properties-gtkpaned">
    <title>gtk.Paned Style Properties</title>

    <para><link linkend="style-properties-gtkwidget">gtk.Widget Style 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="4in"/>
	  <tbody>

	    <row valign="top">
	      <entry>"handle-size"</entry>
	      <entry>Read</entry>
	      <entry>The width of the handle</entry>
	    </row>

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

  </refsect1>

  <refsect1 id="signal-prototypes-gtkpaned">
    <title>gtk.Paned 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>

    <variablelist>
      <varlistentry>
        <term>"<link
linkend="signal-gtkpaned--accept-position">accept-position</link>"</term>
        <listitem>
          <methodsynopsis
	    language="python"><methodname>callback</methodname>
            <methodparam><parameter>paned</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>"<link
linkend="signal-gtkpaned--cancel-position">cancel-position</link>"</term>
        <listitem>
          <methodsynopsis
	    language="python"><methodname>callback</methodname>
            <methodparam><parameter>paned</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>"<link
linkend="signal-gtkpaned--cycle-child-focus">cycle-child-focus</link>"</term>
        <listitem>
          <methodsynopsis
	    language="python"><methodname>callback</methodname>
            <methodparam><parameter>paned</parameter></methodparam>
            <methodparam><parameter>reversed</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>"<link
linkend="signal-gtkpaned--cycle-handle-focus">cycle-handle-focus</link>"</term>
        <listitem>
          <methodsynopsis
	    language="python"><methodname>callback</methodname>
            <methodparam><parameter>paned</parameter></methodparam>
            <methodparam><parameter>reversed</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>"<link
linkend="signal-gtkpaned--move-handle">move-handle</link>"</term>
        <listitem>
          <methodsynopsis
	    language="python"><methodname>callback</methodname>
            <methodparam><parameter>paned</parameter></methodparam>
            <methodparam><parameter>scrolltype</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis>
        </listitem>
      </varlistentry>

      <varlistentry>
        <term>"<link
linkend="signal-gtkpaned--toggle-handle-focus">toggle-handle-focus</link>"</term>
        <listitem>
          <methodsynopsis
	    language="python"><methodname>callback</methodname>
            <methodparam><parameter>paned</parameter></methodparam>
            <methodparam><parameter>user_param1</parameter></methodparam>
            <methodparam><parameter>...</parameter></methodparam>
          </methodsynopsis>
        </listitem>
      </varlistentry>

    </variablelist>

  </refsect1>

  <refsect1>
    <title>Description</title>

    <para><link
linkend="class-gtkpaned"><classname>gtk.Paned</classname></link> is the base
class for widgets with two panes, arranged either horizontally (<link
linkend="class-gtkhpaned"><classname>gtk.HPaned</classname></link>) or
vertically (<link
linkend="class-gtkvpaned"><classname>gtk.VPaned</classname></link>). Child
widgets are added to the panes of the widget with the <link
linkend="method-gtkpaned--pack1"><methodname>pack1</methodname>()</link> and
<link
linkend="method-gtkpaned--pack2"><methodname>pack2</methodname>()</link>
methods. The division between the two children is set by default from the
size requests of the children, but it can be adjusted by the user.</para>

    <para>A paned widget draws a separator between the two child widgets and
a small handle that the user can drag to adjust the division. It does not
draw any relief around the children or around the separator. (The space in
which the separator located is called the gutter.) Often, it is useful to
put each child inside a <link
linkend="class-gtkframe"><classname>gtk.Frame</classname></link> with the
shadow type set to <literal>gtk.SHADOW_IN</literal> so that the gutter
appears as a ridge.</para>

    <para>Each child has two options that can be set, resize and shrink. If
resize is <literal>True</literal>, when the <link
linkend="class-gtkpaned"><classname>gtk.Paned</classname></link> is resized,
that child will expand or shrink along with the paned widget. If shrink is
<literal>True</literal>, the child can be made smaller than it's
requisition. Setting shrink to <literal>False</literal> allows the
application to set a minimum size. If resize is <literal>False</literal> for
both children, the resizing behaves as if resize is <literal>True</literal>
for both children. The application can set the position of the slider by
calling the <link
linkend="method-gtkpaned--set-position"><methodname>set_position</methodname>()</link> 
method.</para>

  </refsect1>

  <refsect1>
    <title>Methods</title>

    <refsect2 id="method-gtkpaned--add1">
      <title>gtk.Paned.add1</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>add1</methodname>
	  <methodparam><parameter
			 role="keyword">child</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">child</parameter>&nbsp;:</term>
	  <listitem><simpara>the widget to add</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>add1</methodname>() method adds the widget
specified by <parameter>child</parameter> to the top or left pane with the
default packing parameters (resize is <literal>False</literal> and shrink is
<literal>True</literal>). See the <link
linkend="method-gtkpaned--pack1"><methodname>pack1</methodname>()</link>
method.</para>

    </refsect2>

    <refsect2 id="method-gtkpaned--add2">
      <title>gtk.Paned.add2</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>add2</methodname>
	  <methodparam><parameter
			 role="keyword">child</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">child</parameter>&nbsp;:</term>
	  <listitem><simpara>the widget to add</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>add2</methodname>() method adds the widget
specified by <parameter>child</parameter> to the bottom or right pane with
the default packing parameters (resize is <literal>True</literal> and shrink
is <literal>True</literal>). See the <link
linkend="method-gtkpaned--pack2"><methodname>pack2</methodname>()</link>
method.</para>

    </refsect2>

    <refsect2 id="method-gtkpaned--pack1">
      <title>gtk.Paned.pack1</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>pack1</methodname>
	  <methodparam><parameter
			 role="keyword">child</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">resize</parameter><initializer>False</initializer></methodparam>
	  <methodparam><parameter
			 role="keyword">shrink</parameter><initializer>True</initializer></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">child</parameter>&nbsp;:</term>
	  <listitem><simpara>the widget to add</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">resize</parameter>&nbsp;:</term>
	  <listitem><simpara>if <literal>True</literal>
<parameter>child</parameter> should resize when the paned is
resized</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">shrink</parameter>&nbsp;:</term>
	  <listitem><simpara>if <literal>True</literal>
<parameter>child</parameter> can be made smaller than its
minimum size request</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>pack1</methodname>() method adds the widget
specified by <parameter>child</parameter> to the top or left pane with the
parameters specified by <parameter>resize</parameter> and
<parameter>shrink</parameter>. If <parameter>resize</parameter> is
<literal>True</literal> <parameter>child</parameter> should be resized when
the paned widget is resized. If <parameter>shrink</parameter> is
<literal>True</literal> <parameter>child</parameter> can be made smaller
than its minimum size request.</para>

    </refsect2>

    <refsect2 id="method-gtkpaned--pack2">
      <title>gtk.Paned.pack2</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>pack2</methodname>
	  <methodparam><parameter
			 role="keyword">child</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">resize</parameter><initializer>True</initializer></methodparam>
	  <methodparam><parameter
			 role="keyword">shrink</parameter><initializer>True</initializer></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">child</parameter>&nbsp;:</term>
	  <listitem><simpara>the widget to add</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">resize</parameter>&nbsp;:</term>
	  <listitem><simpara>if <literal>True</literal>
<parameter>child</parameter> should resize when the paned is
resized</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter role="keyword">shrink</parameter>&nbsp;:</term>
	  <listitem><simpara>if <literal>True</literal>
<parameter>child</parameter> can be made smaller than its
minimum size request</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>pack2</methodname>() method adds the widget
specified by <parameter>child</parameter> to the bottom or right pane with
the parameters specified by <parameter>resize</parameter> and
<parameter>shrink</parameter>. If <parameter>resize</parameter> is
<literal>True</literal> <parameter>child</parameter> should be resized when
the paned widget is resized. If <parameter>shrink</parameter> is
<literal>True</literal> <parameter>child</parameter> can be made smaller
than its minimum size request.</para>

    </refsect2>

    <refsect2 id="method-gtkpaned--get-position">
      <title>gtk.Paned.get_position</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_position</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the position of the divider</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>get_position</methodname>() method returns the
position of the divider in pixels between the two panes.</para>

    </refsect2>

    <refsect2 id="method-gtkpaned--set-position">
      <title>gtk.Paned.set_position</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>set_position</methodname>
	  <methodparam><parameter
			 role="keyword">position</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">position</parameter>&nbsp;:</term>
	  <listitem><simpara>the new pixel position of divider, a negative
value means that the position is unset.</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>set_position</methodname>() method sets the
position of the divider between the two panes to the value specified by
<parameter>position</parameter> and sets the "position-set" property to
<literal>True</literal> if <parameter>position</parameter> is non-negative.
If <parameter>position</parameter> is negative the divider position will be
recalculated by the paned widget using the child widget requisitions and the
"position-set" property will be set to <literal>False</literal>.</para>

    </refsect2>

    <refsect2 id="method-gtkpaned--compute-position">
      <title>gtk.Paned.compute_position</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>compute_position</methodname>
	  <methodparam><parameter
			 role="keyword">allocation</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">child1_req</parameter></methodparam>
	  <methodparam><parameter
			 role="keyword">child2_req</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter
role="keyword">allocation</parameter>&nbsp;:</term>
	  <listitem><simpara>the total space allocation in pixels for the
paned widget</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter
role="keyword">child1_req</parameter>&nbsp;:</term>
	  <listitem><simpara>the minimum space in pixels required for the
left or top child widget</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter
role="keyword">child2_req</parameter>&nbsp;:</term>
	  <listitem><simpara>the minimum space in pixels required for the
right or bottom child widget</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>compute_position</methodname>() method computes
the position of the separator according to the specification of the
parameters: <parameter>allocation</parameter>,
<parameter>child1_req</parameter> and <parameter>child2_req</parameter>. The
calculation is affected by the packing parameters of the child widgets
depending on whether they can resize and shrink. This method is used by
subclasses of <link
linkend="class-gtkpaned"><classname>gtk.Paned</classname></link> and is
usually not needed by applications. the <link
linkend="method-gtkwidget--queue-resize"><methodname>gtk.Widget.queue_resize</methodname>()</link> 
method must be called after this method to have the resizing
displayed.</para>

      <para>The minimum position is 0 if child1's shrink value is
<literal>True</literal> or the value of <parameter>child1_req</parameter>,
if <literal>False</literal>. The maximum position is the value of
<parameter>allocation</parameter> if child2's shrink value is True, or the
value of (<parameter>allocation</parameter> -
<parameter>child2_req</parameter>), if <literal>False</literal>. The final
calculated position will be between the minimum and maximum
positions.</para>

    </refsect2>

    <refsect2 id="method-gtkpaned--get-child1">
      <title>gtk.Paned.get_child1</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_child1</methodname>
	  <methodparam></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the first child, or<literal>None</literal></simpara></listitem>
	</varlistentry>
      </variablelist>

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

      <para>The <methodname>get_child1</methodname>() method returns the
first child of the paned widget.</para>

    </refsect2>

    <refsect2 id="method-gtkpaned--get-child2">
      <title>gtk.Paned.get_child2</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>get_child2</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>the second child, or
<literal>None</literal></simpara></listitem>
	</varlistentry>
      </variablelist>

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

      <para>The <methodname>get_child2</methodname>() method returns 
the second child of the paned widget.</para>

    </refsect2>

  </refsect1>

  <refsect1>
    <title>Signals</title>

    <refsect2 id="signal-gtkpaned--accept-position">
      <title>The "accept-position" gtk.Paned Signal</title>

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

      <variablelist>
	<varlistentry>
	  <term><parameter>paned</parameter>&nbsp;:</term>
	  <listitem><simpara>the paned 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>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara><literal>True</literal> if the signal was
handled</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The "accept-position" signal is emitted when
<parameter>paned</parameter> has the focus and any of the
<keycap>Return</keycap>, <keycap>Enter</keycap>, <keycap>Space</keycap> keys
are pressed. This will also cause the child widget with the focus to be
activated.</para>

    </refsect2>

    <refsect2 id="signal-gtkpaned--cancel-position">
      <title>The "cancel-position" gtk.Paned Signal</title>

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

      <variablelist>
	<varlistentry>
	  <term><parameter>paned</parameter>&nbsp;:</term>
	  <listitem><simpara>the paned 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>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara><literal>True</literal> if the signal was
handled</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The "cancel-position" signal is emitted when the
<keycap>Esc</keycap> key is pressed while <parameter>paned</parameter> has
the focus.</para>

    </refsect2>

    <refsect2 id="signal-gtkpaned--cycle-child-focus">
      <title>The "cycle-child-focus" gtk.Paned Signal</title>

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

      <variablelist>
	<varlistentry>
	  <term><parameter>paned</parameter>&nbsp;:</term>
	  <listitem><simpara>the paned that received the
signal</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>reversed</parameter>&nbsp;:</term>
	  <listitem><simpara>if <literal>True</literal> the focus cycle
direction should be reversed</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>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara><literal>True</literal> if the signal was
handled</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The "cycle-child-focus" signal is emitted when
<keycap>F6</keycap> or <keycombo
action="simul"><keycap>Shift</keycap><keycap>F6</keycap> </keycombo> is
pressed while <parameter>paned</parameter> has the focus.</para>

    </refsect2>

    <refsect2 id="signal-gtkpaned--cycle-handle-focus">
      <title>The "cycle-handle-focus" gtk.Paned Signal</title>

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

      <variablelist>
	<varlistentry>
	  <term><parameter>paned</parameter>&nbsp;:</term>
	  <listitem><simpara>the paned that received the
signal</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>reversed</parameter>&nbsp;:</term>
	  <listitem><simpara>if <literal>True</literal> the focus cycle
direction should be reversed</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>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara><literal>True</literal> if the signal was
handled</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The "cycle-handle-focus" signal is emitted when
<parameter>paned</parameter> has the focus and any of the
<keycap>Tab</keycap>,
<keycombo action="simul"><keycap>Ctrl</keycap><keycap>Tab</keycap>
	</keycombo>, <keycombo action="simul"><keycap>Shift</keycap><keycap>Tab</keycap>
	</keycombo> or
<keycombo action="simul"><keycap>Ctrl</keycap><keycap>Shift</keycap><keycap>Tab</keycap>
	</keycombo>  keys combinations are pressed. <keycap>Tab</keycap> and
<keycombo action="simul"><keycap>Ctrl</keycap><keycap>Tab</keycap>
	</keycombo> set <parameter>reversed</parameter> to
<literal>False</literal> while
<keycombo action="simul"><keycap>Shift</keycap><keycap>Tab</keycap>
	</keycombo> and <keycombo action="simul"><keycap>Ctrl</keycap><keycap>Shift</keycap><keycap>Tab</keycap>
	</keycombo> set <parameter>reversed</parameter> to
<literal>True</literal>.</para>

    </refsect2>

    <refsect2 id="signal-gtkpaned--move-handle">
      <title>The "move-handle" gtk.Paned Signal</title>

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

      <variablelist>
	<varlistentry>
	  <term><parameter>paned</parameter>&nbsp;:</term>
	  <listitem><simpara>the paned that received the
signal</simpara></listitem>
	</varlistentry>
	<varlistentry>
	  <term><parameter>scrolltype</parameter>&nbsp;:</term>
	  <listitem><simpara>the scroll type:
<literal>gtk.SCROLL_NONE</literal>, <literal>gtk.SCROLL_JUMP</literal>,
<literal>gtk.SCROLL_STEP_BACKWARD</literal>,
<literal>gtk.SCROLL_STEP_FORWARD</literal>,
<literal>gtk.SCROLL_PAGE_BACKWARD</literal>,
<literal>gtk.SCROLL_PAGE_FORWARD</literal>,
<literal>gtk.SCROLL_STEP_UP</literal>,
<literal>gtk.SCROLL_STEP_DOWN</literal>,
<literal>gtk.SCROLL_PAGE_UP</literal>,
<literal>gtk.SCROLL_PAGE_DOWN</literal>,
<literal>gtk.SCROLL_STEP_LEFT</literal>,
<literal>gtk.SCROLL_STEP_RIGHT</literal>,
<literal>gtk.SCROLL_PAGE_LEFT</literal>,
<literal>gtk.SCROLL_PAGE_RIGHT</literal>,
<literal>gtk.SCROLL_START</literal> or
<literal>gtk.SCROLL_END</literal></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>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara><literal>True</literal> if the signal was
handled</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The "move-handle" signal is emitted when
<parameter>paned</parameter> has the focus and one of the following key
combinations is pressed to move the separator:</para>

      <itemizedlist>
	<listitem>
	  <simpara><keycombo><keycap>Left
Arrow</keycap></keycombo></simpara>
	</listitem>
	<listitem>
	  <simpara><keycombo><keycap>Right
Arrow</keycap></keycombo></simpara>
	</listitem>
	<listitem>
	  <simpara><keycombo><keycap>Up Arrow</keycap></keycombo></simpara>
	</listitem>
	<listitem>
	  <simpara><keycombo><keycap>Down
Arrow</keycap></keycombo></simpara>
	</listitem>
	<listitem>
	  <simpara><keycombo><keycap>Page Up</keycap></keycombo></simpara>
	</listitem>
	<listitem>
	  <simpara><keycombo><keycap>Page Down</keycap></keycombo></simpara>
	</listitem>
	<listitem>
	  <simpara><keycombo><keycap>Home</keycap></keycombo></simpara>
	</listitem>
	<listitem>
	  <simpara><keycombo><keycap>End</keycap></keycombo></simpara>
	</listitem>
      </itemizedlist>

      <para>The value of <parameter>scrolltype</parameter> is one of:
<literal>gtk.SCROLL_NONE</literal>, <literal>gtk.SCROLL_JUMP</literal>,
<literal>gtk.SCROLL_STEP_BACKWARD</literal>,
<literal>gtk.SCROLL_STEP_FORWARD</literal>,
<literal>gtk.SCROLL_PAGE_BACKWARD</literal>,
<literal>gtk.SCROLL_PAGE_FORWARD</literal>,
<literal>gtk.SCROLL_STEP_UP</literal>,
<literal>gtk.SCROLL_STEP_DOWN</literal>,
<literal>gtk.SCROLL_PAGE_UP</literal>,
<literal>gtk.SCROLL_PAGE_DOWN</literal>,
<literal>gtk.SCROLL_STEP_LEFT</literal>,
<literal>gtk.SCROLL_STEP_RIGHT</literal>,
<literal>gtk.SCROLL_PAGE_LEFT</literal>,
<literal>gtk.SCROLL_PAGE_RIGHT</literal>,
<literal>gtk.SCROLL_START</literal> or <literal>gtk.SCROLL_END</literal>.
The default handler for this signal moves the separator if the separator has
the focus.</para>

    </refsect2>

    <refsect2 id="signal-gtkpaned--toggle-handle-focus">
      <title>The "toggle-handle-focus" gtk.Paned Signal</title>

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

      <variablelist>
	<varlistentry>
	  <term><parameter>paned</parameter>&nbsp;:</term>
	  <listitem><simpara>the paned 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>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara><literal>True</literal> if the signal was
handled</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The "toggle-handle-focus" signal is emitted when
<parameter>paned</parameter> has the focus and <keycap>F8</keycap> is
pressed to give the focus to or take the focus from the separator
handle.</para>

    </refsect2>

  </refsect1>

</refentry>