<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) Jaime Urzua
 *
 * Copyright (C) 2012 - 2016 - Scilab Enterprises
 *
 * This file is hereby licensed under the terms of the GNU GPL v2.0,
 * pursuant to article 5.3.4 of the CeCILL v.2.1.
 * This file was originally licensed under the terms of the CeCILL v2.1,
 * and continues to be available under such terms.
 * For more information, see the COPYING file which you should have received
 * along with this program.
 *
 -->
<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>Syntax</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>
