summaryrefslogtreecommitdiff
path: root/modules/gui/help/en_US/progressionbar.xml
blob: 1fed56a6fd4deacfa2e2b39485726a2386e5c6b0 (plain)
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
<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) Jaime Urzua
 * 
 * This file must be used under the terms of the CeCILL.
 * This source file is licensed as described in the file COPYING, which
 * you should have received as part of this distribution.  The terms
 * are also available at    
 * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
 *
 -->
<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" xml:lang="en" xml:id="progressionbar">
    <refnamediv>
        <refname>progressionbar</refname>
        <refpurpose>Draw a progression bar</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>winId=progressionbar(mes)
            progressionbar(winId[,mes])
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>mes</term>
                <listitem>
                    <para>string, message to display.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>winId</term>
                <listitem>
                    <para>integer greater than 0, window identificator.</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            <literal>progressionbar(mes)</literal> create a new progression bar, return window identificator.
        </para>
        <para>
            <literal>progressionbar(winId[,mes])</literal> update the progression bar identificated as winId.
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[ 
winId=progressionbar('Do something');
realtimeinit(0.3);
for j=0:0.1:1,
  realtime(3*j);
  progressionbar(winId);
end
close(winId);
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>See also</title>
        <simplelist type="inline">
            <member>
                <link linkend="waitbar">waitbar</link>
            </member>
        </simplelist>
    </refsection>
</refentry>