~ubuntu-branches/ubuntu/raring/scilab/raring-proposed

« back to all changes in this revision

Viewing changes to modules/graphics/help/en_US/geometric_shapes/xrect.xml

  • Committer: Package Import Robot
  • Author(s): Sylvestre Ledru
  • Date: 2012-08-30 14:42:38 UTC
  • mfrom: (1.4.7)
  • Revision ID: package-import@ubuntu.com-20120830144238-c1y2og7dbm7m9nig
Tags: 5.4.0-beta-3-1~exp1
* New upstream release
* Update the scirenderer dep
* Get ride of libjhdf5-java dependency

Show diffs side-by-side

added added

removed removed

Lines of Context:
11
11
 *
12
12
 -->
13
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" xmlns:scilab="http://www.scilab.org" version="5.0-subset Scilab" xml:lang="en" xml:id="xrect">
14
 
  <refnamediv>
15
 
    <refname>xrect</refname>
16
 
    <refpurpose> draw a rectangle</refpurpose>
17
 
  </refnamediv>
18
 
  <refsynopsisdiv>
19
 
    <title>Calling Sequence</title>
20
 
    <synopsis>xrect(x,y,w,h)
21
 
      xrect(rect) // with rect =[x,y,w,h]
22
 
    </synopsis>
23
 
  </refsynopsisdiv>
24
 
  <refsection>
25
 
    <title>Arguments</title>
26
 
    <variablelist>
27
 
      <varlistentry>
28
 
        <term>x,y,w,h</term>
29
 
        <listitem>
30
 
          <para>four real values defining the rectangle.</para>
31
 
        </listitem>
32
 
      </varlistentry>
33
 
    </variablelist>
34
 
  </refsection>
35
 
  <refsection>
36
 
    <title>Description</title>
37
 
    <para>
38
 
      <literal>xrect</literal> draws a rectangle defined by <literal>[x,y,w,h]</literal> 
39
 
      (upper-left point, width, height) in user coordinates.
40
 
    </para>
41
 
    <para>WARNING: please note that height is positive downwards.</para>
42
 
  </refsection>
43
 
  <refsection>
44
 
    <title>Sample</title>
45
 
    <scilab:image>
46
 
      plot2d(0,0,-1,"010"," ",[-2,-2,2,2])
47
 
      xset("color",5)
48
 
      xrect(-1,1,2,2)
49
 
    </scilab:image>
50
 
  </refsection>
51
 
  <refsection>
52
 
    <title>Examples</title>
53
 
    <programlisting role="example"><![CDATA[ 
 
14
    <refnamediv>
 
15
        <refname>xrect</refname>
 
16
        <refpurpose> draw a rectangle</refpurpose>
 
17
    </refnamediv>
 
18
    <refsynopsisdiv>
 
19
        <title>Calling Sequence</title>
 
20
        <synopsis>xrect(x,y,w,h)
 
21
            xrect(rect) // with rect =[x,y,w,h]
 
22
        </synopsis>
 
23
    </refsynopsisdiv>
 
24
    <refsection>
 
25
        <title>Arguments</title>
 
26
        <variablelist>
 
27
            <varlistentry>
 
28
                <term>x,y,w,h</term>
 
29
                <listitem>
 
30
                    <para>four real values defining the rectangle.</para>
 
31
                </listitem>
 
32
            </varlistentry>
 
33
        </variablelist>
 
34
    </refsection>
 
35
    <refsection>
 
36
        <title>Description</title>
 
37
        <para>
 
38
            <literal>xrect</literal> draws a rectangle defined by <literal>[x,y,w,h]</literal> 
 
39
            (upper-left point, width, height) in user coordinates.
 
40
        </para>
 
41
        <para>WARNING: please note that height is positive downwards.</para>
 
42
    </refsection>
 
43
    <refsection>
 
44
        <title>Sample</title>
 
45
        <scilab:image>
 
46
            plot2d(0,0,-1,"010"," ",[-2,-2,2,2])
 
47
            xset("color",5)
 
48
            xrect(-1,1,2,2)
 
49
        </scilab:image>
 
50
    </refsection>
 
51
    <refsection>
 
52
        <title>Examples</title>
 
53
        <programlisting role="example"><![CDATA[ 
54
54
plot2d(0,0,-1,"010"," ",[-2,-2,2,2])
55
55
xset("color",5)
56
56
xrect(-1,1,2,2)
57
57
 ]]></programlisting>
58
 
  </refsection>
59
 
  <refsection role="see also">
60
 
    <title>See Also</title>
61
 
    <simplelist type="inline">
62
 
      <member>
63
 
        <link linkend="xfrect">xfrect</link>
64
 
      </member>
65
 
      <member>
66
 
        <link linkend="xrects">xrects</link>
67
 
      </member>
68
 
    </simplelist>
69
 
  </refsection>
 
58
    </refsection>
 
59
    <refsection role="see also">
 
60
        <title>See Also</title>
 
61
        <simplelist type="inline">
 
62
            <member>
 
63
                <link linkend="xfrect">xfrect</link>
 
64
            </member>
 
65
            <member>
 
66
                <link linkend="xrects">xrects</link>
 
67
            </member>
 
68
        </simplelist>
 
69
    </refsection>
70
70
</refentry>