<?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-gtkwindowgroup">
  <refnamediv>
    <refname>gtk.WindowGroup</refname>
    <refpurpose>a group of <link
linkend="class-gtkwindow"><classname>gtk.Window</classname></link>
widgets</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtk.WindowGroup</classname></ooclass>
      <ooclass><classname><link
linkend="class-gobject">gobject.GObject</link></classname></ooclass>
      <constructorsynopsis language="python">
	<methodname><link
linkend="constructor-gtkwindowgroup">gtk.WindowGroup</link></methodname>
	<methodparam></methodparam>  </constructorsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkwindowgroup--add-window">add_window</link></methodname>
	<methodparam><parameter
		       role="keyword">window</parameter></methodparam>
      </methodsynopsis>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkwindowgroup--remove-window">remove_window</link></methodname>
	<methodparam><parameter
		       role="keyword">window</parameter></methodparam>
      </methodsynopsis>
    </classsynopsis>

  </refsect1>

  <refsect1>
    <title>Ancestry</title>

<synopsis>+-- <link linkend="class-gobject">gobject.GObject</link>
  +-- <link linkend="class-gtkwindowgroup">gtk.WindowGroup</link>
</synopsis>

  </refsect1>

  <refsect1 id="signal-prototypes-gtkwindowgroup">
    <title>gtk.WindowGroup Signal Prototypes</title>

    <para><link linkend="signal-prototypes-gobject">gobject.GObject Signal Prototypes</link></para>
  </refsect1>

  <refsect1>
    <title>Description</title>

    <para>A <link
linkend="class-gtkwindowgroup"><classname>gtk.WindowGroup</classname></link>
object contains a set of <link
linkend="class-gtkwindow"><classname>gtk.Window</classname></link> widgets
that are managed together by some <literal>PyGTK</literal> functions and
methods.</para>

  </refsect1>

  <refsect1 id="constructor-gtkwindowgroup">
    <title>Constructor</title>

    <programlisting><constructorsynopsis language="python">
	<methodname>gtk.WindowGroup</methodname>
	<methodparam></methodparam>  </constructorsynopsis></programlisting>
    <variablelist>
      <varlistentry>
	<term><emphasis>Returns</emphasis>&nbsp;:</term>
	<listitem><simpara>a new <link
linkend="class-gtkwindowgroup"><classname>gtk.WindowGroup</classname></link>.</simpara></listitem>
      </varlistentry>
    </variablelist>

    <para>Creates a new <link
linkend="class-gtkwindowgroup"><classname>gtk.WindowGroup</classname></link>
object. Grabs added with <link
linkend="method-gtkwidget--grab-add"><methodname>gtk.Widget.grab_add</methodname>()</link> 
only affect windows within the same <link
linkend="class-gtkwindowgroup"><classname>gtk.WindowGroup</classname></link>.</para>

  </refsect1>

  <refsect1>
    <title>Methods</title>

    <refsect2 id="method-gtkwindowgroup--add-window">
      <title>gtk.WindowGroup.add_window</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>add_window</methodname>
	  <methodparam><parameter
			 role="keyword">window</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">window</parameter>&nbsp;:</term>
	  <listitem><simpara>the <link
linkend="class-gtkwindow"><classname>gtk.Window</classname></link> to
add</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>add_window</methodname>() method adds the <link
linkend="class-gtkwindow"><classname>gtk.Window</classname></link> specified
by <parameter>window</parameter> to the windowgroup.</para>

    </refsect2>

    <refsect2 id="method-gtkwindowgroup--remove-window">
      <title>gtk.WindowGroup.remove_window</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>remove_window</methodname>
	  <methodparam><parameter
			 role="keyword">window</parameter></methodparam>
	</methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><parameter role="keyword">window</parameter>&nbsp;:</term>
	  <listitem><simpara>the <link
linkend="class-gtkwindow"><classname>gtk.Window</classname></link> to
remove</simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>remove_window</methodname>() method removes the
<link linkend="class-gtkwindow"><classname>gtk.Window</classname></link>
specified by <parameter>window</parameter> from the windowgroup.</para>

    </refsect2>

  </refsect1>

</refentry>
