File: pygtk-gtkwindowgroup.xml

package info (click to toggle)
pygtk 2.24.0-3
  • links: PTS, VCS
  • area: main
  • in suites: wheezy
  • size: 26,636 kB
  • sloc: xml: 182,079; sh: 10,297; python: 10,161; ansic: 2,861; makefile: 1,351
file content (141 lines) | stat: -rw-r--r-- 4,740 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
<?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>