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
|
<?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-atkrectangle">
<refnamediv>
<refname>atk.Rectangle</refname>
<refpurpose>an object holding data about a rectangle</refpurpose>
</refnamediv>
<refsect1>
<title>Synopsis</title>
<classsynopsis language="python">
<ooclass><classname>atk.Rectangle</classname></ooclass>
<ooclass><classname>gobject.GBoxed</classname></ooclass>
<constructorsynopsis language="python">
<methodname><link linkend="constructor-atkrectangle">atk.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>
</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>atk.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>
</refsect1>
<refsect1>
<title>Constructor</title>
<refsect2 id="constructor-atkrectangle">
<title>atk.Rectangle</title>
<programlisting><constructorsynopsis language="python">
<methodname>atk.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><emphasis>Returns</emphasis> :</term>
<listitem><simpara>a new <link
linkend="class-atkrectangle"><classname>atk.Rectangle</classname></link></simpara></listitem>
</varlistentry>
</variablelist>
<para>Creates a new <link
linkend="class-atkrectangle"><classname>atk.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>
</refsect2>
</refsect1>
</refentry>
|