~ubuntu-branches/ubuntu/natty/pygtk/natty-proposed

« back to all changes in this revision

Viewing changes to docs/html/class-gdkrectangle.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2010-01-07 11:08:47 UTC
  • mfrom: (1.2.8 upstream)
  • Revision ID: james.westby@ubuntu.com-20100107110847-f5av7e1ttudh7ra6
Tags: 2.17.0-0ubuntu1
New upstream version

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.gdk.Rectangle</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.73.2"><link rel="start" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gdk-class-reference.html" title="The gtk.gdk Class Reference"><link rel="prev" href="class-gdkpixmap.html" title="gtk.gdk.Pixmap"><link rel="next" href="class-gdkregion.html" title="gtk.gdk.Region"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.gdk.Rectangle</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gdkpixmap.html">Prev</a> </td><th width="60%" align="center">The gtk.gdk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gdkregion.html">Next</a></td></tr></table><hr></div><div class="refentry" lang="en"><a name="class-gdkrectangle"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.gdk.Rectangle</h2><p>gtk.gdk.Rectangle — an object holding data about a rectangle</p></div><div class="refsect1" lang="en"><a name="id3025772"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.gdk.Rectangle</span></span>(<span class="ooclass"><span class="classname">gobject.GBoxed</span></span>):
2
 
<code class="constructorsynopsis">    <span class="methodname"><a class="link" href="class-gdkrectangle.html#constructor-gdkrectangle" title="Constructor">gtk.gdk.Rectangle</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>x</code></strong></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>y</code></strong></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>width</code></strong></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>height</code></strong></span><span class="initializer">=0</span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkrectangle.html#method-gdkrectangle--intersect" title="gtk.gdk.Rectangle.intersect">intersect</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>src</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkrectangle.html#method-gdkrectangle--union" title="gtk.gdk.Rectangle.union">union</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>src</code></strong></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" lang="en"><a name="id3025934"></a><h2>Attributes</h2><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table cellpadding="5" width="100%" border="0"><colgroup><col><col><col></colgroup><tbody><tr valign="top"><td valign="top">"x"</td><td valign="top">Read-Write</td><td valign="top">The X coordinate of the top left corner of the
 
1
<html><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><title>gtk.gdk.Rectangle</title><link rel="stylesheet" href="style.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.75.1"><link rel="home" href="index.html" title="PyGTK 2.0 Reference Manual"><link rel="up" href="gdk-class-reference.html" title="The gtk.gdk Class Reference"><link rel="prev" href="class-gdkpixmap.html" title="gtk.gdk.Pixmap"><link rel="next" href="class-gdkregion.html" title="gtk.gdk.Region"></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">gtk.gdk.Rectangle</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="class-gdkpixmap.html">Prev</a> </td><th width="60%" align="center">The gtk.gdk Class Reference</th><td width="20%" align="right"> <a accesskey="n" href="class-gdkregion.html">Next</a></td></tr></table><hr></div><div class="refentry" title="gtk.gdk.Rectangle"><a name="class-gdkrectangle"></a><div class="titlepage"></div><div class="refnamediv"><h2>gtk.gdk.Rectangle</h2><p>gtk.gdk.Rectangle — an object holding data about a rectangle</p></div><div class="refsect1" title="Synopsis"><a name="id3352955"></a><h2>Synopsis</h2><table bgcolor="#D0E0F0" width="100%"><tr><td><pre class="classsynopsis">class <span class="ooclass"><span class="classname">gtk.gdk.Rectangle</span></span>(<span class="ooclass"><span class="classname">gobject.GBoxed</span></span>):
 
2
<code class="constructorsynopsis">    <span class="methodname"><a class="link" href="class-gdkrectangle.html#constructor-gdkrectangle" title="Constructor">gtk.gdk.Rectangle</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>x</code></strong></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>y</code></strong></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>width</code></strong></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>height</code></strong></span><span class="initializer">=0</span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkrectangle.html#method-gdkrectangle--intersect" title="gtk.gdk.Rectangle.intersect">intersect</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>src</code></strong></span></span>)</code><br><code class="methodsynopsis">    def <span class="methodname"><a class="link" href="class-gdkrectangle.html#method-gdkrectangle--union" title="gtk.gdk.Rectangle.union">union</a></span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>src</code></strong></span></span>)</code><br></pre></td></tr></table></div><div class="refsect1" title="Attributes"><a name="id3353117"></a><h2>Attributes</h2><div class="blockquote"><table width="100%" border="0" bgcolor="#E0E0E0"><tr><td valign="top"><div class="informaltable"><table cellpadding="5" width="100%" border="0"><colgroup><col width="1in"><col width="1in"><col width="4in"></colgroup><tbody><tr valign="top"><td valign="top">"x"</td><td valign="top">Read-Write</td><td valign="top">The X coordinate of the top left corner of the
3
3
rectangle.</td></tr><tr valign="top"><td valign="top">"y"</td><td valign="top">Read-Write</td><td valign="top">The Y coordinate of the top left corner of the
4
 
rectangle.</td></tr><tr valign="top"><td valign="top">"width"</td><td valign="top">Read-Write</td><td valign="top">The width of the rectangle.</td></tr><tr valign="top"><td valign="top">"height"</td><td valign="top">Read-Write</td><td valign="top">The height of the rectangle.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" lang="en"><a name="id3026059"></a><h2>Description</h2><p>A <a class="link" href="class-gdkrectangle.html" title="gtk.gdk.Rectangle"><code class="classname">gtk.gdk.Rectangle</code></a>
 
4
rectangle.</td></tr><tr valign="top"><td valign="top">"width"</td><td valign="top">Read-Write</td><td valign="top">The width of the rectangle.</td></tr><tr valign="top"><td valign="top">"height"</td><td valign="top">Read-Write</td><td valign="top">The height of the rectangle.</td></tr></tbody></table></div></td></tr></table></div></div><div class="refsect1" title="Description"><a name="id3353242"></a><h2>Description</h2><p>A <a class="link" href="class-gdkrectangle.html" title="gtk.gdk.Rectangle"><code class="classname">gtk.gdk.Rectangle</code></a>
5
5
holds the position and size of a rectangle. The position is specified by the
6
6
"x" and "y" attributes and the size, by the "width" and "height"
7
7
attributes.</p><p>
18
18
      holds that:
19
19
    </p><pre class="programlisting">
20
20
  rectangle == eval(repr(rectangle))
21
 
    </pre></div><div class="refsect1" lang="en"><a name="constructor-gdkrectangle"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis">    <span class="methodname">gtk.gdk.Rectangle</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>x</code></strong></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>y</code></strong></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>width</code></strong></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>height</code></strong></span><span class="initializer">=0</span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>x</code></strong> :</span></p></td><td>the X coordinate of the top left corner of the
 
21
    </pre></div><div class="refsect1" title="Constructor"><a name="constructor-gdkrectangle"></a><h2>Constructor</h2><pre class="programlisting"><code class="constructorsynopsis">    <span class="methodname">gtk.gdk.Rectangle</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>x</code></strong></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>y</code></strong></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>width</code></strong></span><span class="initializer">=0</span></span>, <span class="methodparam"><span class="parameter"><strong class="parameter"><code>height</code></strong></span><span class="initializer">=0</span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>x</code></strong> :</span></p></td><td>the X coordinate of the top left corner of the
22
22
rectangle</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>y</code></strong> :</span></p></td><td>the Y coordinate of the top left corner of the
23
23
rectangle</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>width</code></strong> :</span></p></td><td>the width of the rectangle</td></tr><tr><td><p><span class="term"><strong class="parameter"><code>height</code></strong> :</span></p></td><td>the height of the rectangle</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a new <a class="link" href="class-gdkrectangle.html" title="gtk.gdk.Rectangle"><code class="classname">gtk.gdk.Rectangle</code></a>
24
24
object</td></tr></tbody></table><p>Creates a new <a class="link" href="class-gdkrectangle.html" title="gtk.gdk.Rectangle"><code class="classname">gtk.gdk.Rectangle</code></a>
25
25
with the attributes specified by <em class="parameter"><code>x</code></em>,
26
26
<em class="parameter"><code>y</code></em>, <em class="parameter"><code>width</code></em> and
27
27
<em class="parameter"><code>height</code></em>. Any unspecified attributes default to
28
 
0.</p></div><div class="refsect1" lang="en"><a name="id3026353"></a><h2>Methods</h2><div class="refsect2" lang="en"><a name="method-gdkrectangle--intersect"></a><h3>gtk.gdk.Rectangle.intersect</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">intersect</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>src</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>src</code></strong> :</span></p></td><td>a <a class="link" href="class-gdkrectangle.html" title="gtk.gdk.Rectangle"><code class="classname">gtk.gdk.Rectangle</code></a>
 
28
0.</p></div><div class="refsect1" title="Methods"><a name="id3353536"></a><h2>Methods</h2><div class="refsect2" title="gtk.gdk.Rectangle.intersect"><a name="method-gdkrectangle--intersect"></a><h3>gtk.gdk.Rectangle.intersect</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">intersect</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>src</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>src</code></strong> :</span></p></td><td>a <a class="link" href="class-gdkrectangle.html" title="gtk.gdk.Rectangle"><code class="classname">gtk.gdk.Rectangle</code></a>
29
29
of a 4-tuple specifying the attributes of a rectangle as (x, y, width,
30
30
height)</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a <a class="link" href="class-gdkrectangle.html" title="gtk.gdk.Rectangle"><code class="classname">gtk.gdk.Rectangle</code></a>
31
31
that is the intersection of <em class="parameter"><code>src</code></em> and the
35
35
<em class="parameter"><code>src</code></em> is either a <a class="link" href="class-gdkrectangle.html" title="gtk.gdk.Rectangle"><code class="classname">gtk.gdk.Rectangle</code></a>
36
36
or a 4-tuple containing the position and size of a rectangle. If the
37
37
rectangles do not intersect the returned <a class="link" href="class-gdkrectangle.html" title="gtk.gdk.Rectangle"><code class="classname">gtk.gdk.Rectangle</code></a>
38
 
will have all attributes set to 0.</p></div><div class="refsect2" lang="en"><a name="method-gdkrectangle--union"></a><h3>gtk.gdk.Rectangle.union</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">union</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>src</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>src</code></strong> :</span></p></td><td>a <a class="link" href="class-gdkrectangle.html" title="gtk.gdk.Rectangle"><code class="classname">gtk.gdk.Rectangle</code></a>
 
38
will have all attributes set to 0.</p></div><div class="refsect2" title="gtk.gdk.Rectangle.union"><a name="method-gdkrectangle--union"></a><h3>gtk.gdk.Rectangle.union</h3><pre class="programlisting"><code class="methodsynopsis">    def <span class="methodname">union</span>(<span class="methodparam"><span class="parameter"><strong class="parameter"><code>src</code></strong></span></span>)</code></pre><table border="0" width="100%" bgcolor="#FFECCE"><col align="left" valign="top" width="0*"><tbody><tr><td><p><span class="term"><strong class="parameter"><code>src</code></strong> :</span></p></td><td>a <a class="link" href="class-gdkrectangle.html" title="gtk.gdk.Rectangle"><code class="classname">gtk.gdk.Rectangle</code></a>
39
39
of a 4-tuple specifying the attributes of a rectangle as (x, y, width,
40
40
height)</td></tr><tr><td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td><td>a <a class="link" href="class-gdkrectangle.html" title="gtk.gdk.Rectangle"><code class="classname">gtk.gdk.Rectangle</code></a>
41
41
that includes both <em class="parameter"><code>src</code></em> and the