blob: 9acb5fb253ca423d29fd8bef1d24b69d3d7d9798 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
|
<refentry id="checkbox">
<indexterm id="IndexCheckbox"><primary>checkbox</primary></indexterm>
<refentryinfo><title>Instrument Control:Sensing and Control</title></refentryinfo>
<refmeta>
<refentrytitle>checkbox</refentrytitle>
</refmeta>
<refnamediv>
<refname>checkbox</refname>
<refpurpose>
Sense on-screen controls.
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>
Sense on-screen controls. Requires Winsound or TCL/TK.
</para>
</refsect1>
<refsect1>
<title>Syntax</title>
<synopsis>kres <command>checkbox</command> knum</synopsis>
</refsect1>
<refsect1>
<title>Performance</title>
<para>
<emphasis>kres</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 file <ulink url="examples/checkbox.csd"><citetitle>checkbox.csd</citetitle></ulink>.
<example>
<title>Simple example of the checkbox opcode.</title>
<para>See the sections <link linkend="UsingRealTime"><citetitle>Real-time Audio</citetitle></link> and <link linkend="CommandFlags"><citetitle>Command Line Flags</citetitle></link> for more information on using command line flags.</para>
<xi:include href="examples-xml/checkbox.csd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/>
</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>
|
