← Back to branch summary

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

« back to all changes in this revision

Viewing changes to modules/graphics/help/en_US/interaction/dragrect.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:
modules/graphics/help/en_US/interaction/dragrect.xml
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="dragrect">
14
 
  <refnamediv>
15
 
    <refname>dragrect</refname>
16
 
    <refpurpose> Drag rectangle(s) with mouse</refpurpose>
17
 
  </refnamediv>
18
 
  <refsynopsisdiv>
19
 
    <title>Calling Sequence</title>
20
 
    <synopsis>[final_rect,btn]=dragrect(initial_rect)</synopsis>
21
 
  </refsynopsisdiv>
22
 
  <refsection>
23
 
    <title>Arguments</title>
24
 
    <variablelist>
25
 
      <varlistentry>
26
 
        <term>initial_rect</term>
27
 
        <listitem>
28
 
          <para>4 4xn matrix containing the initial rectangles definition. Each column contains [x_left; y_top; width; height]. If only one rectangle is present the initial_rect may also be a vector.</para>
29
 
        </listitem>
30
 
      </varlistentry>
31
 
      <varlistentry>
32
 
        <term>final_rect</term>
33
 
        <listitem>
34
 
          <para>a rectangle defined by [x_left, y_top, width, height]</para>
35
 
        </listitem>
36
 
      </varlistentry>
37
 
      <varlistentry>
38
 
        <term>btn</term>
39
 
        <listitem>
40
 
          <para>an integer, the number of the mouse button clicked</para>
41
 
        </listitem>
42
 
      </varlistentry>
43
 
    </variablelist>
44
 
  </refsection>
45
 
  <refsection>
46
 
    <title>Description</title>
47
 
    <para>
48
 
      <literal>dragrect</literal> drags one or more rectangles anywhere on the screen. The 4xn
49
 
      matrix rect defines the rectangles. Each column of <literal>initial_rect</literal>
50
 
      must contain the initial rectangle position as [left;top;width;height]
51
 
      values. When a button is clicked <literal>dragrect</literal> returns the final
52
 
      rectangles definition  in <literal>final_Rect</literal>.
53
 
    </para>
54
 
  </refsection>
55
 
  <refsection>
56
 
    <title>Examples</title>
57
 
    <programlisting role="example"><![CDATA[ 
 
14
    <refnamediv>
 
15
        <refname>dragrect</refname>
 
16
        <refpurpose> Drag rectangle(s) with mouse</refpurpose>
 
17
    </refnamediv>
 
18
    <refsynopsisdiv>
 
19
        <title>Calling Sequence</title>
 
20
        <synopsis>[final_rect,btn]=dragrect(initial_rect)</synopsis>
 
21
    </refsynopsisdiv>
 
22
    <refsection>
 
23
        <title>Arguments</title>
 
24
        <variablelist>
 
25
            <varlistentry>
 
26
                <term>initial_rect</term>
 
27
                <listitem>
 
28
                    <para>4 4xn matrix containing the initial rectangles definition. Each column contains [x_left; y_top; width; height]. If only one rectangle is present the initial_rect may also be a vector.</para>
 
29
                </listitem>
 
30
            </varlistentry>
 
31
            <varlistentry>
 
32
                <term>final_rect</term>
 
33
                <listitem>
 
34
                    <para>a rectangle defined by [x_left, y_top, width, height]</para>
 
35
                </listitem>
 
36
            </varlistentry>
 
37
            <varlistentry>
 
38
                <term>btn</term>
 
39
                <listitem>
 
40
                    <para>an integer, the number of the mouse button clicked</para>
 
41
                </listitem>
 
42
            </varlistentry>
 
43
        </variablelist>
 
44
    </refsection>
 
45
    <refsection>
 
46
        <title>Description</title>
 
47
        <para>
 
48
            <literal>dragrect</literal> drags one or more rectangles anywhere on the screen. The 4xn
 
49
            matrix rect defines the rectangles. Each column of <literal>initial_rect</literal>
 
50
            must contain the initial rectangle position as [left;top;width;height]
 
51
            values. When a button is clicked <literal>dragrect</literal> returns the final
 
52
            rectangles definition  in <literal>final_Rect</literal>.
 
53
        </para>
 
54
    </refsection>
 
55
    <refsection>
 
56
        <title>Examples</title>
 
57
        <programlisting role="example"><![CDATA[ 
58
58
xsetech(frect=[0,0,100,100])
59
59
r=dragrect([10;10;30;10])
60
60
xrect(r)
61
61
 ]]></programlisting>
62
 
  </refsection>
63
 
  <refsection role="see also">
64
 
    <title>See Also</title>
65
 
    <simplelist type="inline">
66
 
      <member>
67
 
        <link linkend="xrect">xrect</link>
68
 
      </member>
69
 
      <member>
70
 
        <link linkend="xrects">xrects</link>
71
 
      </member>
72
 
      <member>
73
 
        <link linkend="xclick">xclick</link>
74
 
      </member>
75
 
      <member>
76
 
        <link linkend="xgetmouse">xgetmouse</link>
77
 
      </member>
78
 
    </simplelist>
79
 
  </refsection>
 
62
    </refsection>
 
63
    <refsection role="see also">
 
64
        <title>See Also</title>
 
65
        <simplelist type="inline">
 
66
            <member>
 
67
                <link linkend="xrect">xrect</link>
 
68
            </member>
 
69
            <member>
 
70
                <link linkend="xrects">xrects</link>
 
71
            </member>
 
72
            <member>
 
73
                <link linkend="xclick">xclick</link>
 
74
            </member>
 
75
            <member>
 
76
                <link linkend="xgetmouse">xgetmouse</link>
 
77
            </member>
 
78
        </simplelist>
 
79
    </refsection>
80
80
</refentry>