<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://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="ja" xml:id="waitbar">
    <refnamediv>
        <refname>waitbar</refname>
        <refpurpose>waitbarを描画</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>呼び出し手順</title>
        <synopsis>winH=waitbar(x)
            winH=waitbar(x,mes)
            winH=waitbar(mes)
            waitbar(x,winH)
            waitbar(mes,winH)
            waitbar(x,mes,winH)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>引数</title>
        <variablelist>
            <varlistentry>
                <term>x</term>
                <listitem>
                    <para>実数, 表示する割合.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>mes</term>
                <listitem>
                    <para>文字列, 表示するメッセージ.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>winH</term>
                <listitem>
                    <para>waitbarのハンドル.</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>説明</title>
        <para>
            <literal>waitbar(x)</literal> は,
            割合xを表示するwaitbarを新規に作成し,
            このwaitbarのハンドルを返します.
        </para>
        <para>
            <literal>waitbar(x,mes)</literal> は
            割合xおよびメッセージmesを表示するwaitbarを新規に作成し,
            このwaitbarのハンドルを返します.
        </para>
        <para>
            <literal>waitbar(mes)</literal> は,
            割合0およびメッセージmesを表示するwaitbarを新規に作成し,
            このwaitbarのハンドルを返します.
        </para>
        <para>
            <literal>waitbar(x,winH)</literal>,
            <literal>waitbar(mes,winH)</literal> および
            <literal>waitbar(x,mes,winH)</literal> は,
            ハンドル<literal>winH</literal>を有するwaitbarを更新します.
        </para>
    </refsection>
    <refsection>
        <title>例</title>
        <programlisting role="example"><![CDATA[
winH=waitbar('This is an example');
realtimeinit(0.3);
for j=0:0.1:1,
  realtime(3*j);
  waitbar(j,winH);
end
close(winH);
 ]]></programlisting>
    </refsection>
</refentry>
