File: checkbox.n.html

package info (click to toggle)
itcl3.0 3.0.1-6
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 10,128 kB
  • ctags: 3,519
  • sloc: tcl: 32,416; ansic: 12,683; sh: 3,917; makefile: 692; awk: 273; perl: 265
file content (230 lines) | stat: -rw-r--r-- 7,694 bytes parent folder | download | duplicates (8)
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
<!-- manual page source format generated by RosettaMan v2.5a6, -->
<!-- available via anonymous ftp from ftp.cs.berkeley.edu:/ucb/people/phelps/tcltk/rman.tar.Z -->
<HTML>
<HEAD>
<TITLE>man page(1) manual page</TITLE>
</HEAD>
<BODY>
<A HREF="#toc">Table of Contents</A><P>
_________________________________________________________________
<P>

<H2><A NAME="sect1" HREF="#toc1"><B>NAME</B></A></H2>

checkbox - Create and manipulate a checkbox widget
<P>

<H2><A NAME="sect2" HREF="#toc2"><B>SYNOPSIS</B></A></H2>

<B>checkbox</B> <I>pathName</I> ?<I>options</I>?
<P>

<H2><A NAME="sect3" HREF="#toc3"><B>INHERITANCE</B></A></H2>

itk::Widget &lt;- labeledframe &lt;- checkbox
<P>

<H2><A NAME="sect4" HREF="#toc4"><B>STANDARD</B> <B>OPTIONS</B></A></H2>

<B>background</B>      <B>borderWidth</B>    <B>cursor</B>          <B>disabledForeground</B>
<B>foreground</B>      <B>relief</B>         <B>selectColor</B>
<P>
See the &quot;options&quot; manual entry for details on the standard
options.
<P>

<H2><A NAME="sect5" HREF="#toc5"><B>INHERITED</B> <B>OPTIONS</B></A></H2>

<B>labelBitmap</B>     <B>labelFont</B>      <B>labelImage</B>      <B>labelMargin</B>
<DL>
<DT><B>labelPos</B> <DD>       <B>labelText</B>      <B>labelVariable</B>
<P>
</DD>
</DL>
See the &quot;labeledframe&quot; class manual entry for details on the
inherited options.
<P>

<H2><A NAME="sect6" HREF="#toc6"><B>WIDGET-SPECIFIC</B> <B>OPTIONS</B></A></H2>

Name: <B>command</B><BR>

Class: <B>Command</B><BR>

<DL>
<DT>Command-Line Switch: <DD>   <B>-command</B>
<P>
</DD>
</DL>
Specifies a Tcl command procedure to be evaluated following
a change in the current check box selection.
<P>
_________________________________________________________________
<P>

<H2><A NAME="sect7" HREF="#toc7"><B>DESCRIPTION</B></A></H2>

The <B>checkbox</B> command creates a check button box widget capable
of adding, inserting, deleting, selecting, and configuring
checkbuttons as well as obtaining the currently selected
button.
<P>

<H2><A NAME="sect8" HREF="#toc8"><B>METHODS</B></A></H2>

The <B>checkbox</B> command creates a new Tcl command whose name is
<I>pathName</I>. This command may be used to invoke various operations
on the widget. It has the following general form:
<P>
<I>pathName</I> <I>option</I> ?<I>arg</I> <I>arg</I> ...?
<P>
<I>Option</I> and the <I>arg</I>s determine the exact behavior of the command.
<P>
Many of the widget commands for the <B>checkbox</B> take as one
argument an indicator of which checkbutton of the checkbox
to operate on. These indicators are called <I>indexes</I> and
allow reference and manipulation of checkbuttons. Checkbox
indexes may be specified in any of the following forms:
<P>
<DL>
<DT><I>number</I> <DD>     Specifies the checkbutton numerically, where 0
corresponds to the top checkbutton of the checkbox.
<P>
</DD>
</DL>
<DL>
<DT><B>end</B> <DD>        Indicates the last checkbutton of the checkbox.
<P>
</DD>
</DL>
<DL>
<DT><I>pattern</I> <DD>    If the index doesn't satisfy one of the above
forms then this form is used. <I>Pattern</I> is
pattern-matched against the tag of each checkbutton
in the checkbox, in order from top to
bottom, until a matching entry is found. The
rules of <B>Tcl_StringMatch</B> are used.
<P>
</DD>
</DL>

<H2><A NAME="sect9" HREF="#toc9"><B>WIDGET-SPECIFIC</B> <B>METHODS</B></A></H2>

<I>pathName</I> <B>add</B> <I>tag</I> ?<I>option</I> <I>value</I> <I>option</I> <I>value</I>?
Adds a new checkbutton to the checkbuttond window on
the bottom. The command takes additional options which
are passed on to the checkbutton as construction arguments.
These include the standard Tk checkbutton
options. The tag is returned.
<P>
<I>pathName</I> <B>buttonconfigure</B> <I>index</I> ?<I>options</I>?<BR>

This command is similar to the <B>configure</B> command,
except that it applies to the options for an individual
checkbutton, whereas <B>configure</B>applies to the options
for the checkbox as a whole. <I>Options</I> may have any of
the values accepted by the <B>add</B> widget command. If
<I>options</I> are specified, options are modified as indicated
in the command and the command returns an empty
string. If no <I>options</I> are specified, returns a list
describing the current options for entry <I>index</I> (see
<B>Tk_ConfigureInfo</B> for information on the format of this
list).
<P>
<I>pathName</I> <B>cget</B> <I>option</I><BR>

Returns the current value of the configuration option
given by <I>option</I>. <I>Option</I> may have any of the values
accepted by the <B>checkbox</B> command.
<P>
<I>pathName</I> <B>configure</B> ?<I>option</I>? ?<I>value</I> <I>option</I> <I>value</I> ...?
Query or modify the configuration options of the
widget. If no <I>option</I> is specified, returns a list
describing all of the available options for <I>pathName</I>
(see <B>Tk_ConfigureInfo</B> for information on the format of
this list). If <I>option</I> is specified with no <I>value</I>, then
the command returns a list describing the one named
option (this list will be identical to the corresponding
sublist of the value returned if no <I>option</I> is
specified). If one or more <I>option</I> - <I>value</I> pairs are
specified, then the command modifies the given widget
option(s) to have the given value(s); in this case the
command returns an empty string. <I>Option</I> may have any
of the values accepted by the <B>checkbox</B> command.
<P>
<I>pathName</I> <B>delete</B> <I>index</I><BR>

Deletes a specified checkbutton given an <I>index</I>.
<P>
<I>pathName</I> <B>deselect</B> <I>index</I><BR>

Deselects a specified checkbutton given an <I>index</I>.
<P>
<I>pathName</I> <B>flash</B> <I>index</I><BR>

Flashes a specified checkbutton given an <I>index</I>.
<P>
<I>pathName</I> <B>get</B> ?<I>index</I>?<BR>

Returns the tags of the currently selected checkbuttons
or the selection status of specific checkbutton when
given an index.
<P>
<I>pathName</I> <B>index</B> <I>index</I><BR>

Returns the numerical index corresponding to index.
<P>
<I>pathName</I> <B>insert</B> <I>index</I> <I>tag</I> ?<I>option</I> <I>value</I> <I>option</I> <I>value</I> ...?
Same as the <B>add</B> command except that it inserts the new
checkbutton just before the one given by <I>index</I>, instead
of appending to the end of the checkbox. The <I>option</I>,
and <I>value</I> arguments have the same interpretation as for
the <B>add</B> widget command.
<P>
<I>pathName</I> <B>select</B> <I>index</I><BR>

Selects a specified checkbutton given an <I>index</I>.
<P>

<H2><A NAME="sect10" HREF="#toc10"><B>EXAMPLE</B></A></H2>

checkbox .cb -labeltext Styles<BR>

.cb add bold -text Bold<BR>

.cb add italic -text Italic<BR>

.cb add underline -text Underline<BR>

.cb select underline
<P>
pack .cb -padx 10 -pady 10 -fill both -expand yes
<P>

<H2><A NAME="sect11" HREF="#toc11"><B>AUTHOR</B></A></H2>

John A. Tucker
<P>

<H2><A NAME="sect12" HREF="#toc12"><B>KEYWORDS</B></A></H2>

checkbox, widget
<P>

<HR><P>
<A NAME="toc"><B>Table of Contents</B></A><P>
<UL>
<LI><A NAME="toc1" HREF="#sect1">NAME</A></LI>
<LI><A NAME="toc2" HREF="#sect2">SYNOPSIS</A></LI>
<LI><A NAME="toc3" HREF="#sect3">INHERITANCE</A></LI>
<LI><A NAME="toc4" HREF="#sect4">STANDARD OPTIONS</A></LI>
<LI><A NAME="toc5" HREF="#sect5">INHERITED OPTIONS</A></LI>
<LI><A NAME="toc6" HREF="#sect6">WIDGET-SPECIFIC OPTIONS</A></LI>
<LI><A NAME="toc7" HREF="#sect7">DESCRIPTION</A></LI>
<LI><A NAME="toc8" HREF="#sect8">METHODS</A></LI>
<LI><A NAME="toc9" HREF="#sect9">WIDGET-SPECIFIC METHODS</A></LI>
<LI><A NAME="toc10" HREF="#sect10">EXAMPLE</A></LI>
<LI><A NAME="toc11" HREF="#sect11">AUTHOR</A></LI>
<LI><A NAME="toc12" HREF="#sect12">KEYWORDS</A></LI>
</UL>
</BODY></HTML>