[doc] misc. patchs & small improvements
[scilab.git] / scilab / modules / gui / help / en_US / waitbar.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) Jaime Urzua
5  *
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <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="waitbar">
17     <refnamediv>
18         <refname>waitbar</refname>
19         <refpurpose>Draw a waitbar</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Syntax</title>
23         <synopsis>winH=waitbar(x)
24             winH=waitbar(x,mes)
25             winH=waitbar(mes)
26             waitbar(x,winH)
27             waitbar(mes,winH)
28             waitbar(x,mes,winH)
29         </synopsis>
30     </refsynopsisdiv>
31     <refsection>
32         <title>Arguments</title>
33         <variablelist>
34             <varlistentry>
35                 <term>x</term>
36                 <listitem>
37                     <para>real, fraction to display.</para>
38                 </listitem>
39             </varlistentry>
40             <varlistentry>
41                 <term>mes</term>
42                 <listitem>
43                     <para>string, message to display.</para>
44                 </listitem>
45             </varlistentry>
46             <varlistentry>
47                 <term>winH</term>
48                 <listitem>
49                     <para>Handle of the waitbar.</para>
50                 </listitem>
51             </varlistentry>
52         </variablelist>
53     </refsection>
54     <refsection>
55         <title>Description</title>
56         <para>
57             <literal>waitbar(x)</literal> create a new waitbar displaying a fraction x, return handle of the waitbar.
58         </para>
59         <para>
60             <literal>waitbar(x,mes)</literal> create a new waitbar displaying a fraction x and message mes, return handle of the waitbar.
61         </para>
62         <para>
63             <literal>waitbar(mes)</literal> create a new waitbar displaying a fraction 0 and message mes, return handle of the waitbar.
64         </para>
65         <para>
66             <literal>waitbar(x,mes)</literal> create a new waitbar displaying a fraction 0 and message mes, return handle of the waitbar.
67         </para>
68         <para>
69             <literal>waitbar(x,winH)</literal>, <literal>waitbar(mes,winH)</literal> and <literal>waitbar(x,mes,winH)</literal> update waitbar with handle <literal>winH</literal>.
70         </para>
71     </refsection>
72     <refsection>
73         <title>Examples</title>
74         <programlisting role="example"><![CDATA[
75 winH=waitbar('This is an example');
76 realtimeinit(0.3);
77 for j=0:0.1:1,
78   realtime(3*j);
79   waitbar(j,winH);
80 end
81 close(winH);
82  ]]></programlisting>
83     </refsection>
84     <refsection role="see also">
85         <title>See also</title>
86         <simplelist type="inline">
87             <member>
88                 <link linkend="progressionbar">progressionbar</link>
89             </member>
90         </simplelist>
91     </refsection>
92 </refentry>