Home › Tk Themed Widget Tk

ttk::labelframe

Container widget with optional label

literal type exactly as shown argument replace with your value ?optional? may be omitted

Synopsis#

ttk::labelframe pathName ?options?

Description#

A ttk::labelframe widget is a container used to group other widgets together. It has an optional label, which may be a plain text string or another widget.

Standard Options#

See the ttk_widget manual entry for details on the standard options.

Widget-specific options#

-height#

Database name	height
Database class	Height

If specified, the widget's requested height in pixels. (See ttk::frame(n) for further notes on -width and -height).

-labelanchor#

Database name	labelAnchor
Database class	LabelAnchor

Specifies where to place the label. Allowed values are (clockwise from the top upper left corner): nw, n, ne, en, e, es, se, s,sw, ws, w and wn. The default value is theme-dependent.

-labelwidget#

Database name	labelWidget
Database class	LabelWidget

The name of a widget to use for the label. If set, overrides the -text option. The -labelwidget must be a child of the labelframe widget or one of the labelframe's ancestors, and must belong to the same top-level widget as the labelframe.

-text#

Database name	text
Database class	Text

Specifies the text of the label.

-underline#

Database name	underline
Database class	Underline

If set, specifies the integer index (0-based) of a character to underline in the text string. The underlined character is used for mnemonic activation. Mnemonic activation for a ttk::labelframe sets the keyboard focus to the first child of the ttk::labelframe widget.

-width#

Database name	width
Database class	Width

If specified, the widget's requested width in pixels.

Widget command#

Labelframe widgets support the standard commands cget, configure, identify element, instate, state and style (see ttk::widget).

Styling options#

The class name for a ttk::labelframe is TLabelframe. The text label has a class of TLabelframe.Label.

Dynamic states: disabled, readonly.

TLabelframe styling options configurable with ttk::style are:

-background color
-bordercolor color
-borderwidth amount
-darkcolor color
-labelmargins amount
-labeloutside boolean
-lightcolor color
-relief relief

TLabelframe.Label styling options configurable with ttk::style are:

-background color
-font font
-foreground color

Some options are only available for specific themes.

See the ttk::style manual page for information on how to configure ttk styles.

Keywords#

widget · frame · container · label · groupbox

Copyright#

• Copyright © 2005 Joe English