<!--
* 
*
*  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_list">
  <refmeta>
    <refentrytitle>LIST Command</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>LIST</refname>
    <refpurpose>Build and manage multi column list boxes.</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>LIST</command>
      <arg choice='plain'><option>APPEND</option></arg>
      <arg choice='plain'><replaceable>store_name</replaceable></arg>
      <arg choice='plain'><option>VALUE</option></arg>
      <arg choice='plain'><replaceable>value</replaceable></arg>
      <arg rep='repeat' choice='opt'><replaceable>value</replaceable></arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>LIST</command>
      <arg choice='plain'><option>INSERT</option></arg>
      <arg choice='plain'><replaceable>store_name</replaceable></arg>
      <arg choice='plain'><option>VALUE</option></arg>
      <arg choice='plain'><replaceable>value</replaceable></arg>
      <arg choice='plain'><option>COLNO</option></arg>
      <arg choice='plain'><replaceable>col_num</replaceable></arg>
      <arg choice='opt'><option>ROWNO</option> <replaceable>row_num</replaceable></arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>LIST</command>
      <arg choice='plain'><option>GET</option></arg>
      <arg choice='plain'><replaceable>store_name</replaceable></arg>
      <arg choice='plain'><option>VALUE</option></arg>
      <arg choice='plain'><replaceable>ret_value</replaceable></arg>
      <arg choice='plain'><option>COLNO</option></arg>
      <arg choice='plain'><replaceable>col_num</replaceable></arg>
      <arg choice='opt'><option>ROWNO</option> <replaceable>row_num</replaceable></arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>LIST</command>
      <arg choice='plain'><option>ROW</option></arg>
      <arg choice='plain'><replaceable>store_name</replaceable></arg>
      <arg choice='opt'><option>ROWNO</option> <replaceable>row_num</replaceable></arg>
      <arg choice='plain'>
        <group choice='req'>
          <arg choice='plain'><option>UP</option></arg>
          <arg choice='plain'><option>DOWN</option></arg>
          <arg choice='plain'><option>TOP</option></arg>
          <arg choice='plain'><option>BOTTOM</option></arg>
          <arg choice='plain'><option>COPY</option></arg>
          <arg choice='plain'><option>DELETE</option></arg>
        </group>
      </arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>LIST</command>
      <arg choice='plain'><option>COLUMN</option></arg>
      <arg choice='plain'><replaceable>store_name</replaceable></arg>
      <arg choice='plain'>
        <group choice='req'>
          <arg choice='plain'><option>APPEND</option></arg>
          <arg choice='plain'><option>DELETE</option></arg>
        </group>
      </arg>
      <arg choice='opt'><replaceable>num_cols</replaceable></arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>LIST</command>
      <arg choice='plain'><option>COLUMN</option></arg>
      <arg choice='plain'><replaceable>store_name</replaceable></arg>
      <arg choice='plain'><option>COPY</option></arg>
      <arg choice='opt'><replaceable>col_num</replaceable></arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>LIST</command>
      <arg choice='plain'><option>COLUMN</option></arg>
      <arg choice='plain'><replaceable>store_name</replaceable></arg>
      <arg choice='plain'><option>COLNO</option></arg>
      <arg choice='plain'><replaceable>col_num</replaceable></arg>
      <arg choice='plain'>
        <group choice='req'>
          <arg choice='plain'><option>LEFT</option></arg>
          <arg choice='plain'><option>RIGHT</option></arg>
          <arg choice='plain'><option>FIRST</option></arg>
          <arg choice='plain'><option>LAST</option></arg>
        </group>
      </arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>LIST</command>
      <arg choice='plain'><option>GETHEADER</option></arg>
      <arg choice='plain'><replaceable>store_name</replaceable></arg>
      <arg choice='plain'><option>COLNO</option></arg>
      <arg choice='plain'><replaceable>col_num</replaceable></arg>
      <arg choice='opt'>
        <arg choice='plain'><option>LABEL</option></arg>
        <arg choice='plain'><replaceable>ret_value_1</replaceable></arg>
        <arg choice='plain'><option>TYPE</option></arg>
        <arg choice='plain'><replaceable>ret_value_2</replaceable></arg>
        <arg choice='plain'><option>SORT</option></arg>
        <arg choice='plain'><replaceable>ret_value_3</replaceable></arg>
      </arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>LIST</command>
      <arg choice='plain'><option>PUTHEADER</option></arg>
      <arg choice='plain'><replaceable>store_name</replaceable></arg>
      <arg choice='plain'><option>COLNO</option></arg>
      <arg choice='plain'><replaceable>col_num</replaceable></arg>
      <arg choice='opt'>
        <arg choice='plain'><option>LABEL</option></arg>
        <arg choice='plain'><replaceable>col_label</replaceable></arg>
        <arg choice='plain'><option>TYPE</option></arg>
        <arg choice='plain'>
          <group choice='req'>
            <arg choice='plain'><option>Text</option></arg>
            <arg choice='plain'><option>Number</option></arg>
          </group>
        </arg>
        <arg choice='plain'><option>SORT</option></arg>
        <arg choice='plain'>
          <group choice='req'>
            <arg choice='plain'><option>Ascending</option></arg>
            <arg choice='plain'><option>Descending</option></arg>
            <arg choice='plain'><option>None</option></arg>
          </group>
        </arg>
      </arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id="cmd_list_introduction">
    <title>Introduction</title>
    <para>
      The <link linkend="cmd_list">LIST</link> command builds and manages the 
      data store of multi column list boxes and can link a single data store 
      to multiple MCLB widget views on the screen. As soon as the data changes 
      in the data store, changes will be reflected on the screen.
    </para>
  </refsect1>
  <refsect1 id="cmd_list_arguments">
    <title>Arguments</title>
    <variablelist>
      <varlistentry>
	<term><replaceable>store_name</replaceable></term>
	<listitem>
	  <simpara>
            Any data reference as well as hard coded string holding the name 
            of a data store.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>value</replaceable></term>
	<listitem>
	  <simpara>
            Any data reference as well as a hard coded string or numeric value 
            to be placed into the data store.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>ret_value</replaceable></term>
	<listitem>
	  <simpara>
            Any data reference that can receive a value from a data store.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>num_cols</replaceable></term>
	<listitem>
	  <simpara>
            Any data reference as well as a numeric value holding the number 
            of columns.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>col_num</replaceable></term>
	<listitem>
	  <simpara>
            An existing column number.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>row_num</replaceable></term>
	<listitem>
	  <simpara>
            An existing row number.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>col_label</replaceable></term>
	<listitem>
	  <simpara>
            Any data reference as well as a hard coded string or numeric value 
            to be displayed as a column header.
	  </simpara>
	</listitem>
      </varlistentry>
    </variablelist>

  </refsect1>

  <refsect1 id="cmd_list_example">
    <title>Example</title>
<programlisting>
. . .
. . .
FOREACH dm1
	LET R-Cust = O-dm1
        STORE APPEND "s1" VALUE F-CustID.Cust F-Name.Cust F-Phone.Cust F-Fax.Cust
ENDFOR
. . .
. . .
</programlisting>
  </refsect1>

  <refsect1 id="cmd_list_related">
    <title>Related Commands</title>
    <para>
      <link linkend="cmd_clear">CLEAR</link>
    </para>
  </refsect1>

</refentry>

