summaryrefslogtreecommitdiffstats
path: root/doc/ttk_panedwindow.n
blob: ff88473fc512fd8f1db9cc99298bf19bd6d5415f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
'\"
'\" 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.7 2007/10/22 14:33:13 dkf Exp $
'\"
.so man.macros
.TH ttk_panedwindow n 8.5 Tk "Tk Themed Widget"
.BS
.\" 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?
.br
\fIpathName \fBadd\fR \fIpathName.subwindow\fR ?\fIoptions...\fR?
\fIpathName \fBinsert\fR \fIindex\fR \fIpathName.subwindow\fR ?\fIoptions...\fR?
.fi
.BE

.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-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.
.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:
.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"
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
.
Adds a new pane to the window. \fIsubwindow\fR must be a direct child of the
paned window \fIpathname\fR. See \fBPANE OPTIONS\fR for the list of available
options.
.TP
\fIpathname \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 \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, or the name of a managed subwindow. 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
.
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 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 \fBsashpos\fR \fIindex\fR ?\fInewpos\fR?
.
If \fInewpos\fR is unspecified, returns the current position of sash number
\fIindex\fR. If \fInewpos\fR is specified, sets the position of sash number
\fIindex\fR, with the aim of making \fInewpos\fR its new position. 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; these may mean that the actual new sash position is
not what was requested.
.\" 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.
.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.

.SH "SEE ALSO"
ttk_widget(n), ttk_notebook(n), panedwindow(n)