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

  <refnamediv>
    <refname>DISPLAY</refname>
    <refpurpose>Display the contents of a data reference in a linked screen widget or (re)sets the color.</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>DISPLAY</command>
      <arg choice='plain'><group choice='req'>
                            <arg choice='plain'><replaceable>widget_ref</replaceable></arg>
                            <arg choice='plain'><option>ALL</option></arg>
                          </group>
      </arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>DISPLAY</command>
      <arg choice='plain'><replaceable>widget_ref</replaceable></arg>

      <arg choice='plain'><group choice='req'>
                            <arg choice='plain'><option>BASECOLOR</option></arg>
                            <arg choice='plain'><option>BGCOLOR</option></arg>
                            <arg choice='plain'><option>FGCOLOR</option></arg>
                            <arg choice='plain'><option>TEXTCOLOR</option></arg>
                          </group>
      </arg>
      <arg choice='plain'><replaceable>color_ref</replaceable></arg>
      <arg choice='opt'>
        <arg choice='plain'><option>STATE</option></arg>
        <group choice='req'>
          <arg choice='plain'><option>Normal</option></arg>
          <arg choice='plain'><option>Active</option></arg>
          <arg choice='plain'><option>Prelight</option></arg>
          <arg choice='plain'><option>Selected</option></arg>
          <arg choice='plain'><option>Insensitive</option></arg>
        </group>
      </arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>DISPLAY</command>
      <arg choice='plain'><replaceable>widget_ref</replaceable></arg>
      <arg choice='plain'><option>RESETCOLOR</option></arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id="cmd_display_introduction">
    <title>Introduction</title>
    <para>
      The <link linkend="cmd_display">DISPLAY</link> command displays the 
      contents of a data reference in a linked screen widget on the active 
      screen or sets the color. When setting the color and no STATE is 
      defined, the default STATE "Normal" will be used.
    </para>
  </refsect1>
  <refsect1 id="cmd_display_arguments">
    <title>Arguments</title>
    <variablelist>
      <varlistentry>
	<term><replaceable>widget_ref</replaceable></term>
	<listitem>
	  <simpara>
            An existing widget name on the active screen.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>BASECOLOR</replaceable></term>
	<listitem>
	  <simpara>
            Sets the base (brush) color of the widget.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>FGCOLOR</replaceable></term>
	<listitem>
	  <simpara>
            Sets the forground color of the widget.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>BGCOLOR</replaceable></term>
	<listitem>
	  <simpara>
            Sets the background color of the widget.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>TEXTCOLOR</replaceable></term>
	<listitem>
	  <simpara>
            Sets the text color of the widget.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>RESETCOLOR</replaceable></term>
	<listitem>
	  <simpara>
            Resets the widget to the theme defaults.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>color_ref</replaceable></term>
	<listitem>
	  <simpara>
            name for a color from rgb.txt (as distributed with the 
            X Windows System), such as DarkSlateGray, or a 
            hex specification such as #FFFF00 which represents
            the color yellow for instance.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>STATE Normal</replaceable></term>
	<listitem>
	  <simpara>
            Set color for state during normal operation.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>STATE Active</replaceable></term>
	<listitem>
	  <simpara>
            Set color for state of a currently active widget, such as a depressed button.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>STATE Prelight</replaceable></term>
	<listitem>
	  <simpara>
            Set color for state indicating that the mouse pointer is over the widget and the 
            widget will respond to mouse clicks.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>STATE Selected</replaceable></term>
	<listitem>
	  <simpara>
            Set color for state of a selected item, such the selected row in a list.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>STATE Insensitive</replaceable></term>
	<listitem>
	  <simpara>
            Set color for state indicating that the widget is unresponsive to user actions.
	  </simpara>
	</listitem>
      </varlistentry>
    </variablelist>

  </refsect1>

  <refsect1 id="cmd_display_example">
    <title>Example</title>
<programlisting>
. . .
. . .
DISPLAY ord_total
. . .
. . .
DISPLAY ord_total BASECOLOR "red" STATE Normal
. . .
. . .
DISPLAY ord_total RESETCOLOR
. . .
. . .
</programlisting>
  </refsect1>

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

</refentry>

