More samples in the graphic help pages Note that they are automatically generated...
[scilab.git] / scilab / modules / graphics / help / en_US / geometric_shapes / xrect.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) ENPC - Jean-Philippe Chancelier
5  * 
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at    
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
13 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" version="5.0-subset Scilab" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="xrect">
14   <info>
15     <pubdate>$LastChangedDate$</pubdate>
16   </info>
17   <refnamediv>
18     <refname>xrect</refname>
19     <refpurpose> draw a rectangle</refpurpose>
20   </refnamediv>
21   <refsynopsisdiv>
22     <title>Calling Sequence</title>
23     <synopsis>xrect(x,y,w,h)
24       xrect(rect) // with rect =[x,y,w,h]
25     </synopsis>
26   </refsynopsisdiv>
27   <refsection>
28     <title>Arguments</title>
29     <variablelist>
30       <varlistentry>
31         <term>x,y,w,h</term>
32         <listitem>
33           <para>four real values defining the rectangle.</para>
34         </listitem>
35       </varlistentry>
36     </variablelist>
37   </refsection>
38   <refsection>
39     <title>Description</title>
40     <para>
41       <literal>xrect</literal> draws a rectangle defined by <literal>[x,y,w,h]</literal> 
42       (upper-left point, width, height) in user coordinates.
43     </para>
44     <para>WARNING: please note that height is positive downwards.</para>
45   </refsection>
46   
47   <refsection>
48     <title>Sample</title>
49     <scilab:image>
50       plot2d(0,0,-1,"010"," ",[-2,-2,2,2])
51       xset("color",5)
52       xrect(-1,1,2,2)
53     </scilab:image>
54   </refsection>
55   
56   <refsection>
57     <title>Examples</title>
58     <programlisting role="example"><![CDATA[ 
59 plot2d(0,0,-1,"010"," ",[-2,-2,2,2])
60 xset("color",5)
61 xrect(-1,1,2,2)
62  ]]></programlisting>
63   </refsection>
64   <refsection role="see also">
65     <title>See Also</title>
66     <simplelist type="inline">
67       <member>
68         <link linkend="xfrect">xfrect</link>
69       </member>
70       <member>
71         <link linkend="xrects">xrects</link>
72       </member>
73     </simplelist>
74   </refsection>
75 </refentry>