diff options
author | hobbs <hobbs> | 2006-12-13 23:04:32 (GMT) |
---|---|---|
committer | hobbs <hobbs> | 2006-12-13 23:04:32 (GMT) |
commit | 7ea653691de3555fabaae6c4c7b08830d2eff991 (patch) | |
tree | 128697b7c80828f4a3d31417bb432bc8eec88b00 /doc/ttk_notebook.n | |
parent | 76e09e7212ec2afa7ed24d2650fafd20ab8dc5f6 (diff) | |
download | tk-7ea653691de3555fabaae6c4c7b08830d2eff991.zip tk-7ea653691de3555fabaae6c4c7b08830d2eff991.tar.gz tk-7ea653691de3555fabaae6c4c7b08830d2eff991.tar.bz2 |
* unix/Makefile.in (install-doc): intentionally skip ttk_dialog.n
installation (not for public consumption)
* doc/scrollbar.n, doc/button.n, doc/checkbutton.n:
* doc/entry.n, doc/frame.n, doc/label.n, doc/labelframe.n:
* doc/menu.n, doc/menubutton.n, doc/panedwindow.n:
* doc/radiobutton.n, doc/scrollbar.n, doc/ttk_*: revamp ttk docs
to use consist nroff format (not 100% consistent with classic
widget docs). Add more man page cross-linking "SEE ALSO".
Diffstat (limited to 'doc/ttk_notebook.n')
-rw-r--r-- | doc/ttk_notebook.n | 30 |
1 files changed, 22 insertions, 8 deletions
diff --git a/doc/ttk_notebook.n b/doc/ttk_notebook.n index 8912666..18459d4 100644 --- a/doc/ttk_notebook.n +++ b/doc/ttk_notebook.n @@ -1,26 +1,34 @@ '\" '\" 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. +'\" +'\" RCS: @(#) $Id: ttk_notebook.n,v 1.3 2006/12/13 23:04:33 hobbs Exp $ +'\" .so man.macros .TH ttk_notebook n 8.5 Tk "Tk Themed Widget" .BS +.\" Use _ instead of :: as the name becomes a filename on install .SH NAME -ttk::notebook \- Multi-paned container widget +ttk_notebook \- Multi-paned container widget .SH SYNOPSIS \fBttk::notebook\fR \fIpathName \fR?\fIoptions\fR? .br \fIpathName \fBadd\fR \fIpathName\fR.\fIsubwindow\fR ?\fIoptions...\fR? \fIpathName \fBinsert\fR \fIindex\fR \fIpathName\fR.\fIsubwindow\fR ?\fIoptions...\fR? .BE + .SH DESCRIPTION -A \fBnotebook\fR widget manages a collection of subpanes +A \fBttk::notebook\fR widget manages a collection of subpanes and displays a single one at a time. Each pane is associated with a tab, which the user may select to change the currently-displayed pane. .SO \-class \-cursor \-takefocus \-style .SE -.SH "WIDGET OPTIONS" + +.SH "WIDGET-SPECIFIC OPTIONS" .OP \-height height Height If present and greater than zero, specifies the desired height of the pane area @@ -70,6 +78,7 @@ 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 "WIDGET COMMAND" .TP \fIpathname \fBadd \fIchild\fR ?\fIoptions...\fR? @@ -80,10 +89,10 @@ will be displayed. See \fBTAB OPTIONS\fR for the list of available \fIoptions\fR. .TP \fIpathname \fBconfigure\fR ?\fIoptions\fR? -See \fIwidget(n)\fR. +See \fIttk_widget(n)\fR. .TP \fIpathname \fBcget\fR \fIoption\fR -See \fIwidget(n)\fR. +See \fIttk_widget(n)\fR. .TP \fIpathname \fBforget\fR \fItabid\fR Removes the tab specified by \fItabid\fR, @@ -102,7 +111,7 @@ moves it to the specified position. See \fBTAB OPTIONS\fR for the list of available options. .TP \fIpathname \fBinstate\fR \fIstatespec \fR?\fIscript...\fR? -See \fIwidget(n)\fR. +See \fIttk_widget(n)\fR. .TP \fIpathname \fBselect\fR ?\fItabid\fR? Selects the specified tab. The associated child pane will be displayed, @@ -111,7 +120,7 @@ If \fItabid\fR is omitted, returns the widget name of the currently selected pane. .TP \fIpathname \fBstate\fR ?\fIstatespec\fR? -See \fIwidget(n)\fR. +See \fIttk_widget(n)\fR. .TP \fIpathname \fBtab\fR \fItabid\fR ?\fI-options \fR?\fIvalue ...\fR Query or modify the options of the specific tab. @@ -123,6 +132,7 @@ See \fBTAB OPTIONS\fR for the available options. \fIpathname \fBtabs\fR Returns a list of all windows managed by the widget. .\" Perhaps "panes" is a better name for this command? + .SH "KEYBOARD TRAVERSAL" To enable keyboard traversal for a toplevel window containing a notebook widget \fI$nb\fR, call: @@ -144,6 +154,7 @@ 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 "TAB IDENTIFIERS" The \fItabid\fR argument to the above commands may take any of the following forms: @@ -165,6 +176,7 @@ which returns the number of tabs .SH "VIRTUAL EVENTS" The notebook widget generates a \fB<<NotebookTabChanged>>\fR virtual event after a new tab is selected. + .SH "EXAMPLE" .CS notebook .nb @@ -173,7 +185,9 @@ notebook .nb \.nb select .nb.f2 ttk::notebook::enableTraversal .nb .CE + .SH "SEE ALSO" -widget(n), grid(n) +ttk_widget(n), grid(n) + .SH "KEYWORDS" pane, tab |