<!--
* 
*
*  ProLinga-Doc
*
*  Copyright (C) 2002-2008 Xobas Software.
*  All rights reserved.
*  
*  This file is part of ProLinga-Doc.
*
*  ProLinga-Doc is free software: you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation, either version 3 of the License, or
*  (at your option) any later version.
*
*  ProLinga-Doc is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  You should have received a copy of the GNU General Public License
*  along with ProLinga-Doc.  If not, see <http://www.gnu.org/licenses/>.
*
*  More information is available at the following addresses:
*
*  Website     : http://www.prolinga.org
*
*  Email       : prolinga-list@prolinga.org
*
*
-->
<refentry id="cmd_progress">
  <refmeta>
    <refentrytitle>PROGRESS Command</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>PROGRESS</refname>
    <refpurpose>Visual progress indicator.</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>PROGRESS</command>
      <arg choice='plain'><option>BOUNCE</option></arg>
      <arg choice='plain'><replaceable>progressbar_widget_name</replaceable></arg>
      <arg choice='plain'>
        <group choice='req'>
          <arg choice='plain'><option>STEP</option> <replaceable>step_ref</replaceable></arg>
          <arg choice='plain'><option>UPDATE</option></arg>
        </group>
      </arg>
    </cmdsynopsis>

    <cmdsynopsis>
      <command>PROGRESS</command>
      <arg choice='plain'><option>FRACTION</option></arg>
      <arg choice='plain'><replaceable>progressbar_widget_name</replaceable></arg>
      <arg choice='plain'><option>VALUE</option></arg>
      <arg choice='plain'><replaceable>fraction_ref</replaceable></arg>
    </cmdsynopsis>

    <cmdsynopsis>
      <command>PROGRESS</command>
      <arg choice='plain'><option>LABEL</option></arg>
      <arg choice='plain'><replaceable>progressbar_widget_name</replaceable></arg>
      <arg choice='plain'><option>VALUE</option></arg>
      <arg choice='plain'><replaceable>data_ref</replaceable></arg>
      <arg rep='repeat' choice='opt'><replaceable>data_ref</replaceable></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id="cmd_progress_introduction">
    <title>Introduction</title>
    <para>
      The <link linkend="cmd_progress">PROGRESS</link> command instructs the progress bar
      screen widget to provide a visual clue towards the user that some (long running)
      4GL logic is being executed. It can be used in a percentage (FRACTION) and an 
      activity (BOUNCE) mode. 
    </para>
  </refsect1>
  <refsect1 id="cmd_progress_arguments">
    <title>Arguments</title>
    <variablelist>
      <varlistentry>
	<term><replaceable>step_ref</replaceable></term>
	<listitem>
	  <simpara>
            Any data reference or numeric value between 0.00 and 1.00.
            Every time an UPDATE is triggered, the bouncing block in
            in the progress bar will move with this fraction.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>fraction_ref</replaceable></term>
	<listitem>
	  <simpara>
            Any data reference or numeric value between 0.00 and 1.00.
            Every time an FRACTION is triggered, the progress bar
            will fill this fraction of the bar.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>data_ref</replaceable></term>
	<listitem>
	  <simpara>
            Any single data reference, including hard coded strings and 
            numeric values to be displayed in the progress bar.
	  </simpara>
	</listitem>
      </varlistentry>
    </variablelist>

  </refsect1>

  <refsect1 id="cmd_progress_example">
    <title>Example</title>
<programlisting>
. . .
. . .
FOR L-Count = 1 TO 10
	LET L-Fraction = L-Count / 10.00
	PROGRESS FRACTION pb1 VALUE L-Fraction
	. . .
	. . .
ENDFOR
. . .
. . .
</programlisting>
  </refsect1>

  <refsect1 id="cmd_progress_related">
    <title>Related Commands</title>
    <para>
      None.
    </para>
  </refsect1>

</refentry>

