summaryrefslogtreecommitdiffstats
path: root/doc/ttk_panedwindow.n
diff options
context:
space:
mode:
authorhobbs <hobbs>2006-12-13 23:04:32 (GMT)
committerhobbs <hobbs>2006-12-13 23:04:32 (GMT)
commitd4a63ee0259256e40eba77a360b9902afc472bc4 (patch)
tree128697b7c80828f4a3d31417bb432bc8eec88b00 /doc/ttk_panedwindow.n
parent318393c4af319ed15ef4a5d6e3f5b12259fe695d (diff)
downloadtk-d4a63ee0259256e40eba77a360b9902afc472bc4.zip
tk-d4a63ee0259256e40eba77a360b9902afc472bc4.tar.gz
tk-d4a63ee0259256e40eba77a360b9902afc472bc4.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_panedwindow.n')
-rw-r--r--doc/ttk_panedwindow.n34
1 files changed, 23 insertions, 11 deletions
diff --git a/doc/ttk_panedwindow.n b/doc/ttk_panedwindow.n
index 1c7661e..43eea62 100644
--- a/doc/ttk_panedwindow.n
+++ b/doc/ttk_panedwindow.n
@@ -1,10 +1,17 @@
-'\" $Id: ttk_panedwindow.n,v 1.2 2006/11/15 13:29:17 dkf Exp $
+'\"
'\" Copyright (c) 2005 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_panedwindow.n,v 1.3 2006/12/13 23:04:33 hobbs Exp $
+'\"
.so man.macros
.TH ttk_panedwindow n 8.5 Tk "Tk Themed Widget"
.BS
-.SH "NAME"
-ttk::panedwindow \- Multi-pane container window
+.\" Use _ instead of :: as the name becomes a filename on install
+.SH NAME
+ttk_panedwindow \- Multi-pane container window
.SH SYNOPSIS
.nf
\fBttk::panedwindow\fR \fIpathName \fR?\fIoptions\fR?
@@ -13,28 +20,31 @@ ttk::panedwindow \- Multi-pane container window
\fIpathName \fBinsert\fR \fIindex\fR \fIpathName.subwindow\fR ?\fIoptions...\fR?
.fi
.BE
-.SH "DESCRIPTION"
-A paned widget displays a number of subwindows,
-stacked either vertically or horizontally.
-The user may adjust the relative sizes of the subwindows
-by dragging the sash between panes.
+
+.SH DESCRIPTION
+A \fBttk::panedwindow\fR widget displays a number of subwindows, stacked
+either vertically or horizontally. The user may adjust the relative sizes
+of the subwindows by dragging the sash between panes.
.SO
\-class \-cursor \-takefocus \-style
.SE
-.SH "WIDGET OPTIONS"
+
+.SH "WIDGET-SPECIFIC OPTIONS"
.OP \-orient orient Orient
Specifies the orientation of the window.
If \fBvertical\fR, subpanes are stacked top-to-bottom;
if \fBhorizontal\fR, subpanes are stacked left-to-right.
+
.SH "PANE OPTIONS"
The following options may be specified for each pane:
.OP \-weight weight Weight
An integer specifying the relative stretchability of the pane.
When the paned window is resized, the extra space is added
or subracted to each pane proportionally to its \fB-weight\fR.
+
.SH "WIDGET COMMAND"
Supports the standard \fBconfigure\fR, \fBcget\fR, \fBstate\fR,
-and \fBinstate\fR commands; see \fIwidget(n)\fR for details.
+and \fBinstate\fR commands; see \fIttk_widget(n)\fR for details.
Additional commands:
.TP
\fIpathname \fBadd\fR \fIsubwindow\fR \fIoptions...\fR
@@ -61,6 +71,7 @@ If no \fI-option\fR is specified, returns a dictionary of the pane
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.
+
.SH "INTERNAL ROUTINES"
The following routines are used internally by the \fBpaned\fR widget
binding code.
@@ -74,5 +85,6 @@ Returns the position of sash number \fIindex\fR.
Returns a list consisting of the sash index at point \fIx,y\fR
and the name of the sash subelement at that point.
Returns the empty list if \fIx,y\fR is not over a sash.
+
.SH "SEE ALSO"
-\fIwidget(n)\fR, \fInotebook(n)\fR.
+ttk_widget(n), ttk_notebook(n), panedwindow(n)