summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2019-04-13 16:28:22 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2019-04-13 16:28:22 (GMT)
commitf5fe822ece89da837463d9d91d80569c42abaa51 (patch)
tree977f83783fc3b133112ff6c71c617066935bf959 /doc
parentd9b66e0da39dcadfc4595f6b23f589f9d9560a8b (diff)
parenta955dbaac96f1fbdba1e1b4b197703ac45a2e5f0 (diff)
downloadtk-f5fe822ece89da837463d9d91d80569c42abaa51.zip
tk-f5fe822ece89da837463d9d91d80569c42abaa51.tar.gz
tk-f5fe822ece89da837463d9d91d80569c42abaa51.tar.bz2
Doc tweak for frames and toplevels
Diffstat (limited to 'doc')
-rw-r--r--doc/frame.n4
-rw-r--r--doc/toplevel.n12
2 files changed, 13 insertions, 3 deletions
diff --git a/doc/frame.n b/doc/frame.n
index 6aa412e..9c34d03 100644
--- a/doc/frame.n
+++ b/doc/frame.n
@@ -99,21 +99,25 @@ The \fBframe\fR command creates a new Tcl command whose
name is the same as the path name of the frame's window. This
command may be used to invoke various
operations on the widget. It has the following general form:
+.PP
.CS
\fIpathName option \fR?\fIarg arg ...\fR?
.CE
+.PP
\fIPathName\fR is the name of the command, which is the same as
the frame widget's path name. \fIOption\fR and the \fIarg\fRs
determine the exact behavior of the command. The following
commands are possible for frame widgets:
.TP
\fIpathName \fBcget\fR \fIoption\fR
+.
Returns the current value of the configuration option given
by \fIoption\fR.
\fIOption\fR may have any of the values accepted by the \fBframe\fR
command.
.TP
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
+.
Query or modify the configuration options of the widget.
If no \fIoption\fR is specified, returns a list describing all of
the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
diff --git a/doc/toplevel.n b/doc/toplevel.n
index 31f241c..04fadc4 100644
--- a/doc/toplevel.n
+++ b/doc/toplevel.n
@@ -104,9 +104,9 @@ to configure aspects of the toplevel such as its background color
and relief. The \fBtoplevel\fR command returns the
path name of the new window.
.PP
-A toplevel is similar to a frame except that it is created as a
+A toplevel is similar to a \fBframe\fR except that it is created as a
top-level window: its X parent is the root window of a screen
-rather than the logical parent from its path name. The primary
+rather than the logical parent from its Tk path name. The primary
purpose of a toplevel is to serve as a container for dialog boxes
and other collections of widgets. The only visible features
of a toplevel are its background color and an optional 3-D border
@@ -117,21 +117,25 @@ The \fBtoplevel\fR command creates a new Tcl command whose
name is the same as the path name of the toplevel's window. This
command may be used to invoke various
operations on the widget. It has the following general form:
+.PP
.CS
\fIpathName option \fR?\fIarg arg ...\fR?
.CE
+.PP
\fIPathName\fR is the name of the command, which is the same as
the toplevel widget's path name. \fIOption\fR and the \fIarg\fRs
determine the exact behavior of the command. The following
commands are possible for toplevel widgets:
.TP
\fIpathName \fBcget \fIoption\fR
+.
Returns the current value of the configuration option given
by \fIoption\fR.
\fIOption\fR may have any of the values accepted by the \fBtoplevel\fR
command.
.TP
\fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
+.
Query or modify the configuration options of the widget.
If no \fIoption\fR is specified, returns a list describing all of
the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
@@ -148,8 +152,10 @@ command.
.PP
When a new toplevel is created, it has no default event bindings:
toplevels are not intended to be interactive.
+.PP
+Be aware that bindings on toplevels may receive events from subwidgets.
.SH "SEE ALSO"
-frame(n)
+bind(n), bindtags(n), frame(n), wm(n)
.SH KEYWORDS
toplevel, widget
'\" Local Variables: