File: PanedWidget.html

package info (click to toggle)
python-pmw 0.6.2-0.1
  • links: PTS
  • area: main
  • in suites: hamm
  • size: 1,652 kB
  • ctags: 2,716
  • sloc: python: 10,720; makefile: 44; sh: 24
file content (197 lines) | stat: -rw-r--r-- 6,824 bytes parent folder | download
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
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197

    <html>
    <head>
    <title>Pmw.PanedWidget reference manual</title>
    </head>

    <body bgcolor="#ffffff" text="#000000" link="#0000ee"
	vlink="551a8b" alink="ff0000">

    <center><P ALIGN="CENTER">
    <IMG SRC = transdove.gif ALT = "" WIDTH=70 HEIGHT=75>
    <IMG SRC = transdove.gif ALT = "" WIDTH=70 HEIGHT=75>
    <IMG SRC = transdove.gif ALT = "" WIDTH=70 HEIGHT=75>
    </p></center>

    <h1 ALIGN="CENTER">Pmw.PanedWidget</h1>
    <p>
    
<dl>
<dt> <h3>Name</h3><dd>
<p>Pmw.PanedWidget() - 
    frame subdivided into several resizable panes
</p>


<dt> <h3>Inherits</h3><dd>
<a href="MegaWidget.html">Pmw.MegaWidget</a><br>
<dt> <h3>Description</h3><dd>
<p>
    This class creates a manager widget for containing resizable
    frames, known as panes.  Each pane may act as the container for
    other widgets.  The user may resize the panes by dragging a small
    rectangle (the handle) or the line between the panes (the separator).</p>

<p></p>


<dt> <h3>Options</h3><dd>
Options for this megawidget and its base
classes are described below.<p>
<a name=option.command></a>
<dl><dt> <strong>command
</strong><dd>
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 <strong>vertical</strong>
    orientation, the size is the height of the panes.  For
    <strong>horizontal</strong> orientation, the size is the width of the panes. The default is <strong>None</strong>.</p>


</dt></dl>
<a name=option.orient></a>
<dl><dt> <strong>orient
</strong><dd>
Initialisation option. Specifies the orientation of the paned widget.  This may be
    <strong>'horizontal'</strong> or <strong>'vertical'</strong>.  If <strong>'vertical'</strong>, the panes are
    stacked above and below each other, otherwise the panes are laid
    out side by side. The default is <strong>'vertical'</strong>.</p>


</dt></dl>
<a name=option.separatorrelief></a>
<dl><dt> <strong>separatorrelief
</strong><dd>
Initialisation option. Specifies the relief of the line separating the panes. The default is <strong>'sunken'</strong>.</p>


</dt></dl>
<dt> <h3>Pane options</h3><dd>
<p>
        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, which specifies a pane size proportional to the
        size of the entire paned widget.</p>

<dl><dt><strong>size</strong><dd>Specifies the initial size of the pane.  The default is <strong>0</strong>.</p>


<dt><strong>min</strong><dd>Specifies the minimum size of the pane.  The default is <strong>0</strong>.</p>


<dt><strong>max</strong><dd>Specifies the maximum size of the pane.  The default is a
            very large number.</p>
<p>        </p>


</dl>

<dt> <h3>Components</h3><dd>
Components created by this megawidget and its base
classes are described below.<p>
<a name=component.hull></a>
<dl><dt> <strong>hull
</strong><dd>
This acts as the body for the entire megawidget.  Other components
    are created as children of the hull to further specialise the
    widget. By default, this component is a Tkinter.Frame.</p>


</dt></dl>
<dt> <h3>Dynamic components</h3><dd>
<p>
        Frame, separator and handle components are created dynamically
        by the <code>add()</code> method.  The components are of type
        Tkinter.Frame and are created with component groups of
        <strong>Frame</strong>, <strong>Separator</strong> and <strong>Handle</strong> respectively.</p>
<p>        </p>



<a name=methods></a>
<dt> <h3>Methods</h3><dd>
Only methods specific to this megawidget are described below.
For a description of its inherited methods, see the
manuals for its base classes.
<p>
<a name=method.add></a>
<dl><dt> <strong>add</strong>(<em>name</em>, **<em>kw</em>)<dd>
Add a pane to the end of the paned widget using the component name
    <em>name</em>.  This is equivalent to calling <code>insert()</code> with <em>before</em>
    set to the current number of panes.  The method returns the <em>name</em>
    component widget.</p>


</dt></dl>
<a name=method.configurepane></a>
<dl><dt> <strong>configurepane</strong>(<em>name</em>, **<em>kw</em>)<dd>
Configure the pane specified by <em>name</em>, where <em>name</em> 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 <strong>Pane options</strong> section.</p>


</dt></dl>
<a name=method.insert></a>
<dl><dt> <strong>insert</strong>(<em>name</em>, <em>before</em> = <strong>0</strong>, **<em>kw</em>)<dd>
Add a pane just before (that is, to the left of or above) the pane
    specified by <em>before</em>, where <em>before</em> is 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
    <strong>Pane options</strong> section.  To add a pane to the end of the paned
    widget, use <code>add()</code>.</p>
<p>    The new pane is created as a Tkinter.Frame component named <em>name</em>. 
    If this is not the only pane, a separator and handle are also
    created as components named <strong>separator</strong>-<em>n</em> and <strong>handle</strong>-<em>n</em>,
    where <em>n</em> is the index of the new pane (a number between 0 and one
    less than the number of panes).  The method returns the <em>name</em>
    component widget.</p>



</dt></dl>
<a name=method.pane></a>
<dl><dt> <strong>pane</strong>(<em>name</em>)<dd>
Return the Tkinter.Frame pane widget for the pane specified by
    <em>name</em>, where <em>name</em> is either an integer, specifying the index of
    the pane, or a string, specifying the name of the pane.</p>


</dt></dl>
<a name=method.panes></a>
<dl><dt> <strong>panes</strong>()<dd>
Return a list of the names of the panes, in display order.</p>


</dt></dl>
<a name=method.remove></a>
<dl><dt> <strong>remove</strong>(<em>name</em>)<dd>
Remove the pane specified by <em>name</em>, where <em>name</em> is either an
    integer, specifying the index of the pane, or a string, specifying
    the name of the pane.</p>


</dt></dl>
</dl>

    <center><P ALIGN="CENTER">
    <IMG SRC = blue_line.gif ALT = "" WIDTH=320 HEIGHT=5>
    </p></center>
    

    <font size=-1>
    <center><P ALIGN="CENTER">
    <a href="index.html">Home</a>. 
    Pmw 0.6.2
    Maintainer
    <a href="mailto:gregm@iname.com">gregm@iname.com</a>.
    23 Feb 1998
    </p></center>
    </font>

    </body>
    </html>