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
|
complete = 1
reviewdate = "30 August 1998"
name = """
text widget with optional scrollbars
"""
description = """
A scrolled text consists of a standard text widget with optional
scrollbars which can be used to scroll the text. The
scrollbars can be 'dynamic', 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. If it is displayed,
the horizontal scrollbar is under the text widget. Similarly, if
it is displayed, the vertical scrollbar is to the right of the
text widget.
Row and column headers may also be displayed, which scroll in sync
with the text widget and may be useful when displaying tabular
data. To assist in ensuring that columns line up when using a
column header, a fixed width font should be used.
"""
text = {}
text['options'] = {}
text['options']['borderframe'] = """
If true, the *borderframe* component will be created.
"""
text['options']['columnheader'] = """
If true, the *columnheader* component will be created.
"""
text['options']['rowcolumnheader'] = """
If true, the *rowcolumnheader* component will be created.
"""
text['options']['rowheader'] = """
If true, the *rowheader* component will be created.
"""
text['options']['hscrollmode'] = """
The horizontal scroll mode. If *'none'*, the horizontal scrollbar
will never be displayed. If *'static'*, the scrollbar will always
be displayed. If *'dynamic'*, the scrollbar will be displayed
only if necessary.
"""
text['options']['scrollmargin'] = """
The distance between the scrollbars and the text widget.
"""
text['options']['usehullsize'] = """
If true, the size of the megawidget is determined solely by the
width and height options of the *hull* component.
Otherwise, the size of the megawidget is determined by the width
and height of the *text* 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.
"""
text['options']['vscrollmode'] = """
The vertical scroll mode. If *'none'*, the vertical scrollbar
will never be displayed. If *'static'*, the scrollbar will always
be displayed. If *'dynamic'*, the scrollbar will be displayed
only if necessary.
"""
text['components'] = {}
text['components']['borderframe'] = """
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.
"""
text['components']['columnheader'] = """
A text widget with a default height of 1 displayed above the main
text widget and which scrolls horizontally in sync with the
horizontal scrolling of the main text widget.
"""
text['components']['rowcolumnheader'] = """
A text widget displayed to the top left of the main text widget,
above the row header and to the left of the column header if they
exist. The widget is not scrolled automatically.
"""
text['components']['rowheader'] = """
A text widget displayed to the left of the main text widget and
which scrolls vertically in sync with the vertical scrolling of
the main text widget.
"""
text['components']['horizscrollbar'] = """
The horizontal scrollbar.
"""
text['components']['text'] = """
The text widget which is scrolled by the scrollbars. If the
*borderframe* option is true, this is created with a borderwidth
of *0* 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.
"""
text['components']['vertscrollbar'] = """
The vertical scrollbar.
"""
text['methods'] = {}
text['methods']['bbox'] = """
This method is explicitly forwarded to the *text* component's
/bbox()/ method. Without this explicit forwarding, the /bbox()/
method (aliased to /grid_bbox()/) of the *hull* would be invoked,
which is probably not what the programmer intended.
"""
text['methods']['clear'] = """
Delete all text from the *text* component.
"""
text['methods']['exportfile'] = """
Write the contents of the *text* component to the file 'fileName'.
"""
text['methods']['get'] = """
This is the same as the /get()/ method of the *text* component,
except that if 'first' is *None* the entire
contents of the text widget are returned.
"""
text['methods']['getvalue'] = """
Return the entire contents of the text widget.
"""
text['methods']['setvalue'] = """
Replace the entire contents of the *text* component with 'text'.
"""
text['methods']['importfile'] = """
Read the contents of the file 'fileName' and insert into the
*text* component at the position given by 'where'.
"""
text['methods']['settext'] = """
Same as /setvalue()/ method.
"""
text['methods']['appendtext'] = """
Add 'text' to the end of the *text* component. Scroll to the
bottom of the text, but only if it was already visible before the
new text was added.
"""
|
