| '\" |
| '\" Copyright (c) 1990-1994 The Regents of the University of California. |
| '\" Copyright (c) 1994-1996 Sun Microsystems, Inc. |
| '\" |
| '\" See the file "license.terms" for information on usage and redistribution |
| '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. |
| '\" |
| '\" RCS: @(#) $Id: toplevel.n,v 1.4 2001/09/26 21:36:19 pspjuth Exp $ |
| '\" |
| '\" The definitions below are for supplemental macros used in Tcl/Tk |
| '\" manual entries. |
| '\" |
| '\" .AP type name in/out ?indent? |
| '\" Start paragraph describing an argument to a library procedure. |
| '\" type is type of argument (int, etc.), in/out is either "in", "out", |
| '\" or "in/out" to describe whether procedure reads or modifies arg, |
| '\" and indent is equivalent to second arg of .IP (shouldn't ever be |
| '\" needed; use .AS below instead) |
| '\" |
| '\" .AS ?type? ?name? |
| '\" Give maximum sizes of arguments for setting tab stops. Type and |
| '\" name are examples of largest possible arguments that will be passed |
| '\" to .AP later. If args are omitted, default tab stops are used. |
| '\" |
| '\" .BS |
| '\" Start box enclosure. From here until next .BE, everything will be |
| '\" enclosed in one large box. |
| '\" |
| '\" .BE |
| '\" End of box enclosure. |
| '\" |
| '\" .CS |
| '\" Begin code excerpt. |
| '\" |
| '\" .CE |
| '\" End code excerpt. |
| '\" |
| '\" .VS ?version? ?br? |
| '\" Begin vertical sidebar, for use in marking newly-changed parts |
| '\" of man pages. The first argument is ignored and used for recording |
| '\" the version when the .VS was added, so that the sidebars can be |
| '\" found and removed when they reach a certain age. If another argument |
| '\" is present, then a line break is forced before starting the sidebar. |
| '\" |
| '\" .VE |
| '\" End of vertical sidebar. |
| '\" |
| '\" .DS |
| '\" Begin an indented unfilled display. |
| '\" |
| '\" .DE |
| '\" End of indented unfilled display. |
| '\" |
| '\" .SO |
| '\" Start of list of standard options for a Tk widget. The |
| '\" options follow on successive lines, in four columns separated |
| '\" by tabs. |
| '\" |
| '\" .SE |
| '\" End of list of standard options for a Tk widget. |
| '\" |
| '\" .OP cmdName dbName dbClass |
| '\" Start of description of a specific option. cmdName gives the |
| '\" option's name as specified in the class command, dbName gives |
| '\" the option's name in the option database, and dbClass gives |
| '\" the option's class in the option database. |
| '\" |
| '\" .UL arg1 arg2 |
| '\" Print arg1 underlined, then print arg2 normally. |
| '\" |
| '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $ |
| '\" |
| '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. |
| .if t .wh -1.3i ^B |
| .nr ^l \n(.l |
| .ad b |
| '\" # Start an argument description |
| .de AP |
| .ie !"\\$4"" .TP \\$4 |
| .el \{\ |
| . ie !"\\$2"" .TP \\n()Cu |
| . el .TP 15 |
| .\} |
| .ta \\n()Au \\n()Bu |
| .ie !"\\$3"" \{\ |
| \&\\$1 \\fI\\$2\\fP (\\$3) |
| .\".b |
| .\} |
| .el \{\ |
| .br |
| .ie !"\\$2"" \{\ |
| \&\\$1 \\fI\\$2\\fP |
| .\} |
| .el \{\ |
| \&\\fI\\$1\\fP |
| .\} |
| .\} |
| .. |
| '\" # define tabbing values for .AP |
| .de AS |
| .nr )A 10n |
| .if !"\\$1"" .nr )A \\w'\\$1'u+3n |
| .nr )B \\n()Au+15n |
| .\" |
| .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n |
| .nr )C \\n()Bu+\\w'(in/out)'u+2n |
| .. |
| .AS Tcl_Interp Tcl_CreateInterp in/out |
| '\" # BS - start boxed text |
| '\" # ^y = starting y location |
| '\" # ^b = 1 |
| .de BS |
| .br |
| .mk ^y |
| .nr ^b 1u |
| .if n .nf |
| .if n .ti 0 |
| .if n \l'\\n(.lu\(ul' |
| .if n .fi |
| .. |
| '\" # BE - end boxed text (draw box now) |
| .de BE |
| .nf |
| .ti 0 |
| .mk ^t |
| .ie n \l'\\n(^lu\(ul' |
| .el \{\ |
| .\" Draw four-sided box normally, but don't draw top of |
| .\" box if the box started on an earlier page. |
| .ie !\\n(^b-1 \{\ |
| \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' |
| .\} |
| .el \}\ |
| \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' |
| .\} |
| .\} |
| .fi |
| .br |
| .nr ^b 0 |
| .. |
| '\" # VS - start vertical sidebar |
| '\" # ^Y = starting y location |
| '\" # ^v = 1 (for troff; for nroff this doesn't matter) |
| .de VS |
| .if !"\\$2"" .br |
| .mk ^Y |
| .ie n 'mc \s12\(br\s0 |
| .el .nr ^v 1u |
| .. |
| '\" # VE - end of vertical sidebar |
| .de VE |
| .ie n 'mc |
| .el \{\ |
| .ev 2 |
| .nf |
| .ti 0 |
| .mk ^t |
| \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' |
| .sp -1 |
| .fi |
| .ev |
| .\} |
| .nr ^v 0 |
| .. |
| '\" # Special macro to handle page bottom: finish off current |
| '\" # box/sidebar if in box/sidebar mode, then invoked standard |
| '\" # page bottom macro. |
| .de ^B |
| .ev 2 |
| 'ti 0 |
| 'nf |
| .mk ^t |
| .if \\n(^b \{\ |
| .\" Draw three-sided box if this is the box's first page, |
| .\" draw two sides but no top otherwise. |
| .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c |
| .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c |
| .\} |
| .if \\n(^v \{\ |
| .nr ^x \\n(^tu+1v-\\n(^Yu |
| \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c |
| .\} |
| .bp |
| 'fi |
| .ev |
| .if \\n(^b \{\ |
| .mk ^y |
| .nr ^b 2 |
| .\} |
| .if \\n(^v \{\ |
| .mk ^Y |
| .\} |
| .. |
| '\" # DS - begin display |
| .de DS |
| .RS |
| .nf |
| .sp |
| .. |
| '\" # DE - end display |
| .de DE |
| .fi |
| .RE |
| .sp |
| .. |
| '\" # SO - start of list of standard options |
| .de SO |
| .SH "STANDARD OPTIONS" |
| .LP |
| .nf |
| .ta 5.5c 11c |
| .ft B |
| .. |
| '\" # SE - end of list of standard options |
| .de SE |
| .fi |
| .ft R |
| .LP |
| See the \\fBoptions\\fR manual entry for details on the standard options. |
| .. |
| '\" # OP - start of full description for a single option |
| .de OP |
| .LP |
| .nf |
| .ta 4c |
| Command-Line Name: \\fB\\$1\\fR |
| Database Name: \\fB\\$2\\fR |
| Database Class: \\fB\\$3\\fR |
| .fi |
| .IP |
| .. |
| '\" # CS - begin code excerpt |
| .de CS |
| .RS |
| .nf |
| .ta .25i .5i .75i 1i |
| .. |
| '\" # CE - end code excerpt |
| .de CE |
| .fi |
| .RE |
| .. |
| .de UL |
| \\$1\l'|0\(ul'\\$2 |
| .. |
| .TH toplevel n 8.4 Tk "Tk Built-In Commands" |
| .BS |
| '\" Note: do not modify the .SH NAME line immediately below! |
| .SH NAME |
| toplevel \- Create and manipulate toplevel widgets |
| .SH SYNOPSIS |
| \fBtoplevel\fR \fIpathName \fR?\fIoptions\fR? |
| .SO |
| \-borderwidth \-highlightcolor \-pady |
| \-cursor \-highlightthickness \-relief |
| \-highlightbackground \-padx \-takefocus |
| .SE |
| .SH "WIDGET-SPECIFIC OPTIONS" |
| .OP \-background background Background |
| This option is the same as the standard \fBbackground\fR option |
| except that its value may also be specified as an empty string. |
| In this case, the widget will display no background or border, and |
| no colors will be consumed from its colormap for its background |
| and border. |
| .OP \-class class Class |
| Specifies a class for the window. |
| This class will be used when querying the option database for |
| the window's other options, and it will also be used later for |
| other purposes such as bindings. |
| The \fBclass\fR option may not be changed with the \fBconfigure\fR |
| widget command. |
| .OP \-colormap colormap Colormap |
| Specifies a colormap to use for the window. |
| The value may be either \fBnew\fR, in which case a new colormap is |
| created for the window and its children, or the name of another |
| window (which must be on the same screen and have the same visual |
| as \fIpathName\fR), in which case the new window will use the colormap |
| from the specified window. |
| If the \fBcolormap\fR option is not specified, the new window |
| uses the default colormap of its screen. |
| This option may not be changed with the \fBconfigure\fR |
| widget command. |
| .OP \-container container Container |
| The value must be a boolean. If true, it means that this window will |
| be used as a container in which some other application will be embedded |
| (for example, a Tk toplevel can be embedded using the \fB\-use\fR option). |
| The window will support the appropriate window manager protocols for |
| things like geometry requests. The window should not have any |
| children of its own in this application. |
| This option may not be changed with the \fBconfigure\fR |
| widget command. |
| .OP \-height height Height |
| Specifies the desired height for the window in any of the forms |
| acceptable to \fBTk_GetPixels\fR. |
| If this option is less than or equal to zero then the window will |
| not request any size at all. |
| .OP \-menu menu Menu |
| Specifies a menu widget to be used as a menubar. On the Macintosh, the |
| menubar will be displayed accross the top of the main monitor. On |
| Microsoft Windows and all UNIX platforms, the menu will appear accross |
| the toplevel window as part of the window dressing maintained by the |
| window manager. |
| .OP \-screen "" "" |
| Specifies the screen on which to place the new window. |
| Any valid screen name may be used, even one associated with a |
| different display. |
| Defaults to the same screen as its parent. |
| This option is special in that it may not be specified via the option |
| database, and it may not be modified with the \fBconfigure\fR |
| widget command. |
| .OP \-use use Use |
| This option is used for embedding. If the value isn't an empty string, |
| it must be the the window identifier of a container window, specified as |
| a hexadecimal string like the ones returned by the \fBwinfo id\fR |
| command. The toplevel widget will be created as a child of the given |
| container instead of the root window for the screen. If the container |
| window is in a Tk application, it must be a frame or toplevel widget for |
| which the \fB\-container\fR option was specified. |
| This option may not be changed with the \fBconfigure\fR |
| widget command. |
| .OP \-visual visual Visual |
| Specifies visual information for the new window in any of the |
| forms accepted by \fBTk_GetVisual\fR. |
| If this option is not specified, the new window will use the default |
| visual for its screen. |
| The \fBvisual\fR option may not be modified with the \fBconfigure\fR |
| widget command. |
| .OP \-width width Width |
| Specifies the desired width for the window in any of the forms |
| acceptable to \fBTk_GetPixels\fR. |
| If this option is less than or equal to zero then the window will |
| not request any size at all. |
| .BE |
| |
| .SH DESCRIPTION |
| .PP |
| The \fBtoplevel\fR command creates a new toplevel widget (given |
| by the \fIpathName\fR argument). Additional |
| options, described above, may be specified on the command line |
| or in the option database |
| 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 |
| top-level window: its X parent is the root window of a screen |
| rather than the logical parent from its 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 |
| to make the toplevel appear raised or sunken. |
| |
| .SH "WIDGET COMMAND" |
| .PP |
| 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: |
| .CS |
| \fIpathName option \fR?\fIarg arg ...\fR? |
| .CE |
| \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\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 \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 |
| information on the format of this list). If \fIoption\fR is specified |
| with no \fIvalue\fR, 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 \fIoption\fR is specified). If |
| one or more \fIoption\-value\fR 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. |
| \fIOption\fR may have any of the values accepted by the \fBtoplevel\fR |
| command. |
| |
| .SH BINDINGS |
| .PP |
| When a new toplevel is created, it has no default event bindings: |
| toplevels are not intended to be interactive. |
| |
| .SH "SEE ALSO" |
| frame(n) |
| |
| .SH KEYWORDS |
| toplevel, widget |