summaryrefslogtreecommitdiff
path: root/docs/reference/pygtk-gtkrequisition.xml
blob: c7ce26665e557349940b342d95c5da575fdc3063 (plain)
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
<?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-gtkrequisition">
  <refnamediv>
    <refname>gtk.Requisition</refname>
    <refpurpose>an object containing information about the desired space
requirements of a widget.</refpurpose>
  </refnamediv>

  <refsect1>
    <title>Synopsis</title>

    <classsynopsis language="python">
      <ooclass><classname>gtk.Requisition</classname></ooclass>
      <ooclass><classname>gobject.GBoxed</classname></ooclass>
      <methodsynopsis language="python">
	<methodname><link
linkend="method-gtkrequisition--copy">copy</link></methodname>
	<methodparam></methodparam>  </methodsynopsis>
      <methodsynopsis language="python">
        <methodname><link
linkend="method-gtkrequisition--free">free</link></methodname>
        <methodparam></methodparam>  </methodsynopsis>
    </classsynopsis>

  </refsect1>

  <refsect1>
    <title>Attributes</title>

    <blockquote role="properties">
      <informaltable pgwide="1" frame="none">
	<tgroup cols="3">
	<?dbhtml cellpadding="5"?>
	  <colspec column="1" colwidth="1in"/>
	  <colspec column="2" colwidth="1in"/>
	  <colspec column="3" colwidth="4in"/>
	  <tbody>

	    <row valign="top">
	      <entry>"width"</entry>
	      <entry>Read-Write</entry>
	      <entry>the desired width of the widget</entry>
	    </row>

	    <row valign="top">
	      <entry>"height"</entry>
	      <entry>Read-Write</entry>
	      <entry>the desired height of the widget</entry>
	    </row>

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

  </refsect1>

  <refsect1>
    <title>Description</title>

    <para>A <link
linkend="class-gtkrequisition"><classname>gtk.Requisition</classname></link>
holds the information about the desired space requirements (width and
height) of a widget. A <link
linkend="class-gtkrequisition"><classname>gtk.Requisition</classname></link>
object has <literal>width</literal> and <literal>height</literal> attributes
that can be read and written.</para>

    <note>
      <para>There appears to be no way to create or use a <link
linkend="class-gtkrequisition"><classname>gtk.Requisition</classname></link>
in PyGTK other than as an argument in the handler for the <link
linkend="class-gtkwidget"><classname>gtk.Widget</classname></link> "<link
linkend="signal-gtkwidget--size-request">size-request</link>" signal.</para>
    </note>

  </refsect1>

  <refsect1>
    <title>Methods</title>

    <refsect2 id="method-gtkrequisition--copy">
      <title>gtk.Requisition.copy</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>copy</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>
      <variablelist>
	<varlistentry>
	  <term><emphasis>Returns</emphasis>&nbsp;:</term>
	  <listitem><simpara>a copy of the <link
linkend="class-gtkrequisition"><classname>gtk.Requisition</classname></link></simpara></listitem>
	</varlistentry>
      </variablelist>

      <para>The <methodname>copy</methodname>() method returns a copy of the
<link
linkend="class-gtkrequisition"><classname>gtk.Requisition</classname></link>.</para>

    </refsect2>

    <refsect2 id="method-gtkrequisition--free">
      <title>gtk.Requisition.free</title>

      <programlisting><methodsynopsis language="python">
	  <methodname>free</methodname>
	  <methodparam></methodparam>  </methodsynopsis></programlisting>

      <warning>
        <para>This method is deprecated and should not be used since it can
 crash your application.</para>
      </warning>

      <para>The <methodname>free</methodname>() method frees the resources
allocated to the <link
linkend="class-gtkrequisition"><classname>gtk.Requisition</classname></link>.</para>

    </refsect2>

  </refsect1>

</refentry>