blob: b37bd3a7bcdb673a05644a79a084814e3e21ba2f (
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
|
<?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-gdkrectangle">
<refnamediv>
<refname>gtk.gdk.Rectangle</refname>
<refpurpose>an object holding data about a rectangle</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>gtk.gdk.Rectangle</classname></ooclass>
<ooclass><classname>gobject.GBoxed</classname></ooclass>
<constructorsynopsis language="python">
<methodname><link
linkend="constructor-gdkrectangle">gtk.gdk.Rectangle</link></methodname>
<methodparam><parameter
role="keyword">x</parameter>
<initializer>0</initializer></methodparam>
<methodparam><parameter
role="keyword">y</parameter>
<initializer>0</initializer></methodparam>
<methodparam><parameter
role="keyword">width</parameter>
<initializer>0</initializer></methodparam>
<methodparam><parameter
role="keyword">height</parameter>
<initializer>0</initializer></methodparam>
</constructorsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gdkrectangle--intersect">intersect</link></methodname>
<methodparam><parameter
role="keyword">src</parameter></methodparam>
</methodsynopsis>
<methodsynopsis language="python">
<methodname><link
linkend="method-gdkrectangle--union">union</link></methodname>
<methodparam><parameter
role="keyword">src</parameter></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>"x"</entry>
<entry>Read-Write</entry>
<entry>The X coordinate of the top left corner of the
rectangle.</entry>
</row>
<row valign="top">
<entry>"y"</entry>
<entry>Read-Write</entry>
<entry>The Y coordinate of the top left corner of the
rectangle.</entry>
</row>
<row valign="top">
<entry>"width"</entry>
<entry>Read-Write</entry>
<entry>The width of the rectangle.</entry>
</row>
<row valign="top">
<entry>"height"</entry>
<entry>Read-Write</entry>
<entry>The height of the rectangle.</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</blockquote>
</refsect1>
<refsect1>
<title>Description</title>
<para>A <link
linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
holds the position and size of a rectangle. The position is specified by the
"x" and "y" attributes and the size, by the "width" and "height"
attributes.</para>
<para>
Starting with PyGTK 2.14 <classname>gtk.gdk.Rectangle</classname> objects are
properly comparable. By Python rules, rectangles (being mutable) are now
unhashable. If you need to use them as dictionary keys, convert rectangle objects
to tuples first. You can convert such tuples back
to <classname>gtk.gdk.Rectangle</classname> using the following code:
</para>
<programlisting>
rectangle = gtk.gdk.Rectangle(*tuple)
</programlisting>
<para>
Also beginning with PyGTK 2.14 <classname>gtk.gdk.Rectangle</classname> objects have
custom support for <function>repr</function> Python function. For any rectangle it
holds that:
</para>
<programlisting>
rectangle == eval(repr(rectangle))
</programlisting>
</refsect1>
<refsect1 id="constructor-gdkrectangle">
<title>Constructor</title>
<programlisting><constructorsynopsis language="python">
<methodname>gtk.gdk.Rectangle</methodname>
<methodparam><parameter
role="keyword">x</parameter>
<initializer>0</initializer></methodparam>
<methodparam><parameter
role="keyword">y</parameter>
<initializer>0</initializer></methodparam>
<methodparam><parameter
role="keyword">width</parameter>
<initializer>0</initializer></methodparam>
<methodparam><parameter
role="keyword">height</parameter>
<initializer>0</initializer></methodparam>
</constructorsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">x</parameter> :</term>
<listitem><simpara>the X coordinate of the top left corner of the
rectangle</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">y</parameter> :</term>
<listitem><simpara>the Y coordinate of the top left corner of the
rectangle</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">width</parameter> :</term>
<listitem><simpara>the width of the rectangle</simpara></listitem>
</varlistentry>
<varlistentry>
<term><parameter role="keyword">height</parameter> :</term>
<listitem><simpara>the height of the rectangle</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new <link
linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
object</simpara></listitem>
</varlistentry>
</variablelist>
<para>Creates a new <link
linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
with the attributes specified by <parameter>x</parameter>,
<parameter>y</parameter>, <parameter>width</parameter> and
<parameter>height</parameter>. Any unspecified attributes default to
0.</para>
</refsect1>
<refsect1>
<title>Methods</title>
<refsect2 id="method-gdkrectangle--intersect">
<title>gtk.gdk.Rectangle.intersect</title>
<programlisting><methodsynopsis language="python">
<methodname>intersect</methodname>
<methodparam><parameter
role="keyword">src</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">src</parameter> :</term>
<listitem><simpara>a <link
linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
of a 4-tuple specifying the attributes of a rectangle as (x, y, width,
height)</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a <link
linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
that is the intersection of <parameter>src</parameter> and the
rectangle</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>intersect</methodname>() method returns a <link
linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
that is the intersection of this rectangle and the <link
linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
specified by <parameter>src</parameter>. The value of
<parameter>src</parameter> is either a <link
linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
or a 4-tuple containing the position and size of a rectangle. If the
rectangles do not intersect the returned <link
linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
will have all attributes set to 0.</para>
</refsect2>
<refsect2 id="method-gdkrectangle--union">
<title>gtk.gdk.Rectangle.union</title>
<programlisting><methodsynopsis language="python">
<methodname>union</methodname>
<methodparam><parameter
role="keyword">src</parameter></methodparam>
</methodsynopsis></programlisting>
<variablelist>
<varlistentry>
<term><parameter role="keyword">src</parameter> :</term>
<listitem><simpara>a <link
linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
of a 4-tuple specifying the attributes of a rectangle as (x, y, width,
height)</simpara></listitem>
</varlistentry>
<varlistentry>
<term><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a <link
linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
that includes both <parameter>src</parameter> and the
rectangle</simpara></listitem>
</varlistentry>
</variablelist>
<para>The <methodname>union</methodname>() method returns a <link
linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
that is the smallest rectangle containing both this rectangle and the <link
linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
specified by <parameter>src</parameter>. The value of
<parameter>src</parameter> is either a <link
linkend="class-gdkrectangle"><classname>gtk.gdk.Rectangle</classname></link>
or a 4-tuple containing the position and size of a rectangle.</para>
</refsect2>
</refsect1>
</refentry>
|
