diff options
author | dkf <donal.k.fellows@manchester.ac.uk> | 2007-10-29 16:04:11 (GMT) |
---|---|---|
committer | dkf <donal.k.fellows@manchester.ac.uk> | 2007-10-29 16:04:11 (GMT) |
commit | 447c5cc18c467353963659dc23a69436b253293c (patch) | |
tree | f1b13d0b63bdcb785dc2718534eb209b9796d50b /doc/ttk_notebook.n | |
parent | 5f3a1bfa8de8e91197ca501ca72204d29cd4ba4d (diff) | |
download | tk-447c5cc18c467353963659dc23a69436b253293c.zip tk-447c5cc18c467353963659dc23a69436b253293c.tar.gz tk-447c5cc18c467353963659dc23a69436b253293c.tar.bz2 |
Lots more GOOBE stuff. Now works with 'make html'!
Diffstat (limited to 'doc/ttk_notebook.n')
-rw-r--r-- | doc/ttk_notebook.n | 50 |
1 files changed, 24 insertions, 26 deletions
diff --git a/doc/ttk_notebook.n b/doc/ttk_notebook.n index b407f05..5ed1e96 100644 --- a/doc/ttk_notebook.n +++ b/doc/ttk_notebook.n @@ -4,7 +4,7 @@ '\" 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.5 2007/10/26 20:13:23 dgp Exp $ +'\" RCS: @(#) $Id: ttk_notebook.n,v 1.6 2007/10/29 16:04:14 dkf Exp $ '\" .so man.macros .TH ttk_notebook n 8.5 Tk "Tk Themed Widget" @@ -18,7 +18,6 @@ ttk_notebook \- Multi-paned container widget \fIpathName \fBadd\fR \fIpathName\fR.\fIsubwindow\fR ?\fIoptions...\fR? \fIpathName \fBinsert\fR \fIindex\fR \fIpathName\fR.\fIsubwindow\fR ?\fIoptions...\fR? .BE - .SH DESCRIPTION A \fBttk::notebook\fR widget manages a collection of subpanes and displays a single one at a time. @@ -27,7 +26,6 @@ may select to change the currently-displayed pane. .SO \-class \-cursor \-takefocus \-style .SE - .SH "WIDGET-SPECIFIC OPTIONS" .OP \-height height Height If present and greater than zero, @@ -59,11 +57,12 @@ Specifies how the child pane 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 child window will "stick" to, -as per the \fBgrid\fR geometry manager. +that the child 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. +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 @@ -71,14 +70,13 @@ Specifies an image to display in the tab, which must have been created with the \fBimage create\fR command. .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. +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 "WIDGET COMMAND" .TP \fIpathname \fBadd \fIchild\fR ?\fIoptions...\fR? @@ -100,7 +98,8 @@ unmaps and unmanages the associated child window. .TP \fIpathname \fBindex\fR \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 "\fBend\fR". +or the total number of tabs if \fItabid\fR is the string +.QW \fBend\fR . .TP \fIpathname \fBinsert\fR \fIpos\fR \fIsubwindow\fR \fIoptions...\fR Inserts a pane at the specified position. @@ -122,17 +121,17 @@ currently selected pane. \fIpathname \fBstate\fR ?\fIstatespec\fR? See \fIttk_widget(n)\fR. .TP -\fIpathname \fBtab\fR \fItabid\fR ?\fI-options \fR?\fIvalue ...\fR +\fIpathname \fBtab\fR \fItabid\fR ?\fI\-options \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. +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 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: @@ -154,7 +153,6 @@ 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: @@ -163,31 +161,31 @@ An integer between zero and the number of tabs; .IP \(bu The name of a child pane window; .IP \(bu -A positional specification of the form "@\fIx\fR,\fIy\fR", +A positional specification of the form +.QW @\fIx\fR,\fIy\fR , which identifies the tab .IP \(bu -The literal string "\fBcurrent\fR", +The literal string +.QW \fBcurrent\fR , which identifies the currently-selected tab; or: .IP \(bu -The literal string "\fBend\fR", +The literal string +.QW \fBend\fR , which returns the number of tabs -(only valid for "\fIpathname \fBindex\fR"). - +(only valid for +.QW "\fIpathname \fBindex\fR" ). .SH "VIRTUAL EVENTS" The notebook widget generates a \fB<<NotebookTabChanged>>\fR virtual event after a new tab is selected. - .SH "EXAMPLE" .CS -notebook .nb -\.nb add [frame .nb.f1] -text "First tab" -\.nb add [frame .nb.f2] -text "Second tab" +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 "SEE ALSO" ttk_widget(n), grid(n) - .SH "KEYWORDS" pane, tab |