<?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>&nbsp;:</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>
