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

  <refnamediv>
    <refname>SCREEN</refname>
    <refpurpose>Display/close (container) screen or set title.</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>SCREEN</command>
      <arg choice='plain'><replaceable>screen_name</replaceable></arg>
      <arg choice='opt'>
        <arg choice='plain'><option>CONTAINER</option></arg>
        <arg choice='plain'><replaceable>container_name</replaceable></arg>
        <arg choice='plain'><option>SOURCE</option></arg>
        <arg choice='plain'><replaceable>source_screen_name</replaceable></arg>
      </arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>SCREEN</command>
      <arg choice='plain'><option>CLOSE</option></arg>
      <arg choice='opt'><replaceable>screen_name</replaceable></arg>
    </cmdsynopsis>
    <cmdsynopsis>
      <command>SCREEN</command>
      <arg choice='plain'><option>TITLE</option></arg>
      <arg choice='plain'><replaceable>screen_name</replaceable></arg>
      <arg choice='opt'>
        <arg choice='plain'><option>TARGET</option></arg>
        <arg choice='plain'><replaceable>screen_name</replaceable></arg>
      </arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1 id="cmd_screen_introduction">
    <title>Introduction</title>
    <para>
      The <link linkend="cmd_screen">SCREEN</link> command displays/closes a 
      screen, display a screen into a container or set the screen title.
    </para>
  </refsect1>

  <refsect1 id="cmd_screen_arguments">
    <title>Arguments</title>
    <variablelist>
      <varlistentry>
	<term><replaceable>screen_name</replaceable></term>
	<listitem>
	  <simpara>
            Any data reference as well as hard coded string as long as it 
            forms an exisiting screen name. When no screen name is given when 
            using CLOSE or TITLE, the current active screen will be referenced.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>container_name</replaceable></term>
	<listitem>
	  <simpara>
            Any data reference as well as hard coded string as long as it 
            forms an exisiting CONTAINER widget name, that can display the 
            screen.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>source_screen_name</replaceable></term>
	<listitem>
	  <simpara>
            Name of the screen widget which contents will be displayed 
            into the container the active screen.
	  </simpara>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><replaceable>screen_title</replaceable></term>
	<listitem>
	  <simpara>
            Any data reference or string which holds text. It will be displayed 
            on the title bar of the active screen.
	  </simpara>
	</listitem>
      </varlistentry>
    </variablelist>

  </refsect1>

  <refsect1 id="cmd_screen_example">
    <title>Example</title>
<programlisting>
. . .
. . .
SCREEN OrderForm
. . .
SCREEN OrderForm CONTAINER ContainerMain SOURCE OrderMain
. . .
SCREEN CLOSE
. . .
SCREEN TITLE "Place your Order."
. . .
. . .
</programlisting>
  </refsect1>

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

</refentry>

