File: ButtonBox.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 (273 lines) | stat: -rw-r--r-- 9,783 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
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273

    <html>
    <head>
    <title>Pmw.ButtonBox 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.ButtonBox</h1>
    <p>
    
<dl>
<dt> <h3>Name</h3><dd>
<p>Pmw.ButtonBox() - 
    manager widget for buttons
</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 buttons.  One
    of these buttons may be specified as the default button and it
    will be displayed with an indicator ring around it.  The buttons
    may be laid out either horizontally or vertically.</p>

<p></p>


<dt> <h3>Options</h3><dd>
Options for this megawidget and its base
classes are described below.<p>
<a name=option.labelmargin></a>
<dl><dt> <strong>labelmargin
</strong><dd>
Initialisation option. If the <strong>labelpos</strong> option is not <strong>None</strong>, this specifies the
        distance between the <strong>label</strong> component and the rest of the
        megawidget. The default is <strong>0</strong>.</p>


</dt></dl>
<a name=option.labelpos></a>
<dl><dt> <strong>labelpos
</strong><dd>
Initialisation option. Specifies where to place the <strong>label</strong> component.  If not
        <strong>None</strong>, it should be a concatenation of one or two of the
        letters <strong>'n'</strong>, <strong>'s'</strong>, <strong>'e'</strong> and <strong>'w'</strong>.  The first letter
        specifies on which side of the megawidget to place the label. 
        If a second letter is specified, it indicates where on that
        side to place the label.  For example, if <strong>labelpos</strong> is <strong>'w'</strong>,
        the label is placed in the centre of the left hand side; if
        it is <strong>'wn'</strong>, the label is placed at the top of the left
        hand side; if it is <strong>'ws'</strong>, the label is placed at the
        bottom of the left hand side.</p>
<p>        If <strong>None</strong>, a label component is not created. 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 button box.  This may be
    <strong>'horizontal'</strong> or <strong>'vertical'</strong>. The default is <strong>'horizontal'</strong>.</p>


</dt></dl>
<a name=option.padx></a>
<dl><dt> <strong>padx
</strong><dd>
Initialisation option. Specifies a padding distance to leave between each button in the x
    direction and also between the buttons and the outer edge of the 
    button box. The default is <strong>8</strong>.</p>


</dt></dl>
<a name=option.pady></a>
<dl><dt> <strong>pady
</strong><dd>
Initialisation option. Specifies a padding distance to leave between each button in the y
    direction and also between the buttons and the outer edge of the
    button box. The default is <strong>8</strong>.</p>


</dt></dl>
<a name=option.ringborderwidth></a>
<dl><dt> <strong>ringborderwidth
</strong><dd>
Initialisation option. Specifies the width of the border of the ring which appears around
    the default button. The default is <strong>1</strong>.</p>


</dt></dl>
<a name=option.ringpadx></a>
<dl><dt> <strong>ringpadx
</strong><dd>
Initialisation option. Specifies a padding distance to leave in the x direction between
    each button and the default ring. The default is <strong>1</strong>.</p>


</dt></dl>
<a name=option.ringpady></a>
<dl><dt> <strong>ringpady
</strong><dd>
Initialisation option. Specifies a padding distance to leave in the y direction between
    each button and the default ring. The default is <strong>1</strong>.</p>


</dt></dl>
<dt> <h3>Components</h3><dd>
Components created by this megawidget and its base
classes are described below.<p>
<a name=component.frame></a>
<dl><dt> <strong>frame
</strong><dd>
If the <strong>label</strong> component has been created (that is, the <strong>labelpos</strong>
    option is not <strong>None</strong>), the <strong>frame</strong> component is created to act as
    the container of the buttons created by the <code>add()</code> and
    <code>insert()</code> methods.  If there is no <strong>label</strong> component, the <strong>hull</strong>
    component acts as the container. By default, this component is a Tkinter.Frame.</p>


</dt></dl>
<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>
<a name=component.label></a>
<dl><dt> <strong>label
</strong><dd>
If the <strong>labelpos</strong> option is not <strong>None</strong>, this component is
        created as a text label for the megawidget.  See the
        <strong>labelpos</strong> option for details.  Note that to set, for example,
        the <strong>text</strong> option of the label, you need use the <strong>label_text</strong>
        component option. By default, this component is a Tkinter.Label.</p>


</dt></dl>
<dt> <h3>Dynamic components</h3><dd>
<p>
        Button components are created dynamically by the <code>add()</code> and
        <code>insert()</code> methods.  By default, the buttons are of type
        Tkinter.Button and are created with a component group of
        <strong>Button</strong>.</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 button to the end of the button box as a component named
    <em>name</em>.  Any keyword arguments present will be passed to the
    constructor when creating the button.  If the <strong>text</strong> keyword
    argument is not given, the <strong>text</strong> option of the button defaults to
    <em>name</em>.  The method returns the <em>name</em> component widget.</p>


</dt></dl>
<a name=method.alignbuttons></a>
<dl><dt> <strong>alignbuttons</strong>(<em>when</em> = <strong>'later'</strong>)<dd>
Set the widths of all the buttons to be the same as the width of
    the widest button.  If <em>when</em> is <strong>later</strong>, this will occur when the
    interpreter next becomes idle, otherwise the resizing will occur
    immediately.</p>


</dt></dl>
<a name=method.delete></a>
<dl><dt> <strong>delete</strong>(<em>index</em>)<dd>
Delete the button given by <em>index</em> from the button box.  See the
    <code>index()</code> method for the format of <em>index</em>.</p>


</dt></dl>
<a name=method.index></a>
<dl><dt> <strong>index</strong>(<em>index</em>, <em>forInsert</em> = <strong>0</strong>)<dd>
Return the numerical index of the button corresponding to <em>index</em>. 
    This may be specified in any of the following forms:</p>
<dl><dt><em>number</em><dd>Specifies the button numerically, where <strong>0</strong> corresponds to
         the left (or top) button.</p>


<dt><strong>end</strong><dd>Indicates the right (or bottom) button.</p>


<dt><strong>default</strong><dd>Indicates the current default button.  This is the button
         with the default ring displayed.</p>


<dt><em>name</em><dd>Specifies the button named <em>name</em>.</p>

</dl>
<p>    If <em>forInsert</em> is set, <strong>end</strong> returns the number of buttons rather
    than the index of the last button.</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 button just before the button specified by <em>before</em>, as a
    component named <em>name</em>.  Any keyword arguments present will be
    passed to the constructor when creating the button.  See the
    <code>index()</code> method for the format of <em>before</em>.  To add a button to
    the end of the button box, use <code>add()</code>.  The method returns the
    <em>name</em> component widget.</p>


</dt></dl>
<a name=method.invoke></a>
<dl><dt> <strong>invoke</strong>(<em>index</em> = <strong>'default'</strong>, <em>noFlash</em> = <strong>0</strong>)<dd>
Invoke the callback command associated with the button specified
    by <em>index</em>.  If <em>noFlash</em> is <strong>0</strong>, flash the button to indicate to
    the user that something happened.  See the <code>index()</code> method for
    the format of <em>index</em>.</p>


</dt></dl>
<a name=method.numbuttons></a>
<dl><dt> <strong>numbuttons</strong>()<dd>
Return the number of buttons in the button box.</p>


</dt></dl>
<a name=method.setdefault></a>
<dl><dt> <strong>setdefault</strong>(<em>index</em>)<dd>
Set the default button to the button given by <em>index</em>.  This
    causes the default ring to appear around the specified button. 
    If <em>index</em> is <strong>None</strong>, there will be no default button and no
    default ring will be displayed.  See the <code>index()</code> method for the
    format of <em>index</em>.</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>