tkinter.LabelFrame

SYNOPSIS

instance = tkinter.LabelFrame(parent ,**options)

STANDARD OPTIONS

borderwidth or bd
cursor
font
foreground or fg
highlightbackground
highlightcolor
highlightthickness
padx
pady
relief
takefocus
text

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.

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

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 same colormap as its parent. 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.

labelanchor
Specifies where to place the label. A label is only displayed if the text option is not the empty string. Valid values for this option are (listing them clockwise) "nw", "n", "ne", "en", "e", "es", "se", "s","sw", "ws", "w" and "wn". The default value is "nw".

labelwidget
Specifies a widget to use as label. This overrides any text option. The widget must exist before being used as labelwidget and if it is not a descendant of this window, it will be raised above it in the stacking order.

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 same visual as its parent. 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 labelframe is a simple widget. Its primary purpose is to act as a spacer or container for complex window layouts. It has the features of a tkinter.Frame plus the ability to display a label.

WIDGET COMMAND

The following methods are possible for frame 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 LabelFrame 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 LabelFrame class.

BINDINGS

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