Tk Source Code

Check-in [9cc89227]
Login
Bounty program for improvements to Tcl and certain Tcl packages.
Tcl 2019 Conference, Houston/TX, US, Nov 4-8
Send your abstracts to [email protected]
or submit via the online form by Sep 9.

Many hyperlinks are disabled.
Use anonymous login to enable hyperlinks.

Overview
Comment:A few corrections in manual.
Downloads: Tarball | ZIP archive | SQL archive
Timelines: family | ancestors | descendants | both | revised_text | tip-466
Files: files | file ages | folders
SHA3-256: 9cc8922760b0cc93038433c0cbacfe117a4974c07e1aeacb46ee08c184977b74
User & Date: gcramer 2018-11-12 11:28:23
Context
2018-11-15
14:11
Merge with trunk. check-in: 9524a8d9 user: culler tags: revised_text, tip-466
2018-11-12
11:28
A few corrections in manual. check-in: 9cc89227 user: gcramer tags: revised_text, tip-466
2018-11-04
13:43
Now -insertwidth will be honored, and the visibility of the cursor at very right side will be ensured. check-in: 8317b198 user: gcramer tags: revised_text, tip-466
Changes
Hide Diffs Unified Diffs Ignore Whitespace Patch

Changes to doc/text.n.

316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
...
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
....
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
....
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
....
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
when breaking lines at a space this space will be gobbled if option
\fB\-wrap\fR is set to \fBword\fR or \fBcodepoint\fR (this is the common
behavior of text editors). When setting to \fBexact\fR, no space character
will be gobbled at all, even when breaking lines. Mode \fBtrim\fR may be
used for trimming consecutive space characters, but a single space will
never be trimmed, instead it will be gobbled when a line break happens at
this space (if option \fB\-wrap\fR is set to \fBword\fR or \fBcodepoint\fR).
Normally the latter mode will not be used in conjunction with state
\fBnormal\fR (see option \fB\-state\fR).
.OP \-spacing1 spacing1 Spacing1
Requests additional space above each text line in the widget, using any of the
standard forms for screen distances. If a line wraps, this option only applies
to the first line on the display. This option may be overridden with
\fB\-spacing1\fR options in tags.
.OP \-spacing2 spacing2 Spacing2
................................................................................
This option cannot be set if the widget is not overall clean (see command
\fBisclean \-overall\fR), an error will be thrown if this is not satisified.
(It is not useful to switch this option, or setting this option, if the
widget is not overall clean, this may cause errors in the order of the
marks, therefore this is forbidden.)
.PP
This option is facilitating programmed editor control, because the shuffle
effect is eliminated, any every mark now has a defined order relative to other
marks, this order is not changing as long as the mark will not be moved with
\fBmark set\fR. Note that the handling of marks, especially the change of
the gravity, will be performed more efficiently when this option is
activated.
.RE
.OP \-synctime syncTime SyncTime
Specifies the timeout in milliseconds of the asynchronous line metrics
................................................................................
\fIscript\fR before evaluation. \fI%W\fR will be substituted by the name of
the parent text widget, and \fI%%\fR will be substituted by a single \fI%\fR.
If the annotation's window should ever be deleted, \fIscript\fR will be
evaluated again the next time the annotation is displayed.
.TP
\fB\-owner \fIboolean\fR
.
If true then the text widget is the owner of the embedded window. Only if it
is the owner the window will be destroyed if the range of text containing
the embedded window is deleted, and the deleted text is not saved on undo
stack. Per default this option is true. Setting this option to false should
be done with care, because in this case the text widget is not responsible
for the lifetime of the embedded window.
.TP
\fB\-padx \fIpixels\fR
.
\fIPixels\fR specifies the amount of extra space to leave on each side of the
embedded window. It may have any of the usual forms defined for a screen
distance.
.TP
................................................................................
\fIHyphen\fR        = "\fBhyphen\fR";
\fIEmbImage\fR      = "\fBimage\fR", \fIImageOptions\fR;
\fIEmbWindow\fR     = "\fBwindow\fR", \fIWindowOptions\fR;
\fIMark\fR          = \fIGravity\fR, \fIMarkName\fR;
\fIGravity\fR       = "\fBleft\fR" | "\fBright\fR";
\fIElide\fR         = "\fBelide\fR", ("\fBon\fR" | "\fBoff\fR");
\fITagInfo\fR       = (\fITags\fR, \fITags\fR?)?;
\fITags\fR          = BEG, \fITagName\fR* , END;
\fICharacter\fR     = ?Any character except newline?;
\fINewline\fR       = ?The newline character?;
\fITextOptions\fR   = ?See \fBSTANDARD OPTIONS\fR and \fBWIDGET-SPECIFIC OPTIONS\fR?;
\fITagOptions\fR    = ?See \fBTAGS\fR?;
\fIImageOptions\fR  = ?See \fBEMBEDDED IMAGES\fR?;
\fIWindowOptions\fR = ?See \fBEMBEDDED WINDOWS\fR?;
\fIPathName\fR      = ?Any valid widget pathname?;
................................................................................
lines and does not show an insertion cursor) cannot be modified.
.IP \(bu 3
\fBtk::text: Command "edit canredo" is deprecated, please use "edit info".\fR
.PP
Replace all occurrences
.QW "\fB[$w edit canredo]\fR"
with
.QW "\fB[set [$w edit info](redodepth)]\fR" .
.IP \(bu 3
\fBtk::text: Command "edit canundo" is deprecated, please use "edit info".\fR
.PP
Replace all occurrences
.QW "\fB[$w edit canundo]\fR"
with
.QW "\fB[set [$w edit info](undodepth)]\fR" .
.IP \(bu 3
\fBtk::text: "begin" is a reserved index identifier and shouldn't be used for mark names anymore.\fR
.PP
Replace this mark name with a different mark name,
but do this at all places where \fBbegin\fR is used as a name for a mark.
.IP \(bu 3
\fBtk::text: Tag option "-overstrikefg" is deprecated, please use option "-overstrikecolor".\fR






|







 







|







 







|
|

|
|
|







 







|







 







|






|







316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
...
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
....
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
....
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
....
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
when breaking lines at a space this space will be gobbled if option
\fB\-wrap\fR is set to \fBword\fR or \fBcodepoint\fR (this is the common
behavior of text editors). When setting to \fBexact\fR, no space character
will be gobbled at all, even when breaking lines. Mode \fBtrim\fR may be
used for trimming consecutive space characters, but a single space will
never be trimmed, instead it will be gobbled when a line break happens at
this space (if option \fB\-wrap\fR is set to \fBword\fR or \fBcodepoint\fR).
Normally mode \fBtrim\fR will not be used in conjunction with state
\fBnormal\fR (see option \fB\-state\fR).
.OP \-spacing1 spacing1 Spacing1
Requests additional space above each text line in the widget, using any of the
standard forms for screen distances. If a line wraps, this option only applies
to the first line on the display. This option may be overridden with
\fB\-spacing1\fR options in tags.
.OP \-spacing2 spacing2 Spacing2
................................................................................
This option cannot be set if the widget is not overall clean (see command
\fBisclean \-overall\fR), an error will be thrown if this is not satisified.
(It is not useful to switch this option, or setting this option, if the
widget is not overall clean, this may cause errors in the order of the
marks, therefore this is forbidden.)
.PP
This option is facilitating programmed editor control, because the shuffle
effect is eliminated, every mark now has a defined order relative to other
marks, this order is not changing as long as the mark will not be moved with
\fBmark set\fR. Note that the handling of marks, especially the change of
the gravity, will be performed more efficiently when this option is
activated.
.RE
.OP \-synctime syncTime SyncTime
Specifies the timeout in milliseconds of the asynchronous line metrics
................................................................................
\fIscript\fR before evaluation. \fI%W\fR will be substituted by the name of
the parent text widget, and \fI%%\fR will be substituted by a single \fI%\fR.
If the annotation's window should ever be deleted, \fIscript\fR will be
evaluated again the next time the annotation is displayed.
.TP
\fB\-owner \fIboolean\fR
.
If \fItrue\fR then the text widget is the owner of the embedded window. Only
if it is the owner the window will be destroyed if the range of text containing
the embedded window is deleted, and the deleted text is not saved on undo
stack. Per default this option is \fItrue\fR. Setting this option to
\fIfalse\fR should be done with care, because in this case the text widget
is not responsible for the lifetime of the embedded window.
.TP
\fB\-padx \fIpixels\fR
.
\fIPixels\fR specifies the amount of extra space to leave on each side of the
embedded window. It may have any of the usual forms defined for a screen
distance.
.TP
................................................................................
\fIHyphen\fR        = "\fBhyphen\fR";
\fIEmbImage\fR      = "\fBimage\fR", \fIImageOptions\fR;
\fIEmbWindow\fR     = "\fBwindow\fR", \fIWindowOptions\fR;
\fIMark\fR          = \fIGravity\fR, \fIMarkName\fR;
\fIGravity\fR       = "\fBleft\fR" | "\fBright\fR";
\fIElide\fR         = "\fBelide\fR", ("\fBon\fR" | "\fBoff\fR");
\fITagInfo\fR       = (\fITags\fR, \fITags\fR?)?;
\fITags\fR          = BEG, \fITagName\fR*, END;
\fICharacter\fR     = ?Any character except newline?;
\fINewline\fR       = ?The newline character?;
\fITextOptions\fR   = ?See \fBSTANDARD OPTIONS\fR and \fBWIDGET-SPECIFIC OPTIONS\fR?;
\fITagOptions\fR    = ?See \fBTAGS\fR?;
\fIImageOptions\fR  = ?See \fBEMBEDDED IMAGES\fR?;
\fIWindowOptions\fR = ?See \fBEMBEDDED WINDOWS\fR?;
\fIPathName\fR      = ?Any valid widget pathname?;
................................................................................
lines and does not show an insertion cursor) cannot be modified.
.IP \(bu 3
\fBtk::text: Command "edit canredo" is deprecated, please use "edit info".\fR
.PP
Replace all occurrences
.QW "\fB[$w edit canredo]\fR"
with
.QW "\fB[$w edit info -redodepth]\fR" .
.IP \(bu 3
\fBtk::text: Command "edit canundo" is deprecated, please use "edit info".\fR
.PP
Replace all occurrences
.QW "\fB[$w edit canundo]\fR"
with
.QW "\fB[$w edit info -undodepth]\fR" .
.IP \(bu 3
\fBtk::text: "begin" is a reserved index identifier and shouldn't be used for mark names anymore.\fR
.PP
Replace this mark name with a different mark name,
but do this at all places where \fBbegin\fR is used as a name for a mark.
.IP \(bu 3
\fBtk::text: Tag option "-overstrikefg" is deprecated, please use option "-overstrikecolor".\fR