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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
|
<!-- 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>
entryfield - Create and manipulate a entry field widget
<P>
<H2><A NAME="sect2" HREF="#toc2"><B>SYNOPSIS</B></A></H2>
<B>entryfield</B> <I>pathName</I> ?<I>options</I>?
<P>
<H2><A NAME="sect3" HREF="#toc3"><B>INHERITANCE</B></A></H2>
itk::Widget <- LabeledWidget <- entryfield
<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>exportSelection</B>
<DL>
<DT><B>foreground</B> <DD> <B>highlightColor</B> <B>highlightThicknessinsertBackground</B>
</DD>
</DL>
<DL>
<DT><B>insertBorderWidth</B> <DD> <B>insertOffTime</B> <B>insertOnTimeinsertWidth</B>
<B>justify</B> <B>relief</B> <B>selectBackgroundselectBorderWidth</B>
</DD>
</DL>
<DL>
<DT><B>selectForeground</B> <DD> <B>textVariable</B> <B>width</B>
<P>
</DD>
</DL>
See the "options" manual entry for details on the standard
options.
<P>
<H2><A NAME="sect5" HREF="#toc5"><B>ASSOCIATED</B> <B>OPTIONS</B></A></H2>
<DL>
<DT><B>show</B> <DD> <B>state</B>
<P>
</DD>
</DL>
See the "entry" manual entry for details on the associated
options.
<P>
<H2><A NAME="sect6" HREF="#toc6"><B>INHERITED</B> <B>OPTIONS</B></A></H2>
<DL>
<DT><B>disabledForeground</B> <DD> <B>labelBitmap</B> <B>labelFontlabelImage</B>
<B>labelMargin</B> <B>labelPos</B> <B>labelText</B> <B>labelVariable</B>
<B>state</B>
<P>
</DD>
</DL>
See the "labeledwidget" class manual entry for details on
the inherited options.
<P>
<H2><A NAME="sect7" HREF="#toc7"><B>WIDGET-SPECIFIC</B> <B>OPTIONS</B></A></H2>
<DL>
<DT>Name: <DD> <B>childSitePos</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Position</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-childsitepos</B>
<P>
</DD>
</DL>
Specifies the position of the child site in the entry
field: <B>n</B>, <B>s</B>, <B>e</B>, or <B>w</B>. The default is e.
<P>
<DL>
<DT>Name: <DD> <B>command</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Command</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-command</B>
<P>
</DD>
</DL>
Specifies a Tcl command to be executed upon detection
of a Return key press event.
<P>
<DL>
<DT>Name: <DD> <B>fixed</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Fixed</B>
<P>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-fixed</B>
<P>
</DD>
</DL>
Restrict entry to the specified number of chars. A
value of 0, which is the default, denotes no limit.
The value is the maximum number of chars the user may
type into the field, regardles of field width. For
example, if the field width is set to 20 and the fixed
value is 10, the user will only be able to type 10
characters into the field which is 20 characters long.
<P>
<DL>
<DT>Name: <DD> <B>focusCommand</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Command</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-focuscommand</B>
<P>
</DD>
</DL>
Specifies a Tcl command to be executed upon reception
of focus.
<P>
<DL>
<DT>Name: <DD> <B>invalid</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Command</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-invalid</B>
<P>
</DD>
</DL>
Specifies a Tcl command to be executed upon determination
of invalid input. The default is bell.
<P>
<DL>
<DT>Name: <DD> <B>textBackground</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Background</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-textbackground</B>
<P>
</DD>
</DL>
Background color for inside textual portion of the
entry field. The value may be given in any of the
forms acceptable to <B>Tk_GetColor</B>.
<P>
<DL>
<DT>Name: <DD> <B>textFont</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Font</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-textfont</B>
<P>
</DD>
</DL>
Name of font to use for display of text in entryfield.
The value may be given in any of the forms acceptable
to <B>Tk_GetFont</B>.
<P>
<DL>
<DT>Name: <DD> <B>validate</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Command</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-validate</B>
<P>
</DD>
</DL>
The validate option allows specification of a validation
mechanism. Standard character validation such as
<B>numeric</B>, <B>alphabetic</B>, <B>integer</B>, <B>hexidecimal</B>, <B>real</B>, and
<B>alphanumeric</B> can be handled through the use of keywords.
Should more extensive validation be necessary,
the value may contain the name of a command script.
The script should return a boolean value. True for
valid, false for invalid. If false is returned, then
the procedure associated with the invalid option will
be invoked. If the validation script contains any <B>%</B>
characters, then the script will not be executed
directly. Instead, a new script will be generated by
replacing each <B>%</B>, and the character following it, with
information from the entryfield. The replacement
depends on the character following the <B>%</B>, as defined in
the list below.
<P>
<DL>
<DT><B>%c</B> <DD>Replaced with the current input character.
<P>
</DD>
</DL>
<B>%P</B> Replaced with the contents of the entryfield modified
to include the latest keystoke. This is equivalent to
peeking at the future contents, enabling rejection
prior to the update.
<P>
<B>%S</B> Replaced with the current contents of the entryfield
prior to the latest keystroke being added.
<P>
<DL>
<DT><B>%W</B> <DD>Replaced with the entryfield widget pathname.
<P>
</DD>
</DL>
_________________________________________________________________
<P>
<H2><A NAME="sect8" HREF="#toc8"><B>DESCRIPTION</B></A></H2>
The <B>entryfield</B> command creates an enhanced text entry widget
with an optional associated label. Addtional options support
validation and establishing a upper limit on the number
of characters which may be entered in the field.
<P>
<H2><A NAME="sect9" HREF="#toc9"><B>METHODS</B></A></H2>
The <B>entryfield</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.
The following commands are possible for entryfield
widgets:
<P>
<H2><A NAME="sect10" HREF="#toc10"><B>ASSOCIATED</B> <B>METHODS</B></A></H2>
<B>delete</B> <B>get</B> <B>icursor</B> <B>index</B>
<B>insert</B> <B>scan</B> <B>selection</B> <B>xview</B>
<P>
See the "entry" manual entry for details on the associated
methods.
<P>
<H2><A NAME="sect11" HREF="#toc11"><B>WIDGET-SPECIFIC</B> <B>METHODS</B></A></H2>
<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>entryfield</B> command.
<P>
<I>pathName</I> <B>childsite</B><BR>
Returns the path name of the child site.
<P>
<I>pathName</I> <B>clear</B><BR>
Clear entry widget
<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>entryfield</B> command.
<P>
<H2><A NAME="sect12" HREF="#toc12"><B>COMPONENTS</B></A></H2>
<DL>
<DT>Name: <DD> <B>efchildsite</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>frame</B>
<P>
</DD>
</DL>
The efchildsite component is the user child site for
the entry field. See the "frame" widget manual entry
for details on the efchildsite component item.
<P>
<DL>
<DT>Name: <DD> <B>entry</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>entry</B>
<P>
</DD>
</DL>
The entry component provides the entry field for user
text input and display. See the "entry" widget manual
entry for details on the entry component item.
<P>
<H2><A NAME="sect13" HREF="#toc13"><B>EXAMPLE</B></A></H2>
option add *textBackground white
<P>
proc returnCmd {} {<BR>
puts stdout "Return Pressed"<BR>
}
<P>
proc invalidCmd {} {
<P>
puts stdout "Alphabetic contents invalid"
}
<P>
entryfield .ef -command returnCmd
<P>
entryfield .fef -labeltext "Fixed:" -fixed 10 -width 12
<P>
entryfield .nef -labeltext "Numeric:" -validate numeric -width 12
<P>
entryfield .aef -labeltext "Alphabetic:" \
-validate alphabetic -width 12 -invalid invalidCmd
<P>
entryfield .pef -labeltext "Password:" \
-show 267 -width 12 -command returnCmd
<P>
Labeledwidget::alignlabels .ef .fef .nef .aef .pef
<P>
pack .ef -fill x -expand yes -padx 10 -pady 5
pack .fef -fill x -expand yes -padx 10 -pady 5
pack .nef -fill x -expand yes -padx 10 -pady 5
pack .aef -fill x -expand yes -padx 10 -pady 5
pack .pef -fill x -expand yes -padx 10 -pady 5
<P>
<H2><A NAME="sect14" HREF="#toc14"><B>AUTHOR</B></A></H2>
Sue Yockey
<P>
Mark L. Ulferts
<P>
<H2><A NAME="sect15" HREF="#toc15"><B>KEYWORDS</B></A></H2>
entryfield, 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">ASSOCIATED OPTIONS</A></LI>
<LI><A NAME="toc6" HREF="#sect6">INHERITED OPTIONS</A></LI>
<LI><A NAME="toc7" HREF="#sect7">WIDGET-SPECIFIC OPTIONS</A></LI>
<LI><A NAME="toc8" HREF="#sect8">DESCRIPTION</A></LI>
<LI><A NAME="toc9" HREF="#sect9">METHODS</A></LI>
<LI><A NAME="toc10" HREF="#sect10">ASSOCIATED METHODS</A></LI>
<LI><A NAME="toc11" HREF="#sect11">WIDGET-SPECIFIC METHODS</A></LI>
<LI><A NAME="toc12" HREF="#sect12">COMPONENTS</A></LI>
<LI><A NAME="toc13" HREF="#sect13">EXAMPLE</A></LI>
<LI><A NAME="toc14" HREF="#sect14">AUTHOR</A></LI>
<LI><A NAME="toc15" HREF="#sect15">KEYWORDS</A></LI>
</UL>
</BODY></HTML>
|
