36 lines
2.0 KiB
HTML
36 lines
2.0 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
|
|
<html><head><title>PyGUI - class CheckBox</title>
|
|
|
|
<meta name="GENERATOR" content="Mozilla/3.01Gold (X11; I; SunOS 5.6 sun4u) [Netscape]"></head>
|
|
<body>
|
|
<h1>class <tt>CheckBox(<a href="Control.html">Control</a>)</tt></h1>
|
|
<p>A CheckBox is a control which has either two or three possible states. The possible states of a two-state check box are <i>on </i>and <i>off</i>; three-state check boxes may have an additional state <span style="font-style: italic;">mixed</span>.
|
|
Clicking the CheckBox changes it from one state to another. Each time
|
|
the state changes, its action is performed.</p><span style="font-style: italic;"></span><h2>Constructor</h2><dl style="margin-left: 40px;"><dt style="font-family: monospace;">CheckBox(title)</dt><dd>Constructs a CheckBox with the given title.</dd></dl>
|
|
<h2>Properties</h2>
|
|
<blockquote> <dl>
|
|
<dt><tt>title</tt></dt>
|
|
<dd>Title string to be displayed beside the check box.</dd>
|
|
<dd><br>
|
|
</dd>
|
|
<dt><span style="font-family: monospace;">value</span></dt>
|
|
<dd>The state of the check box. May have the values <span style="font-family: monospace;">True</span> or <span style="font-family: monospace;">False</span>, and in the case of a three-state check box, <span style="font-family: monospace;">'mixed'</span>.</dd>
|
|
<dd><br>
|
|
</dd>
|
|
<dt><tt>action</tt></dt>
|
|
<dd>Action to perform when the user changes the state of the check box.
|
|
See <a href="actions.html">Actions</a>.
|
|
</dd>
|
|
<dd><br>
|
|
</dd>
|
|
<dt><tt>auto_toggle</tt></dt>
|
|
<dd>True if the <tt>on</tt> property is to be automatically changed when
|
|
the user clicks the check box. Defaults to true. If set to false, the action
|
|
will still be performed when the check box is clicked, but the program
|
|
is responsible for changing the state.<br><br></dd><dt style="font-family: monospace;">mixed</dt><dd>If true, the check box can be in a mixed state. Defaults to false.</dd>
|
|
</dl>
|
|
</blockquote>
|
|
<p>---</p>
|
|
<br>
|
|
<br>
|
|
</body></html> |