<!-- Converted to DocBook/SGML by Kevin Conder -->
<refentry id="flashtxt">
  <refmeta>
    <refentrytitle>flashtxt</refentrytitle>
  </refmeta>

  <refnamediv>
    <refname>flashtxt</refname>
    <refpurpose>
      Allows text to be displayed from instruments like sliders
      <indexterm id="IndexFlashtxt"><primary>flashtxt</primary></indexterm>
    </refpurpose>
  </refnamediv>
  
  <refsect1>
    <title>Description</title>
    <para>
      Allows text to be displayed from instruments like sliders etc. (only on Unix and Windows at present)
    </para>
  </refsect1>

  <refsect1>
    <title>Syntax</title>
    <synopsis><command>flashtxt</command>  iwhich, String</synopsis>
  </refsect1>

  <refsect1>
    <title>Initialization</title>
    <para>
      <emphasis>iwhich</emphasis> -- the number of the window.
    </para>

    <para>
      <emphasis>String</emphasis> -- the string to be displayed.
    </para>
  </refsect1>

  <refsect1>
    <title>Performance</title>
    <para>
      A window is created, identified by the iwhich argument, with the text string displayed.  If the text is replaced by a number then the window id deleted.  Note that the text windows are globally numbered so different instruments can change the text, and the window survives the instance of the instrument.
    </para>
  </refsect1>

  <refsect1>
    <title>Examples</title>
    <para>
      Here is an example of the flashtxt opcode. It uses the files <ulink url="examples/flashtxt.orc"><citetitle>flashtxt.orc</citetitle></ulink> and <ulink url="examples/flashtxt.sco"><citetitle>flashtxt.sco</citetitle></ulink>.

      <example>
        <title>Example of the flashtxt opcode.</title>

        <programlisting>
<inlinemediaobject>
            <imageobject>
              <imagedata fileref="examples/flashtxt.orc" format="linespecific">
            </imageobject>
          </inlinemediaobject>
        </programlisting>

        <programlisting>
<inlinemediaobject>
            <imageobject>
              <imagedata fileref="examples/flashtxt.sco" format="linespecific">
            </imageobject>
          </inlinemediaobject>
        </programlisting>
      </example>
    </para>
  </refsect1>
</refentry>
