source: pkg/pygtk/branches/upstream/current/docs/reference/pygtk-gtkbin.xml @ 4

<?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-gtkbin">
  <refnamediv>
    <refname>gtk.Bin</refname>
    <refpurpose>an abstract base class defining a container with just one
child.</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtk.Bin</classname></ooclass>
      <ooclass><classname><link
linkend="class-gtkcontainer">gtk.Container</link></classname></ooclass>
      <methodsynopsis language="python">
        <methodname><link
linkend="method-gtkbin--get-child">get_child</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-gtkbin">gtk.Bin</link>
</synopsis>

  </refsect1>

  <refsect1 id="properties-gtkbin">
    <title>gtk.Bin 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>


  </refsect1>

  <refsect1 id="style-properties-gtkbin">
    <title>gtk.Bin Style Properties</title>

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


  </refsect1>

  <refsect1 id="signal-prototypes-gtkbin">
    <title>gtk.Bin 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>Attributes</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>"child"</entry>
              <entry>Read</entry>
              <entry>The child widget or <literal>None</literal> if there
is no child.</entry>
            </row>

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

  </refsect1>

  <refsect1>
    <title>Description</title>

    <para><link linkend="class-gtkbin"><classname>gtk.Bin</classname></link>
is an abstract base class defining a widget that is a container with just
one child. It is useful for deriving subclasses, since it provides the
common code needed for handling a single child widget. Many PyGTK widgets
are subclasses of <link
linkend="class-gtkbin"><classname>gtk.Bin</classname></link>, including
<link linkend="class-gtkwindow"><classname>gtk.Window</classname></link>,
<link linkend="class-gtkbutton"><classname>gtk.Button</classname></link>,
<link linkend="class-gtkframe"><classname>gtk.Frame</classname></link>,
<link
linkend="class-gtkhandlebox"><classname>gtk.HandleBox</classname></link>,
and <link
linkend="class-gtkscrolledwindow"><classname>gtk.ScrolledWindow</classname></link>.</para>

  </refsect1>

  <refsect1>
    <title>Methods</title>

    <refsect2 id="method-gtkbin--get-child">
      <title>gtk.Bin.get_child</title>

      <programlisting><methodsynopsis language="python">
          <methodname>get_child</methodname>
          <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
        <varlistentry>
          <term><emphasis>Returns</emphasis>&nbsp;:</term>
          <listitem><simpara>a reference to the child
widget</simpara></listitem>
        </varlistentry>
      </variablelist>

      <para>The <methodname>get_child</methodname>() method returns a
reference to the child of the bin, or <literal>None</literal> if the bin
contains no child widget.</para>

    </refsect2>

  </refsect1>

</refentry>