<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.swf-oncondition" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>swf_oncondition</refname>
  <refpurpose>Describe a transition used to trigger an action list</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>void</type><methodname>swf_oncondition</methodname>
   <methodparam><type>int</type><parameter>transition</parameter></methodparam>
  </methodsynopsis>
  <para>
   The <function>swf_oncondition</function> function describes a
   transition that will trigger an action list.  
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>transition</parameter></term>
     <listitem>
      <para>
       There are several types of possible transitions, the following are for
       buttons defined as TYPE_MENUBUTTON:
       <itemizedlist>
        <listitem>
         <simpara>
          IdletoOverUp
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          OverUptoIdle
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          OverUptoOverDown
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          OverDowntoOverUp
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          IdletoOverDown
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          OutDowntoIdle
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          MenuEnter (IdletoOverUp|IdletoOverDown)
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          MenuExit (OverUptoIdle|OverDowntoIdle)
         </simpara>
        </listitem>
       </itemizedlist>
       For TYPE_PUSHBUTTON there are the following options:
       <itemizedlist>
        <listitem>
         <simpara>
          IdletoOverUp
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          OverUptoIdle
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          OverUptoOverDown
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          OverDowntoOverUp
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          OverDowntoOutDown
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          OutDowntoOverDown
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          OutDowntoIdle
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          ButtonEnter (IdletoOverUp|OutDowntoOverDown)
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          ButtonExit  (OverUptoIdle|OverDowntoOutDown)
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.void;
  </para>
 </refsect1>
</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->