summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authordgp <dgp@users.sourceforge.net>2001-08-01 16:21:11 (GMT)
committerdgp <dgp@users.sourceforge.net>2001-08-01 16:21:11 (GMT)
commit98ea3cb2214b51432f38f6ea50c1c429397281cc (patch)
tree38846cbe94cc8aac068898282ced4624f130770e /doc
parent7e9aececf720b6f0e20157366f8e977ad2378ddd (diff)
downloadtk-98ea3cb2214b51432f38f6ea50c1c429397281cc.zip
tk-98ea3cb2214b51432f38f6ea50c1c429397281cc.tar.gz
tk-98ea3cb2214b51432f38f6ea50c1c429397281cc.tar.bz2
Merged changes from feature branch dgp-privates-into-namespace,
implementing TIP 44. All Tk commands and variables matching tk[A-Z]* are now in the ::tk namespace.
Diffstat (limited to 'doc')
-rw-r--r--doc/console.n6
-rw-r--r--doc/menu.n12
-rw-r--r--doc/text.n28
-rw-r--r--doc/tkvars.n16
4 files changed, 50 insertions, 12 deletions
diff --git a/doc/console.n b/doc/console.n
index e910f1e..7aabd6e 100644
--- a/doc/console.n
+++ b/doc/console.n
@@ -4,7 +4,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: console.n,v 1.1 2001/05/16 12:39:18 dkf Exp $
+'\" RCS: @(#) $Id: console.n,v 1.2 2001/08/01 16:21:11 dgp Exp $
'\"
.so man.macros
.TH console n 8.4 Tk "Tcl Built-In Commands"
@@ -78,14 +78,14 @@ the internal implementation of the console and are likely to change or
be modified without warning.\fR
.PP
Output to the console from the main interpreter via the stdout and
-stderr channels is handled by invoking the \fBtkConsoleOutput\fR
+stderr channels is handled by invoking the \fBtk::ConsoleOutput\fR
command in the console interpreter with two arguments. The first
argument is the name of the channel being written to, and the second
argument is the string being written to the channel (after encoding
and end-of-line translation processing has been performed.)
.PP
When the \fB.\fR window of the main interpreter is destroyed, the
-\fBtkConsoleExit\fR command in the console interpreter is called
+\fBtk::ConsoleExit\fR command in the console interpreter is called
(assuming the console interpreter has not already been deleted itself,
that is.)
diff --git a/doc/menu.n b/doc/menu.n
index b3be142..352dbc4 100644
--- a/doc/menu.n
+++ b/doc/menu.n
@@ -5,16 +5,18 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: menu.n,v 1.4 2000/08/25 06:58:32 ericm Exp $
+'\" RCS: @(#) $Id: menu.n,v 1.5 2001/08/01 16:21:11 dgp Exp $
'\"
.so man.macros
.TH menu n 4.1 Tk "Tk Built-In Commands"
.BS
'\" Note: do not modify the .SH NAME line immediately below!
.SH NAME
-menu \- Create and manipulate menu widgets
+menu, tk_menuSetFocus \- Create and manipulate menu widgets
.SH SYNOPSIS
+.nf
\fBmenu\fR \fIpathName \fR?\fIoptions\fR?
+\fBtk_menuSetFocus\fR \fIpathName\fR
.SO
\-activebackground \-borderwidth \-foreground
\-activeborderwidth \-cursor \-relief
@@ -752,6 +754,12 @@ next menubutton to the right is posted.
Disabled menu entries are non-responsive: they don't activate and
they ignore mouse button presses and releases.
.PP
+.VS 8.4
+Several of the bindings make use of the command \fBtk_menuSetFocus\fR.
+It saves the current focus and sets the focus to its \fIpathName\fR
+argument, which is a menu widget.
+.VE
+.PP
The behavior of menus can be changed by defining new bindings for
individual widgets or by redefining the class bindings.
diff --git a/doc/text.n b/doc/text.n
index f8d60dc..bd67d57 100644
--- a/doc/text.n
+++ b/doc/text.n
@@ -5,16 +5,22 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: text.n,v 1.8 2000/08/25 06:58:33 ericm Exp $
+'\" RCS: @(#) $Id: text.n,v 1.9 2001/08/01 16:21:11 dgp Exp $
'\"
.so man.macros
.TH text n 4.0 Tk "Tk Built-In Commands"
.BS
'\" Note: do not modify the .SH NAME line immediately below!
.SH NAME
-text \- Create and manipulate text widgets
+text, tk_textCopy, tk_textCut, tk_textPaste \- Create and manipulate text widgets
.SH SYNOPSIS
+.nf
\fBtext\fR \fIpathName \fR?\fIoptions\fR?
+.VS 8.4
+\fBtk_textCopy\fR \fIpathName\fR
+\fBtk_textCut\fR \fIpathName\fR
+\fBtk_textPaste\fR \fIpathName\fR
+.VE
.SO
\-background \-highlightthickness \-relief
\-borderwidth \-insertbackground \-selectbackground
@@ -772,6 +778,13 @@ There is a single debugging switch shared by all text widgets: turning
debugging on or off in any widget turns it on or off for all widgets.
For widgets with large amounts of text, the consistency checks may
cause a noticeable slow-down.
+.PP
+.VS 8.4
+When debugging is turned on, the drawing routines of the text widget
+set the global variables \fBtk_textRedraw\fR and \fBtk_textRelayout\fR
+to the lists of indices that are redrawn. The values of these variables
+are tested by Tk's test suite.
+.VE
.TP
\fIpathName \fBdelete \fIindex1 \fR?\fIindex2\fR?
Delete a range of characters from the text.
@@ -1554,15 +1567,24 @@ Control-\e clears any selection in the widget.
.IP [20]
The F16 key (labelled Copy on many Sun workstations) or Meta-w
copies the selection in the widget to the clipboard, if there is a selection.
+.VS 8.4
+This action is carried out by the command \fBtk_textCopy\fR.
+.VE
.IP [21]
The F20 key (labelled Cut on many Sun workstations) or Control-w
copies the selection in the widget to the clipboard and deletes
the selection.
+.VS 8.4
+This action is carried out by the command \fBtk_textCut\fR.
+.VE
If there is no selection in the widget then these keys have no effect.
.IP [22]
The F18 key (labelled Paste on many Sun workstations) or Control-y
inserts the contents of the clipboard at the position of the
insertion cursor.
+.VS 8.4
+This action is carried out by the command \fBtk_textPaste\fR.
+.VE
.IP [23]
The Delete key deletes the selection, if there is one in the widget.
If there is no selection, it deletes the character to the right of
@@ -1634,4 +1656,4 @@ The display line with the insert cursor is redrawn each time the
cursor blinks, which causes a steady stream of graphics traffic.
Set the \fBinsertOffTime\fP attribute to 0 avoid this.
.SH KEYWORDS
-text, widget
+text, widget, tkvars
diff --git a/doc/tkvars.n b/doc/tkvars.n
index f2e9a73..4c6451d 100644
--- a/doc/tkvars.n
+++ b/doc/tkvars.n
@@ -5,7 +5,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: tkvars.n,v 1.2 1998/09/14 18:23:00 stanton Exp $
+'\" RCS: @(#) $Id: tkvars.n,v 1.3 2001/08/01 16:21:11 dgp Exp $
'\"
.so man.macros
.TH tkvars n 4.1 Tk "Tk Built-In Commands"
@@ -44,9 +44,9 @@ Contains a decimal integer giving the current patch level for Tk.
The patch level is incremented for each new release or patch, and
it uniquely identifies an official version of Tk.
.TP
-\fBtkPriv\fR
+\fBtk::Priv\fR
This variable is an array containing several pieces of information
-that are private to Tk. The elements of \fBtkPriv\fR are used by
+that are private to Tk. The elements of \fBtk::Priv\fR are used by
Tk library procedures and default bindings.
They should not be accessed by any code outside Tk.
.TP
@@ -56,6 +56,14 @@ If an application sets it to one, then Tk attempts to adhere as
closely as possible to Motif look-and-feel standards.
For example, active elements such as buttons and scrollbar
sliders will not change color when the pointer passes over them.
+.TP
+\fBtk_textRedraw\fR
+.TP
+\fBtk_textRelayout\fR
+These variables are set by text widgets when they have debugging
+turned on. The values written to these variables can be used to
+test or debug text widget operations. These variables are mostly
+used by Tk's test suite.
.TP 15
\fBtk_version\fR
Tk sets this variable in the interpreter for each application.
@@ -69,4 +77,4 @@ each new release of Tk, except that it resets to zero whenever the
major version number changes.
.SH KEYWORDS
-variables, version
+variables, version, text