<!--
* 
*
*  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="obj_picklist">
  <refmeta>
    <refentrytitle>PickList Object</refentrytitle>
    <manvolnum>1</manvolnum>
  </refmeta>

  <refnamediv>
    <refname>PickList</refname>
    <refpurpose>List of options.</refpurpose>
  </refnamediv>

  <refsect1 id="obj_picklist_introduction">
    <title>Introduction</title>
    <para>
      The pick list can hold data which can be displayed in combo boxes. The 
      user typically selects one of the values out of the list. The list can 
      be populated at development time as well by using logic commands at 
      runtime.
    </para>
  </refsect1>

  <refsect1 id="obj_picklist_properties">
    <title>Properties</title>

    <table frame='all' pgwide='1'>
      <title>PickList Object Properties</title>
      <tgroup cols='4' align='left' colsep='1' rowsep='1'>
        <thead>
          <row>
            <entry>Name</entry>
            <entry>Details</entry>
            <entry>Possible Values</entry>
            <entry>Default Value</entry>
          </row>
        </thead>
        <tbody>
          <row>
            <entry>Description</entry>
            <entry>Description to be used in lists.</entry>
            <entry>*</entry>
            <entry>-</entry>
          </row>
          <row>
            <entry>DetailDescription</entry>
            <entry>Detailed description.</entry>
            <entry>*</entry>
            <entry>-</entry>
          </row>
          <row>
            <entry>Modified</entry>
            <entry>Modification date-time stamp in ISO 8601 format.</entry>
            <entry><replaceable>ccyy-mm-dd</replaceable>T<replaceable>hh:mm:ss</replaceable></entry>
            <entry><replaceable>date stamp</replaceable></entry>
          </row>
          <row>
            <entry>OccurrencesPickListEntry</entry>
            <entry>

              <table frame='all' pgwide='1'>
                <title>Occurrences PickListEntry</title>
                <tgroup cols='4' align='left' colsep='1' rowsep='1'>
                  <thead>
                    <row>
                      <entry>Name</entry>
                      <entry>Details</entry>
                      <entry>Possible Values</entry>
                      <entry>Default Value</entry>
                    </row>
                  </thead>
                  <tbody>
                    <row>
                      <entry>Value</entry>
                      <entry>Value that can be selected by the user.</entry>
                      <entry>*</entry>
                      <entry>-</entry>
                    </row>
                  </tbody>
                </tgroup>
              </table>

            </entry>
            <entry></entry>
            <entry></entry>
          </row>
        </tbody>
      </tgroup>
    </table>

  </refsect1>

  <refsect1 id="obj_picklist_example">
    <title>Example</title>
<programlisting><![CDATA[
<Object Application="MyOrder" Type="PickList" name="Size">
  <PickList>
    <Description>Size</Description>
    <DetailDescription>Available sizes</DetailedDescription>
    <Modified>2007-11-12T09:58:00</Modified>
    <OccurencesPickListEntry>
      <PickListEntry>
        <Value>Small</Value>
      </PickListEntry>
      <PickListEntry>
        <Value>Medium</Value>
      </PickListEntry>
      <PickListEntry>
        <Value>Large</Value>
      </PickListEntry>
    </OccurencesPickList>
  </PickList>
</Object>
]]></programlisting>
  </refsect1>

</refentry>

