1toplevel(n) Tk Built-In Commands toplevel(n)
2______________________________________________________________________________
6
8 toplevel - Create and manipulate toplevel widgets
9
11 toplevel pathName ?options?
12
14 -borderwidth -highlightcolor -pady
15 -cursor -highlightthickness -relief
16 -highlightbackground -padx -takefocus
17 See the options manual entry for details on the standard options.
19
21 [-background background] This option is the same as the standard back‐
22 ground option except that its value may also be specified as an empty
23 string. In this case, the widget will display no background or border,
24 and no colors will be consumed from its colormap for its background and
25 border. [-class class] Specifies a class for the window. This class
26 will be used when querying the option database for the window's other
27 options, and it will also be used later for other purposes such as
28 bindings. The class option may not be changed with the configure wid‐
29 get command. [-colormap colormap] Specifies a colormap to use for the
30 window. The value may be either new, in which case a new colormap is
31 created for the window and its children, or the name of another window
32 (which must be on the same screen and have the same visual as path‐
33 Name), in which case the new window will use the colormap from the
34 specified window. If the colormap option is not specified, the new
35 window uses the default colormap of its screen. This option may not be
36 changed with the configure widget command. [-container container] The
37 value must be a boolean. If true, it means that this window will be
38 used as a container in which some other application will be embedded
39 (for example, a Tk toplevel can be embedded using the -use option).
40 The window will support the appropriate window manager protocols for
41 things like geometry requests. The window should not have any children
42 of its own in this application. This option may not be changed with
43 the configure widget command. [-height height] Specifies the desired
44 height for the window in any of the forms acceptable to Tk_GetPixels.
45 If this option is less than or equal to zero then the window will not
46 request any size at all. [-menu menu] Specifies a menu widget to be
47 used as a menubar. On the Macintosh, the menubar will be displayed
48 across the top of the main monitor. On Microsoft Windows and all UNIX
49 platforms, the menu will appear across the toplevel window as part of
50 the window dressing maintained by the window manager. [-screen ] Spec‐
51 ifies the screen on which to place the new window. Any valid screen
52 name may be used, even one associated with a different display.
53 Defaults to the same screen as its parent. This option is special in
54 that it may not be specified via the option database, and it may not be
55 modified with the configure widget command. [-use use] This option is
56 used for embedding. If the value isn't an empty string, it must be the
57 window identifier of a container window, specified as a hexadecimal
58 string like the ones returned by the winfo id command. The toplevel
59 widget will be created as a child of the given container instead of the
60 root window for the screen. If the container window is in a Tk appli‐
61 cation, it must be a frame or toplevel widget for which the -container
62 option was specified. This option may not be changed with the config‐
63 ure widget command. [-visual visual] Specifies visual information for
64 the new window in any of the forms accepted by Tk_GetVisual. If this
65 option is not specified, the new window will use the default visual for
66 its screen. The visual option may not be modified with the configure
67 widget command. [-width width] Specifies the desired width for the
68 window in any of the forms acceptable to Tk_GetPixels. If this option
69 is less than or equal to zero then the window will not request any size
70 at all.
71_________________________________________________________________
72
75 The toplevel command creates a new toplevel widget (given by the path‐
76 Name argument). Additional options, described above, may be specified
77 on the command line or in the option database to configure aspects of
78 the toplevel such as its background color and relief. The toplevel
79 command returns the path name of the new window.
80 A toplevel is similar to a frame except that it is created as a top-
82 level window: its X parent is the root window of a screen rather than
83 the logical parent from its path name. The primary purpose of a
84 toplevel is to serve as a container for dialog boxes and other collec‐
85 tions of widgets. The only visible features of a toplevel are its
86 background color and an optional 3-D border to make the toplevel appear
87 raised or sunken.
88
91 The toplevel command creates a new Tcl command whose name is the same
92 as the path name of the toplevel's window. This command may be used to
93 invoke various operations on the widget. It has the following general
94 form:
95 pathName option ?arg arg ...?
96 PathName is the name of the command, which is the same as the toplevel
97 widget's path name. Option and the args determine the exact behavior
98 of the command. The following commands are possible for toplevel wid‐
99 gets:
100 pathName cget option
102 Returns the current value of the configuration option given by
103 option. Option may have any of the values accepted by the
104 toplevel command.
105 pathName configure ?option? ?value option value ...?
107 Query or modify the configuration options of the widget. If no
108 option is specified, returns a list describing all of the avail‐
109 able options for pathName (see Tk_ConfigureInfo for information
110 on the format of this list). If option is specified with no
111 value, then the command returns a list describing the one named
112 option (this list will be identical to the corresponding sublist
113 of the value returned if no option is specified). If one or
114 more option-value pairs are specified, then the command modifies
115 the given widget option(s) to have the given value(s); in this
116 case the command returns an empty string. Option may have any
117 of the values accepted by the toplevel command.
118
121 When a new toplevel is created, it has no default event bindings:
122 toplevels are not intended to be interactive.
123
126 frame(n)
127
130 toplevel, widget
131Tk 8.4 toplevel(n)