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
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
|
<html>
<head>
<title>The mentry::mentry Command</title>
<meta name="Author" content="Csaba Nemethi">
<meta name="Keywords" content="mentry, widget, entry, label">
<link rel="stylesheet" type="text/css" href="stylesheet.css">
</head>
<body bgcolor="#FFFFFF">
<div align="center">
<h1>The <code><b>mentry::mentry</b></code> Command</h1>
<h2>For Mentry Version 3.8</h2>
<h3>by</h3>
<h2>Csaba Nemethi</h2>
<address>
<a href="mailto:csaba.nemethi@t-online.de">csaba.nemethi@t-online.de</a>
</address>
</div>
<hr>
<h2 id="contents">Contents</h2>
<ul>
<li><a href="#quick_ref">Quick Reference</a></li>
<li><a href="#detailed_ref">Detailed Reference</a></li>
</ul>
<div align="center">
<p><a href="index.html">Start page</a></p>
</div>
<hr>
<h2 id="quick_ref">Quick Reference</h2>
<dl>
<dt><a href="#name">NAME</a></dt>
<dd><code>mentry::mentry</code> – Create and manipulate multi-entry
widgets</dd>
<dt class="tm"><a href="#synopsis">SYNOPSIS</a></dt>
<dd>
<pre>
<b>mentry::mentry</b> <i>pathName</i> ?<i>options</i>?
</pre>
</dd>
<dt><a href="#std_options">STANDARD OPTIONS</a></dt>
<dd>
<pre>
<b>-borderwidth -highlightcolor -relief
-highlightbackground -highlightthickness</b>
</pre>
</dd>
<dt><a href="#child_options">OPTIONS FOR ALL ENTRY AND LABEL
CHILDREN</a></dt>
<dd>
<pre>
<b>-background -cursor -font -foreground</b>
</pre>
</dd>
<dt><a href="#entry_options">OPTIONS FOR ALL ENTRY CHILDREN</a></dt>
<dd>
<pre>
<b>-exportselection -insertwidth -selectforeground
-insertbackground -invalidcommand -show
-insertborderwidth -justify -state
-insertofftime -selectbackground -validate
-insertontime -selectborderwidth -validatecommand</b>
</pre>
</dd>
<dt><a href="#widget_options">WIDGET-SPECIFIC OPTIONS</a></dt>
<dd><code><b><a href="#body">-body</a></b> {<i>width</i> ?<i>text</i>
<i>width</i> <i>text</i> ...?}</code></dd>
<dd><code><b><a href="#disabledbackground">-disabledbackground</a></b>
<i>color</i></code></dd>
<dd><code><b><a href="#disabledforeground">-disabledforeground</a></b>
<i>color</i></code></dd>
<dd><code><b><a href="#readonlybackground">-readonlybackground</a></b>
<i>color</i></code></dd>
<dd><code><b><a href="#takefocus">-takefocus</a></b>
<b>0</b>|<b>1</b>|<b>""</b>|<i>command</i></code></dd>
<dd><code><b><a href="#textvariable">-textvariable</a></b>
<i>array</i></code></dd>
<dt class="tm"><a href="#indices">INDICES</a></dt>
<dd>
<pre>
<i>number</i> <b>end</b>
</pre>
</dd>
<dt><a href="#description">DESCRIPTION</a></dt>
<dt class="tm"><a href="#widget_command">WIDGET COMMAND</a></dt>
<dd><code><i>pathName</i> <b><a href="#adjustentry">adjustentry</a></b>
<i>index</i> <i>string</i></code></dd>
<dd><code><i>pathName</i> <b><a href="#attrib">attrib</a></b> ?<i>name</i>?
?<i>value</i> <i>name</i> <i>value</i> ...?</code></dd>
<dd><code><i>pathName</i> <b><a href="#cget">cget</a></b>
<i>option</i></code></dd>
<dd><code><i>pathName</i> <b><a href="#clear">clear</a></b> <i>first</i>
?<i>last</i>?</code></dd>
<dd><code><i>pathName</i> <b><a href="#configure">configure</a></b>
?<i>option</i>? ?<i>value</i> <i>option</i> <i>value</i> ...?</code></dd>
<dd><code><i>pathName</i> <b><a href="#entries">entries</a></b></code></dd>
<dd><code><i>pathName</i> <b><a href=
"#entrycount">entrycount</a></b></code></dd>
<dd><code><i>pathName</i> <b><a href="#entrylimit">entrylimit</a></b>
<i>index</i></code></dd>
<dd><code><i>pathName</i> <b><a href="#entrypath">entrypath</a></b>
<i>index</i></code></dd>
<dd><code><i>pathName</i> <b><a href="#getarray">getarray</a></b>
<i>array</i></code></dd>
<dd><code><i>pathName</i> <b><a href="#getlist">getlist</a></b></code></dd>
<dd><code><i>pathName</i> <b><a href=
"#getstring">getstring</a></b></code></dd>
<dd><code><i>pathName</i> <b><a href="#hasattrib">hasattrib</a></b>
<i>name</i></code></dd>
<dd><code><i>pathName</i> <b><a href="#isempty">isempty</a></b>
?<i>index</i>?</code></dd>
<dd><code><i>pathName</i> <b><a href="#isfull">isfull</a></b>
?<i>index</i>?</code></dd>
<dd><code><i>pathName</i> <b><a href=
"#labelcount">labelcount</a></b></code></dd>
<dd><code><i>pathName</i> <b><a href="#labelpath">labelpath</a></b>
<i>index</i></code></dd>
<dd><code><i>pathName</i> <b><a href="#labels">labels</a></b></code></dd>
<dd><code><i>pathName</i> <b><a href="#put">put</a></b> <i>startIndex</i>
?<i>string</i> <i>string</i> ...?</code></dd>
<dd><code><i>pathName</i> <b><a href=
"#setentryextrawidth">setentryextrawidth</a></b> <i>index</i>
<i>amount</i></code></dd>
<dd><code><i>pathName</i> <b><a href="#setentryfont">setentryfont</a></b>
<i>index</i> <i>font</i></code></dd>
<dd><code><i>pathName</i> <b><a href="#setentrywidth">setentrywidth</a></b>
<i>index</i> <i>width</i></code></dd>
<dd><code><i>pathName</i> <b><a href="#unsetattrib">unsetattrib</a></b>
<i>name</i></code></dd>
<dt class="tm"><a href="#bindings">DEFAULT BINDINGS</a></dt>
<dt class="tm"><a href="#keywords">KEYWORDS</a></dt>
<dd>mentry, widget, entry, label</dd>
</dl>
<div align="center">
<p><a href="#contents">Contents</a> <a href=
"index.html">Start page</a></p>
</div>
<hr>
<h2 id="detailed_ref">Detailed Reference</h2>
<dl>
<dt id="name"><b>NAME</b></dt>
<dd><code>mentry::mentry</code> – Create and manipulate multi-entry
widgets</dd>
<dt class="tm" id="synopsis"><b>SYNOPSIS</b></dt>
<dd>
<pre>
<b>mentry::mentry</b> <i>pathName</i> ?<i>options</i>?
</pre>
</dd>
<dt id="std_options"><b>STANDARD OPTIONS</b></dt>
<dd>
<pre>
<b>-borderwidth -highlightcolor -relief
-highlightbackground -highlightthickness</b>
</pre>
</dd>
<dd>See the <b>options</b> manual entry for details on the standard Tk
widget options. These options are only supported by the Mentry
package, but not by Mentry_tile.</dd>
<dt class="tm" id="child_options"><b>OPTIONS FOR ALL ENTRY AND LABEL
CHILDREN</b></dt>
<dd>
<pre>
<b>-background -cursor -font -foreground</b>
</pre>
</dd>
<dd>These options (described in the <b>options</b> manual entry) specify
the values of the options of the same names for all entry and label
children of the given multi-entry widget. These values may be changed
for an individual child by using the <code><b>configure</b></code>
subcommand of the Tcl command corresponding to that child. However,
applying this method to change the font of an entry child of a tile-based
mentry widget might break the latter's appearance (this has tile-related
technical reasons). To avoid this problem, it is recommended to use
the <code><b><a href="#setentryfont">setentryfont</a></b></code> subcommand
of the Tcl command associated with the mentry widget for changing the value
of the <code><b>-font</b></code> option of one of its entry children.</dd>
<dd class="tm">When using the package Mentry_tile, these options have
theme-specific default values. The common abbreviations
<code><b>-bg</b></code> (for <code><b>-background</b></code>) and
<code><b>-fg</b></code> (for <code><b>-foreground</b></code>) are supported
for both classical and tile-based mentry widgets.</dd>
<dd class="tm"><b>REMARK:</b> Please take into account that for some
themes (like <code><b>Arc</b></code>, <code><b>plastik</b></code>,
<code><b>tileqt</b></code>, <code><b>vista</b></code>, and
<code><b>xpnative</b></code>), the <code><b>-background</b></code> option
will be ignored for the entry children of a tile-based mentry widget.</dd>
<dt class="tm" id="entry_options"><b>OPTIONS FOR ALL ENTRY
CHILDREN</b></dt>
<dd>
<pre>
<b>-exportselection -insertwidth -selectforeground
-insertbackground -invalidcommand -show
-insertborderwidth -justify -state
-insertofftime -selectbackground -validate
-insertontime -selectborderwidth -validatecommand</b>
</pre>
</dd>
<dd>These options specify the values of the options of the same names for
all entry children of the given multi-entry widget. These values may
be changed for an individual entry child by using the
<code><b>configure</b></code> subcommand of the Tcl command corresponding
to that entry. The <code><b>-invalidcommand</b></code>,
<code><b>-validate</b></code>, and <code><b>-validatecommand</b></code>
options are only supported if Tk version 8.3 or higher is used, because the
options of the same names for entry widgets were introduced in Tk
8.3. The options <code><b>-insertbackground</b></code>,
<code><b>-insertborderwidth</b></code>, <code><b>-insertofftime</b></code>,
<code><b>-insertontime</b></code>, <code><b>-insertwidth</b></code>,
<code><b>-selectbackground</b></code>,
<code><b>-selectborderwidth</b></code>, and
<code><b>-selectforeground</b></code> are only supported by the Mentry
package, but not by Mentry_tile. The common abbreviations
<code><b>-invcmd</b></code> (for <code><b>-invalidcommand</b></code>) and
<code><b>-vcmd</b></code> (for <code><b>-validatecommand</b></code>) are
supported for both classical and tile-based mentry widgets.</dd>
<dt class="tm" id="widget_options"><b>WIDGET-SPECIFIC OPTIONS</b></dt>
<dd class="tm" id="body">
<table border="0" cellpadding="0" cellspacing="0">
<tr>
<td>Command-Line Name: </td>
<td><code><b>-body</b></code></td>
</tr>
<tr>
<td>Database Name:</td>
<td><code><b> body</b></code></td>
</tr>
<tr>
<td>Database Class:</td>
<td><code><b> Body</b></code></td>
</tr>
</table>
<blockquote>
<p>Specifies the initial widths of the entry children of the given
multi-entry widget, as well as the texts to be displayed in the labels
separating the entries. The value of this option is viewed as a
list. Each odd-numbered element is interpreted as the value of
the <code><b>-width</b></code> configuration option of an entry child,
while each even-numbered element represents the value of the
<code><b>-text</b></code> configuration option of a label child.
That is, each entry width must be followed by a label text, except for
the last one, for which a corresponding label text is optional.
The order of the list elements determines the creation order of the
child widgets; these will be packed in a row, without any horizontal
padding. The initial width of each entry child also determines
the number of characters that can be inserted into it; this maximal
length remains unchanged even if the entry's width is set to a new
value later on.</p>
<p>The width of an entry child and the text displayed in a label may be
changed by using the <code><b>configure</b></code> subcommand of the
Tcl command corresponding to that child. However, applying this
method to change the width of of an entry child of a tile-based mentry
widget might break the latter's appearance (this has tile-related
technical reasons). To avoid this problem, it is recommended to
use the <code><b><a href="#setentrywidth">setentrywidth</a></b></code>
subcommand of the Tcl command associated with the mentry widget for
changing the value of the <code><b>-width</b></code> option of one of
its entry children.</p>
</blockquote>
</dd>
<dd id="disabledbackground">
<table border="0" cellpadding="0" cellspacing="0">
<tr>
<td>Command-Line Name: </td>
<td><code><b>-disabledbackground</b></code></td>
</tr>
<tr>
<td>Database Name:</td>
<td><code><b> disabledBackground</b></code></td>
</tr>
<tr>
<td>Database Class:</td>
<td><code><b> DisabledBackground</b></code></td>
</tr>
</table>
<blockquote>
<p>This option, which is only supported for Tk versions 8.4 or higher,
specifies the background color to use for all entry and label children
of the given multi-entry widget when it is disabled. If the value
of this option is the empty string then the normal background color is
used. This option is only supported by the Mentry package, but
not by Mentry_tile.</p>
</blockquote>
</dd>
<dd id="disabledforeground">
<table border="0" cellpadding="0" cellspacing="0">
<tr>
<td>Command-Line Name: </td>
<td><code><b>-disabledforeground</b></code></td>
</tr>
<tr>
<td>Database Name:</td>
<td><code><b> disabledForeground</b></code></td>
</tr>
<tr>
<td>Database Class:</td>
<td><code><b> DisabledForeground</b></code></td>
</tr>
</table>
<blockquote>
<p>This option, which is only supported for Tk versions 8.4 or higher,
specifies the foreground color to use for all entry and label children
of the given multi-entry widget when it is disabled. If the value
of this option is the empty string then the normal foreground color is
used. This option is only supported by the Mentry package, but
not by Mentry_tile.</p>
</blockquote>
</dd>
<dd id="readonlybackground">
<table border="0" cellpadding="0" cellspacing="0">
<tr>
<td>Command-Line Name: </td>
<td><code><b>-readonlybackground</b></code></td>
</tr>
<tr>
<td>Database Name:</td>
<td><code><b> readonlyBackground</b></code></td>
</tr>
<tr>
<td>Database Class:</td>
<td><code><b> ReadonlyBackground</b></code></td>
</tr>
</table>
<blockquote>
<p>This option, which is only supported for Tk versions 8.4 or higher,
specifies the background color to use for all entry and label children
of the given multi-entry widget when it is readonly. If the value
of this option is the empty string then the normal background color is
used. This option is only supported by the Mentry package, but
not by Mentry_tile.</p>
</blockquote>
</dd>
<dd id="takefocus">
<table border="0" cellpadding="0" cellspacing="0">
<tr>
<td>Command-Line Name: </td>
<td><code><b>-takefocus</b></code></td>
</tr>
<tr>
<td>Database Name:</td>
<td><code><b> takeFocus</b></code></td>
</tr>
<tr>
<td>Database Class:</td>
<td><code><b> TakeFocus</b></code></td>
</tr>
</table>
<blockquote>
<p>This option determines whether the widget accepts the focus during
keyboard traversal. It is almost identical to the standard option
of the same name (see the <b>options</b> manual entry for
details). The only difference is that not the widget itself but
its first enabled entry child will receive the focus during keyboard
traversal with the standard keys (<code>Tab</code> and
<code>Shift-Tab</code>). See the <a href="#bindings">DEFAULT
BINDINGS</a> section below for information on how to move the focus
from one entry child to another using the keyboard.</p>
</blockquote>
</dd>
<dd id="textvariable">
<table border="0" cellpadding="0" cellspacing="0">
<tr>
<td>Command-Line Name: </td>
<td><code><b>-textvariable</b></code></td>
</tr>
<tr>
<td>Database Name:</td>
<td><code><b> textvariable</b></code></td>
</tr>
<tr>
<td>Database Class:</td>
<td><code><b> Variable</b></code></td>
</tr>
</table>
<blockquote>
<p>If the value of this option is not an empty string then it must be
an array. In this case, for each entry child of the given
multi-entry widget the value of the array element with the index of the
entry as element name specifies the value of the
<code><b>-textvariable</b></code> option for that entry. The
entry indices start with <code>0</code>. For example,
specifying <code>-textvariable arr</code> for a multi-entry
widget having two entry children is equivalent to specifying
<code>-textvariable arr(0)</code> for the first and
<code>-textvariable arr(1)</code> for the second entry child of
that widget.</p>
</blockquote>
</dd>
<dt id="description"><b>DESCRIPTION</b></dt>
<dd>The <code><b>mentry::mentry</b></code> command creates a new window
named <code><i>pathName</i></code> and of the class
<code><b>Mentry</b></code>, and makes it into a <b>mentry</b> widget.
Additional options, described above, may be specified on the command line
or in the option database to configure aspects of the mentry such as its
colors, font, and children. The <code><b>mentry::mentry</b></code>
command returns its <code><i>pathName</i></code> argument. At the
time this command is invoked, there must not exist a window named
<code><i>pathName</i></code>, but <code><i>pathName</i></code>'s parent
must exist.</dd>
<dd class="tm">The word <i>mentry</i> is an abbreviation of
<i>multi-entry</i>. A mentry is a mega-widget consisting of any
number of entries separated by labels, all embedded in a frame. Due
to appropriately chosen configuration options for the entries and labels, a
mentry widget looks like one single entry containing preinserted text
pieces that cannot be moved, changed, or deleted by the user.</dd>
<dd class="tm">As described above, the initial width of each entry child
(specified by the <code><b><a href="#body">-body</a></b></code>
configuration option) also determines the maximal number of characters that
can be inserted into it. This is achieved with the aid of the
<code><b><a href="wcbRef.html#callback">wcb::callback</a></b></code>
command, by registering the <code><b><a href=
"wcbRef.html#entrycb">wcb::checkEntryLen</a></b></code>
before-<code><b>insert</b></code> callback with the entry child. In
order to keep this callback, additional before-<code><b>insert</b></code>
callbacks (if needed) should only be registered with the <code><b><a href=
"wcbRef.html#cbappend">wcb::cbappend</a></b></code> and <code><b><a href=
"wcbRef.html#cbprepend">wcb::cbprepend</a></b></code> commands. When
reaching this limit in an entry having the input focus, the latter is set
automatically to the next enabled entry child, the contents of that widget
is selected, and the insertion cursor is set to its end. This is made
sure by defining an appropriate after-<code><b>insert</b></code> callback,
which must be kept to be the last such callback for the entry. For
this reason, additional after-<code><b>insert</b></code> callbacks (if
needed) should only be registered with the
<code><b>wcb::cbprepend</b></code> command. The same command should
be used exclusively to define after-<code><b>motion</b></code> callbacks
(if needed), because <code><b>mentry::mentry</b></code> registers one that
must be the last after-<code><b>motion</b></code> callback for each entry
child.</dd>
<dd class="tm">Each mentry widget may have any number of <b>attributes</b>,
which can be used in commands that create or manipulate mentry widgets for
particular purposes. For example, each date mentry created by the
<code><b><a href=
"mentryDateTime.html#dateMentry">mentry::dateMentry</a></b></code> command
has a <code><b>type</b></code> attribute having the value
<code>"Date"</code> and a <code><b>format</b></code> attribute specifying
the meanings of its components. The values of these attributes are
queried and used in the bodies of the procedures <code><b><a href=
"mentryDateTime.html#putClockVal">mentry::putClockVal</a></b></code> and
<code><b><a href=
"mentryDateTime.html#getClockVal">mentry::getClockVal</a></b></code>.</dd>
<dt class="tm" id="indices"><b>INDICES</b></dt>
<dd>Some of the widget commands for mentries take an index as
argument. An index specifies a particular entry or label child of the
mentry, in any of the following ways:</dd>
<dd class="tm">
<table border="0" cellpadding="6" cellspacing="0">
<tr valign="top">
<td><code><i>number </i></code></td>
<td>Specifies the child as a numerical index, where <code>0</code>
corresponds to the first entry or label child.</td>
</tr>
<tr valign="top">
<td><code><b>end</b></code></td>
<td>Indicates the last entry or label child of the mentry.</td>
</tr>
</table>
</dd>
<dd class="tm">The word <code><b>end</b></code> can be abbreviated as
<code><b>en</b></code> or <code><b>e</b></code>. Out-of-range indices
are automatically rounded to the nearest legal value.</dd>
<dt class="tm" id="widget_command"><b>WIDGET COMMAND</b></dt>
<dd>
The <code><b>mentry::mentry</b></code> command creates a new Tcl command
whose name is <code><i>pathName</i></code>. This command may be
used to invoke various operations on the widget. It has the
following general form:
<blockquote>
<pre>
<i>pathName</i> <i>option</i> ?<i>arg</i> <i>arg</i> ...?
</pre>
</blockquote>
</dd>
<dd><code><i>option</i></code> and the <code><i>arg</i></code>s determine
the exact behavior of the command. The following commands are
possible for mentry widgets:</dd>
<dd>
<dl>
<dt class="tm" id="adjustentry"><code><i>pathName</i>
<b>adjustentry</b> <i>index</i> <i>string</i></code></dt>
<dd>Increases the width in pixels of the entry child identified by
<code><i>index</i></code> if needed, to make it just large enough for
texts of the child-specific maximal length, consisting of characters
contained in the <code><i>string</i></code> argument. Returns an
empty string.</dd>
<dd class="tm">For example, when constructing a mentry widget whose
components will accept up to two uppercase hexadecimal digits only, by
passing the string <code>"0123456789ABCDEF"</code> to this subcommand
you can make sure that the entry children will have optimal widths,
just large enough to display not only the decimal digits, but also up
to two letters in the range <code>A</code> - <code>F</code> (which need
more room than the decimal digits when using a proportionally-spaced
font). It is recommended to invoke this subcommand even if the
allowed characters are restricted to the digits <code>0</code> -
<code>9</code> only, because in some fonts not all decimal digits have
the same width.</dd>
<dt class="tm" id="attrib"><code><i>pathName</i> <b>attrib</b>
?<i>name</i>? ?<i>value</i> <i>name</i> <i>value</i> ...?</code></dt>
<dd>Queries or modifies the attributes of the widget. If no
<code><i>name</i></code> is specified, the command returns a list of
pairs, each of which contains the name and the value of an attribute
for <code><i>pathName</i></code>. If <code><i>name</i></code> is
specified with no <code><i>value</i></code>, then the command returns
the value of the one named attribute, or an empty string if no
corresponding value exists (you can use the <code><b><a href=
"#hasattrib">hasattrib</a></b></code> subcommand to distinguish this
case from the one that the value of an <i>existing</i> attribute is an
empty string). If one or more
<code><i>name</i></code>-<code><i>value</i></code> pairs are specified,
then the command sets the given widget attribute(s) to the given
value(s); in this case the return value is an empty string.
<code><i>name</i></code> may be an arbitrary string.</dd>
<dt class="tm" id="cget"><code><i>pathName</i> <b>cget</b>
<i>option</i></code></dt>
<dd>Returns the current value of the configuration option given by
<code><i>option</i></code>, which may have any of the values accepted
by the <code><b>mentry::mentry</b></code> command.</dd>
<dt class="tm" id="clear"><code><i>pathName</i> <b>clear</b>
<i>first</i> ?<i>last</i>?</code></dt>
<dd>Erases the contents of one or more entry children of the
widget. <code><i>first</i></code> and <code><i>last</i></code>
are indices specifying the first and last entries in the range to
clear. If <code><i>last</i></code> is not specified then it
defaults to <code><i>first</i></code>, i.e., a single entry child is
cleared. The return value is an empty string.</dd>
<dt class="tm" id="configure"><code><i>pathName</i> <b>configure</b>
?<i>option</i>? ?<i>value</i> <i>option</i> <i>value</i>
...?</code></dt>
<dd>Queries or modifies the configuration options of the widget.
If no <code><i>option</i></code> is specified, the command returns a
list describing all of the available options for
<code><i>pathName</i></code> (see <code><b>Tk_ConfigureInfo</b></code>
for information on the format of this list). If
<code><i>option</i></code> is specified with no
<code><i>value</i></code>, 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 <code><i>option</i></code> is
specified). If one or more
<code><i>option</i></code>-<code><i>value</i></code> pairs are
specified, then the command modifies the given widget option(s) to have
the given value(s); in this case the return value is an empty
string. <code><i>option</i></code> may have any of the values
accepted by the <code><b>mentry::mentry</b></code> command.</dd>
<dt class="tm" id="entries"><code><i>pathName</i>
<b>entries</b></code></dt>
<dd>Returns a list containing the path names of all entry children of
the widget.</dd>
<dt class="tm" id="entrycount"><code><i>pathName</i>
<b>entrycount</b></code></dt>
<dd>Returns the number of all entry children of the widget.</dd>
<dt class="tm" id="entrylimit"><code><i>pathName</i> <b>entrylimit</b>
<i>index</i></code></dt>
<dd>Returns the number of characters that can be inserted into the
entry child identfied by <code><i>index</i></code>.</dd>
<dt class="tm" id="entrypath"><code><i>pathName</i> <b>entrypath</b>
<i>index</i></code></dt>
<dd>Returns the path name of the entry child identfied by
<code><i>index</i></code>.</dd>
<dt class="tm" id="getarray"><code><i>pathName</i> <b>getarray</b>
<i>array</i></code></dt>
<dd>For each entry child of the widget, the command assigns the string
contained in the entry to the element of <code><i>array</i></code>
having the index of the entry as element name. The entry indices
start with <code>0</code>. The return value is an empty
string.</dd>
<dt class="tm" id="getlist"><code><i>pathName</i>
<b>getlist</b></code></dt>
<dd>Returns a list containing the strings of all entry children of the
widget.</dd>
<dt class="tm" id="getstring"><code><i>pathName</i>
<b>getstring</b></code></dt>
<dd>Returns a string built by concatenating the strings contained in
the entry children of the widget with the texts displayed in the labels
separating the entries, in the creation order of the children, as given
by the <code><b><a href="#body">-body</a></b></code> configuration
option. That is, the string of the first entry child is followed
by the text of the first label, which in turn is followed by the string
of the second entry, and so on.</dd>
<dt class="tm" id="hasattrib"><code><i>pathName</i> <b>hasattrib</b>
<i>name</i></code></dt>
<dd>Returns <code>1</code> if the attribute <code><i>name</i></code>
exists and <code>0</code> otherwise.</dd>
<dt class="tm" id="isempty"><code><i>pathName</i> <b>isempty</b>
?<i>index</i>?</code></dt>
<dd>If <code><i>index</i></code> is specified then the command returns
the value <code>1</code> if the string contained in the entry child
identfied by <code><i>index</i></code> is empty and <code>0</code>
otherwise. If this optional argument is not present then the
command returns the value <code>1</code> if the strings contained in
the entry children of the widget are all empty and <code>0</code>
otherwise.</dd>
<dt class="tm" id="isfull"><code><i>pathName</i> <b>isfull</b>
?<i>index</i>?</code></dt>
<dd>If <code><i>index</i></code> is specified then the command returns
the value <code>1</code> if the length of the string contained in the
entry child identfied by <code><i>index</i></code> equals the number of
characters that can be inserted into the entry and <code>0</code>
otherwise. If this optional argument is not present then the
command returns the value <code>1</code> if the lengths of the strings
contained in the entry children of the widget all equal the numbers of
characters that can be inserted into the respective entries (i.e., if
all entry children are full) and <code>0</code> otherwise.</dd>
<dt class="tm" id="labelcount"><code><i>pathName</i>
<b>labelcount</b></code></dt>
<dd>Returns the number of all label children of the widget.</dd>
<dt class="tm" id="labelpath"><code><i>pathName</i> <b>labelpath</b>
<i>index</i></code></dt>
<dd>Returns the path name of the label child identfied by
<code><i>index</i></code>.</dd>
<dt class="tm" id="labels"><code><i>pathName</i>
<b>labels</b></code></dt>
<dd>Returns a list containing the path names of all label children of
the widget.</dd>
<dt class="tm" id="put"><code><i>pathName</i> <b>put</b>
<i>startIndex</i> ?<i>string</i> <i>string</i> ...?</code></dt>
<dd>Replaces the texts of the entry children whose indices are greater
than or equal to <code><i>startIndex</i></code> with the corresponding
<code><i>string</i></code> arguments by using the
<code><b>delete</b></code> and <code><b>insert</b></code> operations,
until either the entries or the <code><i>string</i></code>s are
consumed. If one of these subcommands gets canceled by some
before-callback in any entry child then the command restores the
original contents of all affected entries and returns the value
<code>0</code>, otherwise it returns <code>1</code>. In both
cases, the command keeps the position of the insertion cursor in all
entry children.</dd>
<dt class="tm" id="setentryextrawidth"><code><i>pathName</i>
<b>setentryextrawidth</b> <i>index</i> <i>amount</i></code></dt>
<dd>Specifies additonal width to provide for the entry child identified
by <code><i>index</i></code>. <code><i>amount</i></code> may have
any of the standard forms for screen distances (e.g., a number of
pixels). The return value is an empty string.</dd>
<dd class="tm">Notice that changing the width of an entry child has no
impact on the number of characters that can be inserted into it, which
remains set to the corresponding component of the value of the mentry's
<code><b><a href="#body">-body</a></b></code> option.</dd>
<dt class="tm" id="setentryfont"><code><i>pathName</i>
<b>setentryfont</b> <i>index</i> <i>font</i></code></dt>
<dd>Sets the font of the entry child identified by
<code><i>index</i></code> to the value given by
<code><i>font</i></code>. This is done by invoking the
<code><b>configure</b></code> subcommand of the Tcl command
corresponding to the entry. When using the package Mentry_tile,
this command also performs some additional steps necessary for updating
the appearance of the tile-based mentry widget. The return value
is an empty string.</dd>
<dt class="tm" id="setentrywidth"><code><i>pathName</i>
<b>setentrywidth</b> <i>index</i> <i>width</i></code></dt>
<dd>Sets the width of the entry child identified by
<code><i>index</i></code> to the number of characters given by
<code><i>width</i></code>. This is done by invoking the
<code><b>configure</b></code> subcommand of the Tcl command
corresponding to the entry. When using the package Mentry_tile,
this command also performs some additional steps necessary for updating
the appearance of the tile-based mentry widget. The return value
is an empty string.</dd>
<dd class="tm">Notice that changing the width of an entry child has no
impact on the number of characters that can be inserted into it, which
remains set to the corresponding component of the value of the mentry's
<code><b><a href="#body">-body</a></b></code> option.</dd>
<dt class="tm" id="unsetattrib"><code><i>pathName</i>
<b>unsetattrib</b> <i>name</i></code></dt>
<dd>Unsets the attribute <code><i>name</i></code>. Returns an
empty string.</dd>
</dl>
</dd>
<dt class="tm" id="bindings"><b>DEFAULT BINDINGS</b></dt>
<dd>The <code><b>mentry::mentry</b></code> command partially redefines the
bindings of the children of the mentry widget it creates:</dd>
<dd>
<ol>
<li class="tm">Clicking mouse button 1 in a label child positions the
insertion cursor to the end of the last enabled entry preceding the
label, sets the input focus to that entry, and clears any selection in
it.</li>
<li class="tm">If in a non-empty entry child a character is typed that
is contained in the label following that entry (if any), then the focus
is moved to the next enabled entry child, the contents of that entry
are selected, and the insertion cursor is set to its end.</li>
<li class="tm">At the beginning of an entry child that is not the first
enabled entry within the widget, the <code>Left</code> key clears the
selection in that entry, moves the focus to the previous enabled entry
child, and sets the insertion cursor to the end of that widget.
Similarly, at the end of an entry child that is not the last enabled
entry within the widget, the <code>Right</code> key clears the
selection in that entry, moves the focus to the next enabled entry
child, and sets the insertion cursor to the beginning of that
widget. If <code><b>tk_strictMotif</b></code> is false then
<code>Control-b</code> and <code>Control-f</code> behave the same as
<code>Left</code> and <code>Right</code>, respectively.</li>
<li class="tm">In an entry child that is not the first enabled entry
within the widget, <code>Control-Left</code> moves the focus to the
previous enabled entry child, selects the contents of that widget, and
sets the insertion cursor to its end; if there is no enabled entry
child to the left of the current one then <code>Control-Left</code>
moves the insertion cursor to the beginning of the current entry and
clears the selection in that widget. Similarly, in an entry child
that is not the last enabled entry within the widget,
<code>Control-Right</code> moves the focus to the next enabled entry
child, selects the contents of that widget, and sets the insertion
cursor to its end; if there is no enabled entry child to the right of
the current one then <code>Control-Right</code> moves the insertion
cursor to the end of the current entry and clears the selection in that
widget. If <code><b>tk_strictMotif</b></code> is false then
<code>Meta-b</code> and <code>Meta-f</code> behave the same as
<code>Control-Left</code> and <code>Control-Right</code>,
respectively.</li>
<li class="tm">The <code>Home</code> key clears the selection in the
current entry widget, moves the focus to the first enabled entry child,
and sets the insertion cursor to the beginning of that widget.
Similarly, the <code>End</code> key clears the selection in the current
entry widget, moves the focus to the last enabled entry child, and sets
the insertion cursor to the end of that widget. If
<code><b>tk_strictMotif</b></code> is false then <code>Control-a</code>
and <code>Control-e</code> behave the same as <code>Home</code> and
<code>End</code>, respectively.</li>
<li class="tm"><code>Shift-Home</code> moves the focus to the first
enabled entry child, sets the insertion cursor to the beginning of that
widget, and either extends the selection to that position, or clears
the selection in the current entry and selects the contents of the new
widget, depending upon whether the current entry is the first enabled
entry child or not. Similarly, <code>Shift-End</code> moves the
focus to the last enabled entry child, sets the insertion cursor to the
end of that widget, and either extends the selection to that position,
or clears the selection in the current entry and selects the contents
of the new widget, depending upon whether the current entry is the last
enabled entry child or not.</li>
<li class="tm">The <code>BackSpace</code> key deletes the selection if
there is one in the current entry. Otherwise, it deletes either
the character to the left of the insertion cursor in the current entry,
or the last character of the previous enabled entry child. The
latter takes place at the beginning of an entry child that is not the
first enabled entry within the widget; in this case, the
<code>BackSpace</code> key also moves the focus to the previous enabled
entry child and sets the insertion cursor to its end. If
<code><b>tk_strictMotif</b></code> is false then <code>Control-h</code>
behaves the same as <code>BackSpace</code>.</li>
<li class="tm">If <code><b>tk_strictMotif</b></code> is false then
<code>Meta-d</code> deletes all characters to the right of the
insertion cursor within the current entry, while
<code>Meta-BackSpace</code> and <code>Meta-Delete</code> delete either
all characters to the left of the insertion cursor in the current
entry, or the contents of the previous enabled entry child. The
latter takes place at the beginning of an entry child that is not the
first enabled entry within the widget; in this case,
<code>Meta-BackSpace</code> and <code>Meta-Delete</code> also clear the
selection in the current entry widget and move the focus to the
previous enabled entry child.</li>
</ol>
</dd>
<dt class="tm" id="keywords"><b>KEYWORDS</b></dt>
<dd>mentry, widget, entry, label</dd>
</dl>
<div align="center">
<p><a href="#contents">Contents</a> <a href=
"index.html">Start page</a></p>
</div>
</body>
</html>
|
