270 lines
8.5 KiB
Plaintext
270 lines
8.5 KiB
Plaintext
'\"
|
|
'\" Copyright (c) 2004 Joe English
|
|
'\"
|
|
'\" See the file "license.terms" for information on usage and redistribution
|
|
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
|
'\"
|
|
.TH ttk::notebook n 8.5 Tk "Tk Themed Widget"
|
|
.so man.macros
|
|
.BS
|
|
.SH NAME
|
|
ttk::notebook \- Multi-paned container widget
|
|
.SH SYNOPSIS
|
|
.nf
|
|
\fBttk::notebook\fR \fIpathname \fR?\fIoptions...\fR?
|
|
.br
|
|
\fIpathname \fBadd\fR \fIwindow\fR ?\fIoptions...\fR?
|
|
\fIpathname \fBinsert\fR \fIindex\fR \fIwindow\fR ?\fIoptions...\fR?
|
|
.fi
|
|
.BE
|
|
.SH DESCRIPTION
|
|
A \fBttk::notebook\fR widget manages a collection of windows
|
|
and displays a single one at a time.
|
|
Each content window is associated with a \fItab\fR,
|
|
which the user may select to change the currently-displayed window.
|
|
.SO ttk_widget
|
|
\-class \-cursor \-takefocus
|
|
\-style
|
|
.SE
|
|
.SH "WIDGET-SPECIFIC OPTIONS"
|
|
.OP \-height height Height
|
|
If present and greater than zero,
|
|
specifies the desired height of the pane area
|
|
(not including internal padding or tabs).
|
|
Otherwise, the maximum height of all panes is used.
|
|
.OP \-padding padding Padding
|
|
Specifies the amount of extra space to add around the outside
|
|
of the notebook.
|
|
The padding is a list of up to four length specifications
|
|
\fIleft top right bottom\fR.
|
|
If fewer than four elements are specified,
|
|
\fIbottom\fR defaults to \fItop\fR,
|
|
\fIright\fR defaults to \fIleft\fR, and
|
|
\fItop\fR defaults to \fIleft\fR.
|
|
In other words, a list of three numbers specify the left, vertical, and right padding;
|
|
a list of two numbers specify the horizontal and the vertical padding;
|
|
a single number specifies the same padding all the way around the widget.
|
|
.OP \-width width Width
|
|
If present and greater than zero,
|
|
specifies the desired width of the pane area
|
|
(not including internal padding).
|
|
Otherwise, the maximum width of all panes is used.
|
|
.SH "TAB OPTIONS"
|
|
The following options may be specified for individual notebook panes:
|
|
.OP \-state state State
|
|
Either \fBnormal\fR, \fBdisabled\fR or \fBhidden\fR.
|
|
If \fBdisabled\fR, then the tab is not selectable.
|
|
If \fBhidden\fR, then the tab is not shown.
|
|
.OP \-sticky sticky Sticky
|
|
Specifies how the content window is positioned within the pane area.
|
|
Value is a string containing zero or more of the characters
|
|
\fBn, s, e,\fR or \fBw\fR.
|
|
Each letter refers to a side (north, south, east, or west)
|
|
that the content window will
|
|
.QW stick
|
|
to, as per the \fBgrid\fR geometry manager.
|
|
.OP \-padding padding Padding
|
|
Specifies the amount of extra space to add between the notebook and this pane.
|
|
Syntax is the same as for the widget \fB\-padding\fR option.
|
|
.OP \-text text Text
|
|
Specifies a string to be displayed in the tab.
|
|
.OP \-image image Image
|
|
Specifies an image to display in the tab.
|
|
See \fIttk_widget(n)\fR for details.
|
|
.OP \-compound compound Compound
|
|
Specifies how to display the image relative to the text,
|
|
in the case both \fB\-text\fR and \fB\-image\fR are present.
|
|
See \fIlabel(n)\fR for legal values.
|
|
.OP \-underline underline Underline
|
|
Specifies the integer index (0-based) of a character to underline
|
|
in the text string.
|
|
The underlined character is used for mnemonic activation
|
|
if \fBttk::notebook::enableTraversal\fR is called.
|
|
.SH "TAB IDENTIFIERS"
|
|
The \fItabid\fR argument to the following commands may take
|
|
any of the following forms:
|
|
.IP \(bu
|
|
An integer between zero and the number of tabs;
|
|
.IP \(bu
|
|
The name of a content window;
|
|
.IP \(bu
|
|
A positional specification of the form
|
|
.QW @\fIx\fR,\fIy\fR ,
|
|
which identifies the tab
|
|
.IP \(bu
|
|
The literal string
|
|
.QW \fBcurrent\fR ,
|
|
which identifies the currently-selected tab; or:
|
|
.IP \(bu
|
|
The literal string
|
|
.QW \fBend\fR ,
|
|
which returns the number of tabs
|
|
(only valid for
|
|
.QW "\fIpathname \fBindex\fR" ).
|
|
.SH "WIDGET COMMAND"
|
|
.TP
|
|
\fIpathname \fBadd \fIwindow\fR ?\fIoptions...\fR?
|
|
Adds a new tab to the notebook.
|
|
See \fBTAB OPTIONS\fR for the list of available \fIoptions\fR.
|
|
If \fIwindow\fR is currently managed by the notebook but hidden,
|
|
it is restored to its previous position.
|
|
.TP
|
|
\fIpathname \fBconfigure\fR ?\fIoptions\fR?
|
|
See \fIttk::widget(n)\fR.
|
|
.TP
|
|
\fIpathname \fBcget \fIoption\fR
|
|
See \fIttk::widget(n)\fR.
|
|
.TP
|
|
\fIpathname \fBforget \fItabid\fR
|
|
Removes the tab specified by \fItabid\fR,
|
|
unmaps and unmanages the associated window.
|
|
.TP
|
|
\fIpathname \fBhide \fItabid\fR
|
|
Hides the tab specified by \fItabid\fR.
|
|
The tab will not be displayed, but the associated window
|
|
remains managed by the notebook and its configuration remembered.
|
|
Hidden tabs may be restored with the \fBadd\fR command.
|
|
.TP
|
|
\fIpathname \fBidentify\fI component x y\fR
|
|
Returns the name of the element under the point given by \fIx\fR and \fIy\fR,
|
|
or the empty string if no component is present at that location.
|
|
The following subcommands are supported:
|
|
.RS
|
|
.TP
|
|
\fIpathname \fBidentify element\fR \fIx y\fR
|
|
Returns the name of the element at the specified location.
|
|
.TP
|
|
\fIpathname \fBidentify tab\fR \fIx y\fR
|
|
Returns the index of the tab at the specified location.
|
|
.RE
|
|
.TP
|
|
\fIpathname \fBindex \fItabid\fR
|
|
Returns the numeric index of the tab specified by \fItabid\fR,
|
|
or the total number of tabs if \fItabid\fR is the string
|
|
.QW \fBend\fR .
|
|
.TP
|
|
\fIpathname \fBinsert \fIpos subwindow options...\fR
|
|
Inserts a pane at the specified position.
|
|
\fIpos\fR is either the string \fBend\fR, an integer index,
|
|
or the name of a managed subwindow.
|
|
If \fIsubwindow\fR is already managed by the notebook,
|
|
moves it to the specified position.
|
|
See \fBTAB OPTIONS\fR for the list of available options.
|
|
.TP
|
|
\fIpathname \fBinstate \fIstatespec \fR?\fIscript...\fR?
|
|
See \fIttk::widget(n)\fR.
|
|
.TP
|
|
\fIpathname \fBselect\fR ?\fItabid\fR?
|
|
Selects the specified tab.
|
|
The associated content window will be displayed,
|
|
and the previously-selected window (if different) is unmapped.
|
|
If \fItabid\fR is omitted, returns the widget name of the
|
|
currently selected pane.
|
|
.TP
|
|
\fIpathname \fBstate\fR ?\fIstatespec\fR?
|
|
See \fIttk::widget(n)\fR.
|
|
.TP
|
|
\fIpathname \fBtab \fItabid\fR ?\fI\-option \fR?\fIvalue ...\fR
|
|
Query or modify the options of the specific tab.
|
|
If no \fI\-option\fR is specified,
|
|
returns a dictionary of the tab option values.
|
|
If one \fI\-option\fR is specified,
|
|
returns the value of that \fIoption\fR.
|
|
Otherwise, sets the \fI\-option\fRs to the corresponding \fIvalue\fRs.
|
|
See \fBTAB OPTIONS\fR for the available options.
|
|
.TP
|
|
\fIpathname \fBtabs\fR
|
|
Returns the list of windows managed by the notebook, in the index order of
|
|
their associated tabs.
|
|
.SH "KEYBOARD TRAVERSAL"
|
|
To enable keyboard traversal for a toplevel window
|
|
containing a notebook widget \fI$nb\fR, call:
|
|
.CS
|
|
ttk::notebook::enableTraversal $nb
|
|
.CE
|
|
.PP
|
|
This will extend the bindings for the toplevel window
|
|
containing the notebook as follows:
|
|
.IP \(bu
|
|
\fBControl-Tab\fR selects the tab following the currently selected one.
|
|
.IP \(bu
|
|
\fBControl-Shift-Tab\fR selects the tab preceding the currently selected one.
|
|
.IP \(bu
|
|
\fBAlt-\fIK\fR, where \fIK\fR is the mnemonic (underlined) character
|
|
of any tab, will select that tab.
|
|
.PP
|
|
Multiple notebooks in a single toplevel may be enabled for traversal,
|
|
including nested notebooks.
|
|
However, notebook traversal only works properly if all panes
|
|
are direct children of the notebook.
|
|
.SH "VIRTUAL EVENTS"
|
|
The notebook widget generates a \fB<<NotebookTabChanged>>\fR
|
|
virtual event after a new tab is selected.
|
|
.SH "EXAMPLE"
|
|
.CS
|
|
pack [\fBttk::notebook\fR .nb]
|
|
\&.nb add [frame .nb.f1] \-text "First tab"
|
|
\&.nb add [frame .nb.f2] \-text "Second tab"
|
|
\&.nb select .nb.f2
|
|
ttk::notebook::enableTraversal .nb
|
|
.CE
|
|
.SH "STYLING OPTIONS"
|
|
.PP
|
|
The class name for a \fBttk::notebook\fP is \fBTNotebook\fP. The tab has
|
|
a class name of \fBTNotebook.Tab\fP
|
|
.PP
|
|
Dynamic states: \fBactive\fP, \fBdisabled\fP, \fBselected\fP.
|
|
.PP
|
|
\fBTNotebook\fP styling options configurable with \fBttk::style\fP
|
|
are:
|
|
.PP
|
|
\fB\-background\fP \fIcolor\fP
|
|
.br
|
|
\fB\-bordercolor\fP \fIcolor\fP
|
|
.br
|
|
\fB\-darkcolor\fP \fIcolor\fP
|
|
.br
|
|
\fB\-foreground\fP \fIcolor\fP
|
|
.br
|
|
\fB\-lightcolor\fP \fIcolor\fP
|
|
.br
|
|
\fB\-padding\fP \fIpadding\fP
|
|
.br
|
|
\fB\-tabmargins\fP \fIpadding\fP
|
|
.br
|
|
\fB\-tabposition\fP \fIside\fP
|
|
.br
|
|
.PP
|
|
\fBTNotebook.Tab\fP styling options configurable with \fBttk::style\fP
|
|
are:
|
|
.PP
|
|
\fB\-background\fP \fIcolor\fP
|
|
.br
|
|
\fB\-bordercolor\fP \fIcolor\fP
|
|
.br
|
|
\fB\-compound\fP \fIcompound\fP
|
|
.br
|
|
\fB\-expand\fP \fIpadding\fP
|
|
.RS
|
|
Defines how much the tab grows in size. Usually used with the
|
|
\fBselected\fP dynamic state. \fB\-tabmargins\fP should be
|
|
set appropriately so that there is room for the tab growth.
|
|
.RE
|
|
\fB\-font\fP \fIfont\fP
|
|
.br
|
|
\fB\-foreground\fP \fIcolor\fP
|
|
.br
|
|
\fB\-padding\fP \fIpadding\fP
|
|
.PP
|
|
Some options are only available for specific themes.
|
|
.PP
|
|
See the \fBttk::style\fP manual page for information on how to configure
|
|
ttk styles.
|
|
.SH "SEE ALSO"
|
|
ttk::widget(n), grid(n)
|
|
.SH "KEYWORDS"
|
|
pane, tab
|
|
'\" Local Variables:
|
|
'\" mode: nroff
|
|
'\" End:
|