tkinter.Toplevel

SYNOPSIS

instance = tkinter.Toplevel(**options)

STANDARD OPTIONS

borderwidth or bd
cursor
highlightbackground
highlightcolor
highlightthickness
padx
pady
relief
takefocus

WIDGET-SPECIFIC OPTIONS

background
This option is the same as the standard background 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.

colormap
Specifies a colormap to use for the window. The value may be either "new", 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 instance), in which case the new window will use the colormap from the specified window. If the colormap option is not specified, the new window uses the default colormap of its screen. This option may not be changed with the configure() widget method.

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 Tkinter toplevel can be embedded using the use 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 configure() widget method.

height
Specifies the desired height for the window in any of the forms acceptable to Screen Units. If this option is less than or equal to zero then the window will not request any size at all.

menu
Specifies a menu widget to be used as a menubar. On the Macintosh, the menubar will be displayed across the top of the main monitor. On Microsoft Windows and all UNIX platforms, the menu will appear across the toplevel window as part of the window dressing maintained by the window manager.

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 may not be modified with the configure() widget method.

use
This option is used for embedding. If the value is not an empty string, it must be the window identifier of a container window, specified as a hexadecimal string like the ones returned by the winfo_id() method. 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 Tkinter application, it must be a Frame or Toplevel widget for which the container option was specified. This option may not be changed with the configure() widget method.

visual
Specifies visual information for the new window in any of the forms accepted by Visual Classes. If this option is not specified, the new window will use the default visual for its screen. The visual option may not be modified with the configure() widget method.

width
Specifies the desired width for the window in any of the forms acceptable to Screen Units. If this option is less than or equal to zero then the window will not request any size at all.

DESCRIPTION

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. 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.

WIDGET COMMAND

The following commands are possible for toplevel widgets:

instance.cget("option")
Returns the current value of the configuration option given by option. Option may have any of the values accepted by the Toplevel class.

instance.configure()
instance.configure("option")
instance.configure(**options)
Query or modify the configuration options of the widget.
If no option is specified, returns a list describing all of the available options for instance: the elements of the list are the option name, database name, database class, default value, and current value.
If "option" is specified, then the method returns a list describing the one named option (this list will be identical to the corresponding sublist of the value returned if no option is specified).
If **options are specified, then the command modifies the given widget option(s) to have the given value(s); in this case the method returns an empty string. Option may have any of the values accepted by the Toplevel class.

BINDINGS

When a new Toplevel is created, it has no default event bindings: Toplevels are not intended to be interactive.