summaryrefslogtreecommitdiffstats
path: root/doc/ttk_panedwindow.n
diff options
context:
space:
mode:
authorjenglish <jenglish@flightlab.com>2009-11-01 18:12:44 (GMT)
committerjenglish <jenglish@flightlab.com>2009-11-01 18:12:44 (GMT)
commit0c58d63813ddb8805d9b12b877a47e2d66027897 (patch)
tree82d1b223559ec164d9a4b29d63dac1acfbaf507e /doc/ttk_panedwindow.n
parent0f2aa87192cc95c6095ccce0e517004664c2061f (diff)
downloadtk-0c58d63813ddb8805d9b12b877a47e2d66027897.zip
tk-0c58d63813ddb8805d9b12b877a47e2d66027897.tar.gz
tk-0c58d63813ddb8805d9b12b877a47e2d66027897.tar.bz2
Uniform, extensible syntax for [$w identify] methods:
[$w identify $component $x $y]. All ttk::* widgets support [$w identify element $x $y]; widgets with other identifiable parts may have additional subcommands. Notebook widgets support [$nb identify tab], Panedwindow widgets support [$w identify sash]. Older 2-argument form [$w identify $x $y] still supported, though it does different things depending on the widget.
Diffstat (limited to 'doc/ttk_panedwindow.n')
-rw-r--r--doc/ttk_panedwindow.n65
1 files changed, 38 insertions, 27 deletions
diff --git a/doc/ttk_panedwindow.n b/doc/ttk_panedwindow.n
index d6f7e47..472761e 100644
--- a/doc/ttk_panedwindow.n
+++ b/doc/ttk_panedwindow.n
@@ -3,9 +3,9 @@
'\"
'\" 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.19 2008/11/19 20:17:34 jenglish Exp $
-'\"
+'\"
+'\" RCS: @(#) $Id: ttk_panedwindow.n,v 1.20 2009/11/01 18:12:44 jenglish Exp $
+'\"
.so man.macros
.TH ttk::panedwindow n 8.5 Tk "Tk Themed Widget"
.BS
@@ -13,17 +13,17 @@
ttk::panedwindow \- Multi-pane container window
.SH SYNOPSIS
.nf
-\fBttk::panedwindow\fR \fIpathName \fR?\fIoptions\fR?
+\fBttk::panedwindow\fR \fIpathname \fR?\fIoptions\fR?
.br
-\fIpathName \fBadd\fR \fIwindow\fR ?\fIoptions...\fR?
-\fIpathName \fBinsert\fR \fIindex\fR \fIwindow\fR ?\fIoptions...\fR?
+\fIpathname \fBadd\fR \fIwindow\fR ?\fIoptions...\fR?
+\fIpathname \fBinsert\fR \fIindex\fR \fIwindow\fR ?\fIoptions...\fR?
.fi
.BE
.SH DESCRIPTION
-.PP
-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.
+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 ttk_widget
\-class \-cursor \-takefocus
\-style
@@ -34,62 +34,73 @@ 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,
+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,
+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"
-.PP
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 subtracted to each pane proportionally to its \fB\-weight\fR.
.SH "WIDGET COMMAND"
-.PP
-Supports the standard \fBconfigure\fR, \fBcget\fR, \fBstate\fR,
+Supports the standard \fBconfigure\fR, \fBcget\fR, \fBstate\fR,
and \fBinstate\fR commands; see \fIttk::widget(n)\fR for details.
Additional commands:
.TP
-\fIpathname \fBadd\fR \fIsubwindow\fR \fIoptions...\fR
+\fIpathname\fR \fBadd\fR \fIsubwindow\fR \fIoptions...\fR
Adds a new pane to the window.
See \fBPANE OPTIONS\fR for the list of available options.
.TP
-\fIpathname \fBforget\fR \fIpane\fR
+\fIpathname\fR \fBforget\fR \fIpane\fR
Removes the specified subpane from the widget.
\fIpane\fR is either an integer index or the name of a managed subwindow.
.TP
-\fIpathname\fR \fBidentify\fR \fIx y\fR
-Returns the index of the sash at point \fIx,y\fR,
-or the empty string if \fIx,y\fR is not over a sash.
+\fIpathname\fR \fBidentify\fR \fIcomponent\fR \fIx\fR \fIy\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.
+If \fIcomponent\fR is omitted, it defaults to \fBsash\fR.
+The following subcommands are supported:
+.RS
+.TP
+\fIpathname\fR \fBidentify\fR \fBelement\fR \fIx\fR \fIy\fR
+Returns the name of the element at the specified location.
.TP
-\fIpathname \fBinsert\fR \fIpos\fR \fIsubwindow\fR \fIoptions...\fR
+\fIpathname\fR \fBidentify\fR \fBsash\fR \fIx\fR \fIy\fR
+Returns the index of the sash at the specified location.
+.RE
+.TP
+\fIpathname\fR \fBinsert\fR \fIpos\fR \fIsubwindow\fR \fIoptions...\fR
Inserts a pane at the specified position.
-\fIpos\fR is either the string \fBend\fR, an integer index,
+\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 paned window,
+If \fIsubwindow\fR is already managed by the paned window,
moves it to the specified position.
See \fBPANE OPTIONS\fR for the list of available options.
.TP
-\fIpathname \fBpane\fR \fIpane \-option \fR?\fIvalue \fR?\fI\-option value...\fR
+\fIpathname\fR \fBpane\fR \fIpane \-option \fR?\fIvalue \fR?\fI\-option value...\fR
Query or modify the options of the specified \fIpane\fR,
where \fIpane\fR is either an integer index or the name of a managed subwindow.
-If no \fI\-option\fR is specified, returns a dictionary of the pane
+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.
.TP
+\fIpathname\fR \fBpanes\fR
+Returns the list of all windows managed by the widget.
+.TP
\fIpathname\fR \fBsashpos\fR \fIindex\fR ?\fInewpos\fR?
-If \fInewpos\fR is specified, sets the position
+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
+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),