<!-- Converted to DocBook/SGML by Kevin Conder -->
<refentry id="checkbox">
  <refmeta>
    <refentrytitle>checkbox</refentrytitle>
  </refmeta>
 
  <refnamediv>
    <refname>checkbox</refname>
 
    <refpurpose>
      Sense on-screen controls.
      <indexterm id="IndexCheckbox"><primary>checkbox</primary></indexterm>
    </refpurpose>
  </refnamediv>
 
  <refsect1>
    <title>Description</title>
    <para>
      Sense on-screen controls. Requires Winsound or TCL/TK.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Syntax</title>
    <synopsis>kr <command>checkbox</command> knum</synopsis>
  </refsect1>
 
  <refsect1>
    <title>Performance</title>
    <para>
      <emphasis>kr</emphasis> -- value of the checkbox control. If the checkbox is set (pushed) then return 1, if not, return 0.
    </para>

    <para>
      <emphasis>knum</emphasis> -- the number of the checkbox. If it does not exist, it is made on-screen at initialization.
    </para>
  </refsect1>
 
  <refsect1>
    <title>Examples</title>
    <para>
      Here is a simple example of the checkbox opcode. It uses the files <ulink url="examples/checkbox.orc"><citetitle>checkbox.orc</citetitle></ulink> and <ulink url="examples/checkbox.sco"><citetitle>checkbox.sco</citetitle></ulink>.

      <example>
        <title>Simple example of the checkbox opcode.</title>

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

        <programlisting>
<inlinemediaobject>
            <imageobject>
              <imagedata fileref="examples/checkbox.sco" format="linespecific">
            </imageobject>
          </inlinemediaobject>
        </programlisting>
      </example>
    </para>
  </refsect1>
 
  <refsect1>
    <title>See Also</title>
      <para>
        <link linkend="button"><citetitle>button</citetitle></link>
      </para>
  </refsect1>
 
  <refsect1>
    <title>Credits</title>
    <para>
      <simplelist>
        <member>Author: &namejohn;</member>
        <member>University of Bath, Codemist. Ltd.</member>
        <member>Bath, UK</member>
        <member>September, 2000</member>
      </simplelist>
    </para>
    <para>Example written by &namekevin;.</para>

    <para>New in Csound version 4.08</para>
  </refsect1>
</refentry>
