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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
|
<html>
<head>
<meta name="description" content="Pmw - a toolkit for building high-level compound widgets in Python">
<meta name="content" content="python, megawidget, mega widget, compound widget, gui, tkinter">
<title>Pmw.ScrolledText reference manual</title>
</head>
<body bgcolor="#ffffff" text="#000000" link="#0000ee"
vlink="551a8b" alink="ff0000">
<h1 ALIGN="CENTER">Pmw.ScrolledText</h1>
<p>
<center><IMG SRC=ScrolledText.gif ALT="" WIDTH=382 HEIGHT=246></center>
<dl>
<dt> <h3>Name</h3><dd>
<p>Pmw.ScrolledText() -
text widget with optional scrollbars
</p>
<dt> <h3>Inherits</h3><dd>
<a href="MegaWidget.html">Pmw.MegaWidget</a><br>
<dt> <h3>Description</h3><dd>
<p>
This megawidget consists of a standard text widget with optional
scrollbars which can be used to scroll the text widget. The
scrollbars can be <em>dynamic</em>, which means that a scrollbar will
only be displayed if it is necessary. That is, if the text widget
does not contain enough text (either horizontally or vertically),
the scrollbar will be automatically hidden.</p>
<p></p>
<dt> <h3>Options</h3><dd>
Options for this megawidget and its base
classes are described below.<p>
<a name=option.borderframe></a>
<dl><dt> <strong>borderframe
</strong><dd>
Initialisation option. If true, the <strong>borderframe</strong> component will be created. The default is <strong>0</strong>.</p>
</dt></dl>
<a name=option.hscrollmode></a>
<dl><dt> <strong>hscrollmode
</strong><dd>
The horizontal scroll mode. If <strong>'none'</strong>, the horizontal scrollbar
will never be displayed. If <strong>'static'</strong>, the scrollbar will always
be displayed. If <strong>'dynamic'</strong>, the scrollbar will be displayed
only if necessary. The default is <strong>'dynamic'</strong>.</p>
</dt></dl>
<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 center 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.scrollmargin></a>
<dl><dt> <strong>scrollmargin
</strong><dd>
Initialisation option. The distance between the scrollbars and the text widget. The default is <strong>2</strong>.</p>
</dt></dl>
<a name=option.usehullsize></a>
<dl><dt> <strong>usehullsize
</strong><dd>
Initialisation option. If true, the size of the megawidget is determined solely by the
width and height options of the <strong>hull</strong> component.</p>
<p> Otherwise, the size of the megawidget is determined by the width
and height of the <strong>text</strong> component, along with the size and/or
existence of the other components, such as the label, the
scrollbars and the scrollmargin option. All these affect the
overall size of the megawidget. The default is <strong>0</strong>.</p>
</dt></dl>
<a name=option.vscrollmode></a>
<dl><dt> <strong>vscrollmode
</strong><dd>
The vertical scroll mode. If <strong>'none'</strong>, the vertical scrollbar
will never be displayed. If <strong>'static'</strong>, the scrollbar will always
be displayed. If <strong>'dynamic'</strong>, the scrollbar will be displayed
only if necessary. The default is <strong>'dynamic'</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.borderframe></a>
<dl><dt> <strong>borderframe
</strong><dd>
A frame widget which snuggly fits around the text widget, to give
the appearance of a text border. It is created with a border so
that the text widget, which is created without a border, looks
like it has a border. By default, this component is a Tkinter.Frame.</p>
</dt></dl>
<a name=component.horizscrollbar></a>
<dl><dt> <strong>horizscrollbar
</strong><dd>
The horizontal scrollbar. By default, this component is a Tkinter.Scrollbar. Its component group is <strong>Scrollbar</strong>.</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 to use the <strong>label_text</strong>
component option. By default, this component is a Tkinter.Label.</p>
</dt></dl>
<a name=component.text></a>
<dl><dt> <strong>text
</strong><dd>
The text widget which is scrolled by the scrollbars. If the
<strong>borderframe</strong> option is true, this is created with a borderwidth
of <strong>0</strong> to overcome a known problem with text widgets: if a widget
inside a text widget extends across one of the edges of the text
widget, then the widget obscures the border of the text widget.
Therefore, if the text widget has no border, then this overlapping
does not occur. By default, this component is a Tkinter.Text.</p>
</dt></dl>
<a name=component.vertscrollbar></a>
<dl><dt> <strong>vertscrollbar
</strong><dd>
The vertical scrollbar. By default, this component is a Tkinter.Scrollbar. Its component group is <strong>Scrollbar</strong>.</p>
</dt></dl>
<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.
In addition, methods from the
<strong>Tkinter.Text</strong> class
are forwarded by this megawidget to the
<strong>text</strong> component.
<p>
<a name=method.bbox></a>
<dl><dt> <strong>bbox</strong>(<em>index</em>)<dd>
This method is explicitly forwarded to the <strong>text</strong> component's
<code>bbox()</code> method. Without this explicit forwarding, the <code>bbox()</code>
method (aliased to <code>grid_bbox()</code>) of the <strong>hull</strong> would be invoked,
which is probably not what the programmer intended.</p>
</dt></dl>
<a name=method.clear></a>
<dl><dt> <strong>clear</strong>()<dd>
Delete all text from the <strong>text</strong> component.</p>
</dt></dl>
<a name=method.exportfile></a>
<dl><dt> <strong>exportfile</strong>(<em>fileName</em>)<dd>
Write the contents of the <strong>text</strong> component to the file <em>fileName</em>.</p>
</dt></dl>
<a name=method.get></a>
<dl><dt> <strong>get</strong>(<em>first</em> = <strong>None</strong>, <em>last</em> = <strong>None</strong>)<dd>
This is the same as the <code>get()</code> method of the <strong>text</strong> component,
except that if <em>first</em> is <strong>None</strong> the entire
contents of the text widget are returned.</p>
</dt></dl>
<a name=method.importfile></a>
<dl><dt> <strong>importfile</strong>(<em>fileName</em>, <em>where</em> = <strong>'end'</strong>)<dd>
Read the contents of the file <em>fileName</em> and insert into the
<strong>text</strong> component at the position given by <em>where</em>.</p>
</dt></dl>
<a name=method.settext></a>
<dl><dt> <strong>settext</strong>(<em>text</em>)<dd>
Replace the entire contents of the <strong>text</strong> component with <em>text</em>.</p>
</dt></dl>
<dt> <h3>Example</h3><dd>
The image at the top of this manual is a snapshot
of the window (or part of the window) produced
by the following code.<p>
<pre>
class Demo:
def __init__(self, parent):
# Create the ScrolledText.
self.st = Pmw.ScrolledText(parent,
borderframe = 1,
labelpos = 'n',
label_text='ScrolledText.py',
usehullsize = 1,
hull_width = 400,
hull_height = 300,
text_padx = 10,
text_pady = 10,
text_wrap='none'
)
# Create a group widget to contain the scrollmode options.
w = Pmw.Group(parent, tag_text='Scroll mode')
w.pack(side = 'bottom', padx = 5, pady = 5)
hmode = Pmw.OptionMenu(w.interior(),
labelpos = 'w',
label_text = 'Horizontal:',
items = ['none', 'static', 'dynamic'],
command = self.sethscrollmode,
menubutton_width = 8,
)
hmode.pack(side = 'left', padx = 5, pady = 5)
hmode.invoke('dynamic')
vmode = Pmw.OptionMenu(w.interior(),
labelpos = 'w',
label_text = 'Vertical:',
items = ['none', 'static', 'dynamic'],
command = self.setvscrollmode,
menubutton_width = 8,
)
vmode.pack(side = 'left', padx = 5, pady = 5)
vmode.invoke('dynamic')
# Pack this last so that the buttons do not get shrunk when
# the window is resized.
self.st.pack(padx = 5, pady = 5, fill = 'both', expand = 1)
# Read this file into the text widget.
head, tail = os.path.split(sys.argv[0])
self.st.importfile(os.path.join(head,'ScrolledText.py'))
self.st.insert('end', '\nThis demonstrates how to\n' +
'add a window to a text widget: ')
counter = Pmw.Counter(self.st.component('text'),
entryfield_value = 9999)
self.st.window_create('end', window = counter)
def sethscrollmode(self, tag):
self.st.configure(hscrollmode = tag)
def setvscrollmode(self, tag):
self.st.configure(vscrollmode = tag)
</pre>
</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.8.5
Maintainer
<a href="mailto:gregm@iname.com">gregm@iname.com</a>.
9 Feb 2001
<br>Manual page last reviewed: 30 August 1998
</p></center>
</font>
</body>
</html>
|
