summaryrefslogtreecommitdiffstats
path: root/doc/ttk_panedwindow.n
diff options
context:
space:
mode:
authorjenglish <jenglish@flightlab.com>2007-06-10 03:25:31 (GMT)
committerjenglish <jenglish@flightlab.com>2007-06-10 03:25:31 (GMT)
commit6eb8176a7b42558bdb5ffa99b82a3d9839982deb (patch)
treea2107ff444528de2a2aeab10c2b81ea1c6fc2094 /doc/ttk_panedwindow.n
parent9764501288b757d0532c4eb230b67d2e69cefb0b (diff)
downloadtk-6eb8176a7b42558bdb5ffa99b82a3d9839982deb.zip
tk-6eb8176a7b42558bdb5ffa99b82a3d9839982deb.tar.gz
tk-6eb8176a7b42558bdb5ffa99b82a3d9839982deb.tar.bz2
Added -width and -height options.
Added 'panes' method, return list of managed windows. 'sashpos' method is now documented as part of the public interface, and details clarified. Should be easier to set initial sash positions now [Alleviates #1659067].
Diffstat (limited to 'doc/ttk_panedwindow.n')
-rw-r--r--doc/ttk_panedwindow.n30
1 files changed, 22 insertions, 8 deletions
diff --git a/doc/ttk_panedwindow.n b/doc/ttk_panedwindow.n
index 4928b15..b7d0210 100644
--- a/doc/ttk_panedwindow.n
+++ b/doc/ttk_panedwindow.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_panedwindow.n,v 1.5 2007/06/09 21:45:44 jenglish Exp $
+'\" RCS: @(#) $Id: ttk_panedwindow.n,v 1.6 2007/06/10 03:25:32 jenglish Exp $
'\"
.so man.macros
.TH ttk_panedwindow n 8.5 Tk "Tk Themed Widget"
@@ -34,6 +34,16 @@ of the subwindows by dragging the sash between panes.
Specifies the orientation of the window.
If \fBvertical\fR, subpanes are stacked top-to-bottom;
if \fBhorizontal\fR, subpanes are stacked left-to-right.
+.OP \-width width Width
+If present and greater than zero,
+specifies the desired width of the widget in pixels.
+Otherwise, the requested width is determined by the width
+of the managed windows.
+.OP \-height height Height
+If present and greater than zero,
+specifies the desired height of the widget in pixels.
+Otherwise, the requested height is determined by the height
+of the managed windows.
.SH "PANE OPTIONS"
The following options may be specified for each pane:
@@ -71,15 +81,19 @@ 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.
.TP
\fIpathname\fR \fBsashpos\fR \fIindex\fR ?\fInewpos\fR?
-If \fInewpos\fR is specified, sets the sash position
-(subject to constraints).
-Returns the position of sash number \fIindex\fR.
+If \fInewpos\fR is specified, sets the position
+of sash number \fIindex\fR.
+May adjust the positions of adjacent sashes
+to ensure that positions are monotonically increasing.
+Sash positions are further constrained to be between 0
+and the total size of the widget.
+.\" Full story: "total size" is either the -height (resp -width),
+.\" or the actual window height (resp actual window width),
+.\" depending on which changed most recently.
+Returns the new position of sash number \fIindex\fR.
+.\" Full story: new position may be different than the requested position.
.TP
\fIpathname\fR \fBidentify\fR \fIx y\fR
Returns the index of the sash at point \fIx,y\fR,