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
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
|
complete = 1
reviewdate = "14 April 2001"
name = """
frame subdivided into several resizable panes
"""
description = """
A paned widget is a container megawidget which manages a number of
resizable frames, known as panes. Each pane may act as the container for
other widgets. The user may interactively resize the panes by
dragging a small rectangle (the handle) or the line between the
panes (the separator). The panes may be arranged horizontally or
vertically. Each pane may have maximum and minimum limits of its
size.
"""
sections = (
('Dynamic components', 1, 'Components',
"""
Frame, separator and handle components are created dynamically
by the /add()/ and /insert()/ methods. The components are of type
tkinter.Frame and are created with component groups of
*Frame*, *Separator* and *Handle* respectively.
"""
),
('Pane options', 1, 'Options',
"""
Each pane has the following options. These may be set when
creating or configuring a pane. The value of each option may
be an integer, which specifies a pane size in pixels, or a
real number between 0.0 and 1.0, which specifies a pane size
proportional to the size of the entire paned widget.
*size* -- Specifies the initial size of the pane. The default is *0*.
*min* -- Specifies the minimum size of the pane. The default is *0*.
*max* -- Specifies the maximum size of the pane. The default is a
very large number.
"""
),
)
text = {}
text['options'] = {}
text['options']['command'] = """
Specifies a function to be called whenever the size of any of the
panes changes. The function is called with a single argument,
being a list of the sizes of the panes, in order. For *vertical*
orientation, the size is the height of the panes. For
*horizontal* orientation, the size is the width of the panes.
"""
text['options']['handlesize'] = """
Specifies the size in pixels of the square handle which appears on
the lines separating the panes.
"""
text['options']['orient'] = """
Specifies the orientation of the paned widget. This may be
*'horizontal'* or *'vertical'*. If *'vertical'*, the panes are
stacked above and below each other, otherwise the panes are laid
out side by side.
"""
text['options']['separatorrelief'] = """
Specifies the relief of the lines separating the panes.
"""
text['options']['separatorthickness'] = """
Specifies the thickness of the lines separating the panes.
"""
text['components'] = {}
text['methods'] = {}
text['methods']['add'] = """
Add a pane to the end of the paned widget as a component named
'name'. This is equivalent to calling /insert()/ with 'before'
set to the current number of panes. The method returns the 'name'
component widget.
"""
text['methods']['configurepane'] = """
Configure the pane specified by 'name', where 'name' is either an
integer, specifying the index of the pane, or a string, specifying
the name of the pane. The keyword arguments specify the new
values for the options for the pane. These options are described
in the *Pane options* section.
"""
text['methods']['insert'] = """
Add a pane to the paned widget as a component named 'name'. The
pane is added just before the pane specified by 'before', where
'before' may be either an integer, specifying the index of the
pane, or a string, specifying the name of the pane. The keyword
arguments specify the initial values for the options for the new
pane. These options are described in the *Pane options* section.
To add a pane to the end of the paned widget, use /add()/.
The new pane is created as a tkinter.Frame component named 'name'.
If this is not the only pane, a separator and handle are also
created as components named *separator*-'n' and *handle*-'n',
where 'n' is one less than the number of panes. The method
returns the 'name' component widget.
"""
text['methods']['pane'] = """
Return the tkinter.Frame pane widget for the pane specified by
'name', where 'name' is either an integer, specifying the index of
the pane, or a string, specifying the name of the pane.
"""
text['methods']['panes'] = """
Return a list of the names of the panes, in display order.
"""
text['methods']['delete'] = """
Delete the pane specified by 'name', where 'name' is either an
integer, specifying the index of the pane, or a string, specifying
the name of the pane.
If the pane deleted was not the only pane in the paned widget,
also delete the separator and handle components named
*separator*-'n' and *handle*-'n', where 'n' is the number of
panes remaining.
"""
text['methods']['move'] = """
Move the pane specified by 'name' to the new position specified by
'newPos'. The first two arguments may be either an integer,
specifying the index of the pane, or a string, specifying the name
of the pane. If 'newPosOffset' is specified, it is added to the
'newPos' index. For example, to move a horizontal pane one pane
to the left, specify the name or index of the pane for both 'name'
and 'newPos' and specify *-1* for 'newPosOffset'.
"""
text['methods']['setnaturalsize'] = """
If oriented horizontally, set the width of the paned widget to the
sum of the requested widths of all panes and set the height to the
maximum requested height of all panes.
If oriented vertically, set the height of the paned widget to the
sum of the requested heights of all panes and set the width to the
maximum requested width of all panes.
"""
text['methods']['updatelayout'] = """
Recalculate size and position of panes. This method must be
called after adding or deleting one or more panes. However it
does not need to be called when panes are first added to a newly
created paned widget, before it has been displayed.
"""
|
