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
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
|
<!-- manual page source format generated by RosettaMan v2.5a6, -->
<!-- available via anonymous ftp from ftp.cs.berkeley.edu:/ucb/people/phelps/tcltk/rman.tar.Z -->
<HTML>
<HEAD>
<TITLE>man page(1) manual page</TITLE>
</HEAD>
<BODY>
<A HREF="#toc">Table of Contents</A><P>
_________________________________________________________________
<P>
<H2><A NAME="sect1" HREF="#toc1"><B>NAME</B></A></H2>
scrolledcanvas - Create and manipulate scrolled canvas widgets
<P>
<H2><A NAME="sect2" HREF="#toc2"><B>SYNOPSIS</B></A></H2>
<B>scrolledcanvas</B> <I>pathName</I> ?<I>options</I>?
<P>
<H2><A NAME="sect3" HREF="#toc3"><B>INHERITANCE</B></A></H2>
itk::Widget <- Labeledwidget <- Scrolledwidget <- Scrolledcanvas
<P>
<H2><A NAME="sect4" HREF="#toc4"><B>STANDARD</B> <B>OPTIONS</B></A></H2>
<DL>
<DT><B>activeBackground</B> <DD> <B>background</B> <B>borderWidthcursor</B>
</DD>
</DL>
<DL>
<DT><B>exportSelection</B> <B>font</B> <DD> <B>foreground</B> <B>highlightColor</B>
</DD>
</DL>
<DL>
<DT><B>highlightThickness</B> <DD> <B>insertBorderWidthinsertOffTimeinsertOnTime</B>
<B>insertWidth</B> <B>relief</B> <B>selectBackgroundselectBorderWidth</B>
<B>selectForeground</B>
<P>
</DD>
</DL>
See the "options" manual entry for details on the standard
options.
<P>
<H2><A NAME="sect5" HREF="#toc5"><B>ASSOCIATED</B> <B>OPTIONS</B></A></H2>
<B>closeEnough</B> <B>confine</B> <B>scrollRegion</B> <B>xScrollIncrement</B>
<B>yScrollIncrement</B>
<P>
See the "canvas" widget manual entry for details on the
above associated options.
<P>
<B>activeRelief</B> <B>elementBorderWidth</B> <B>jumptroughColor</B>
<P>
See the "scrollbar" widget manual entry for details on the
above associated options.
<P>
<H2><A NAME="sect6" HREF="#toc6"><B>INHERITED</B> <B>OPTIONS</B></A></H2>
<DL>
<DT><B>disabledForeground</B> <DD> <B>labelBitmap</B> <B>labelFontlabelImage</B>
<B>labelMargin</B> <B>labelPos</B> <B>labelText</B> <B>labelVariable</B>
<B>state</B>
<P>
</DD>
</DL>
See the "labeledwidget" class manual entry for details on
the inherited options.
<P>
<H2><A NAME="sect7" HREF="#toc7"><B>WIDGET-SPECIFIC</B> <B>OPTIONS</B></A></H2>
<DL>
<DT>Name: <DD> <B>autoMargin</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>AutoMargin</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-automargin</B>
<P>
</DD>
</DL>
Specifies the autoresize extra margin to reserve. This
option is only effective with autoresize turned on.
The default is 10.
<P>
<DL>
<DT>Name: <DD> <B>autoResize</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>AutoResize</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-autoresize</B>
<P>
</DD>
</DL>
Automatically adjusts the scrolled region to be the
bounding box covering all the items in the canvas following
the execution of any method which creates or
destroys items. Thus, as new items are added, the
scrollbars adjust accordingly.
<P>
<DL>
<DT>Name: <DD> <B>height</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Height</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-height</B>
<P>
</DD>
</DL>
Specifies the height of the scrolled canvas widget in
any of the forms acceptable to <B>Tk_GetPixels</B>. The
default height is 30 pixels.
<P>
<DL>
<DT>Name: <DD> <B>hscrollMode</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>ScrollMode</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-hscrollmode</B>
<P>
</DD>
</DL>
Specifies the the display mode to be used for the horizontal
scrollbar: <B>static,</B> <B>dynamic,</B> or <B>none</B>. In static
mode, the scroll bar is displayed at all times.
Dynamic mode displays the scroll bar as required, and
none disables the scroll bar display. The default is
static.
<P>
<DL>
<DT>Name: <DD> <B>sbWidth</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Width</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-sbwidth</B>
<P>
</DD>
</DL>
Specifies the width of the scrollbar in any of the
forms acceptable to <B>Tk_GetPixels</B>. The default width is
15 pixels..
<P>
<DL>
<DT>Name: <DD> <B>scrollMargin</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>ScrollMargin</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-scrollmargin</B>
<P>
</DD>
</DL>
Specifies the distance between the canvas and scrollbar
in any of the forms acceptable to <B>Tk_GetPixels</B>. The
default is 3 pixels.
<P>
<DL>
<DT>Name: <DD> <B>textBackground</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Background</B>
Command-Line Switch <B>-textbackground</B>
<P>
</DD>
</DL>
Specifies the background color for the canvas. This
allows the background within the canvas to be different
from the normal background color.
<P>
<DL>
<DT>Name: <DD> <B>vscrollMode</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>ScrollMode</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-vscrollmode</B>
<P>
</DD>
</DL>
Specifies the the display mode to be used for the vertical
scrollbar: <B>static,</B> <B>dynamic,</B> or <B>none</B>. In static
mode, the scroll bar is displayed at all times.
Dynamic mode displays the scroll bar as required, and
none disables the scroll bar display. The default is
static.
<P>
<DL>
<DT>Name: <DD> <B>width</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Width</B>
</DD>
</DL>
<DL>
<DT>Command-Line Switch: <DD> <B>-width</B>
<P>
</DD>
</DL>
Specifies the width of the scrolled canvas widget in
any of the forms acceptable to <B>Tk_GetPixels</B>. The
default height is 30 pixels.<BR>
_________________________________________________________________
<P>
<H2><A NAME="sect8" HREF="#toc8"><B>DESCRIPTION</B></A></H2>
The <B>scrolledcanvas</B> command creates a scrolled canvas with
additional options to manage horizontal and vertical
scrollbars. This includes options to control which
scrollbars are displayed and the method, i.e. statically or
dynamically.
<P>
<H2><A NAME="sect9" HREF="#toc9"><B>METHODS</B></A></H2>
The <B>scrolledcanvas</B> command creates a new Tcl command whose
name is <I>pathName</I>. This command may be used to invoke various
operations on the widget. It has the following general
form:
<P>
<I>pathName</I> <I>option</I> ?<I>arg</I> <I>arg</I> ...?
<P>
<I>Option</I> and the <I>arg</I>s determine the exact behavior of the command.
The following commands are possible for scrolledcanvas
widgets:
<P>
<H2><A NAME="sect10" HREF="#toc10"><B>ASSOCIATED</B> <B>METHODS</B></A></H2>
<B>addtag</B> <B>bbox</B> <B>bind</B> <B>canvasx</B>
<B>canvasy</B> <B>coords</B> <B>create</B> <B>dchars</B>
<B>delete</B> <B>dtag</B> <B>find</B> <B>focus</B>
<B>gettags</B> <B>icursor</B> <B>index</B> <B>insert</B>
<B>itemconfigure</B> <B>lower</B> <B>move</B> <B>postscript</B>
<B>raise</B> <B>scale</B> <B>scan</B> <B>select</B>
<DL>
<DT><B>type</B> <DD> <B>xview</B> <B>yview</B>
<P>
</DD>
</DL>
See the "canvas" manual entry for details on the associated
methods.
<P>
<H2><A NAME="sect11" HREF="#toc11"><B>WIDGET-SPECIFIC</B> <B>METHODS</B></A></H2>
<I>pathName</I> <B>cget</B> <I>option</I><BR>
Returns the current value of the configuration option
given by <I>option</I>. <I>Option</I> may have any of the values
accepted by the <B>scrolledcanvas</B> command.
<P>
<I>pathName</I> <B>childsite</B><BR>
Returns the child site widget path name.
<P>
<I>pathName</I> <B>configure</B> ?<I>option</I>? ?<I>value</I> <I>option</I> <I>value</I> ...?
Query or modify the configuration options of the
widget. If no <I>option</I> is specified, returns a list
describing all of the available options for <I>pathName</I>
(see <B>Tk_ConfigureInfo</B> for information on the format of
this list). If <I>option</I> is specified with no <I>value</I>, then
the command returns a list describing the one named
option (this list will be identical to the corresponding
sublist of the value returned if no <I>option</I> is
specified). If one or more <I>option</I> - <I>value</I> pairs are
specified, then the command modifies the given widget
option(s) to have the given value(s); in this case the
command returns an empty string. <I>Option</I> may have any
of the values accepted by the <B>scrolledcanvas</B> command.
<P>
<I>pathName</I> <B>justify</B> <I>direction</I><BR>
Justifies the canvas contents via the scroll bars in
one of four directions: <B>left</B>, <B>right</B>, <B>top</B>, or <B>bottom</B>.
<P>
<H2><A NAME="sect12" HREF="#toc12"><B>COMPONENTS</B></A></H2>
<DL>
<DT>Name: <DD> <B>canvas</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Canvas</B>
<P>
</DD>
</DL>
The canvas component is the canvas widget. See the
"canvas" widget manual entry for details on the canvas
component item.
<P>
<DL>
<DT>Name: <DD> <B>horizsb</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Scrollbar</B>
<P>
</DD>
</DL>
The horizsb component is the horizontal scroll bar.
See the "ScrollBar" widget manual entry for details on
the horizsb component item.
<P>
<DL>
<DT>Name: <DD> <B>vertsb</B>
</DD>
</DL>
<DL>
<DT>Class: <DD> <B>Scrollbar</B>
<P>
</DD>
</DL>
The vertsb component is the vertical scroll bar. See
the "ScrollBar" widget manual entry for details on the
vertsb component item.
<P>
<H2><A NAME="sect13" HREF="#toc13"><B>EXAMPLE</B></A></H2>
scrolledcanvas .sc
<P>
<DL>
<DT>.sc create rectangle 100 100 400 400 -fill red<DD>
.sc create rectangle 300 300 600 600 -fill green
.sc create rectangle 200 200 500 500 -fill blue
<P>
</DD>
</DL>
pack .sc -padx 10 -pady 10 -fill both -expand yes
<P>
<H2><A NAME="sect14" HREF="#toc14"><B>AUTHOR</B></A></H2>
Mark L. Ulferts
<P>
<H2><A NAME="sect15" HREF="#toc15"><B>KEYWORDS</B></A></H2>
scrolledcanvas, canvas, widget
<P>
<HR><P>
<A NAME="toc"><B>Table of Contents</B></A><P>
<UL>
<LI><A NAME="toc1" HREF="#sect1">NAME</A></LI>
<LI><A NAME="toc2" HREF="#sect2">SYNOPSIS</A></LI>
<LI><A NAME="toc3" HREF="#sect3">INHERITANCE</A></LI>
<LI><A NAME="toc4" HREF="#sect4">STANDARD OPTIONS</A></LI>
<LI><A NAME="toc5" HREF="#sect5">ASSOCIATED OPTIONS</A></LI>
<LI><A NAME="toc6" HREF="#sect6">INHERITED OPTIONS</A></LI>
<LI><A NAME="toc7" HREF="#sect7">WIDGET-SPECIFIC OPTIONS</A></LI>
<LI><A NAME="toc8" HREF="#sect8">DESCRIPTION</A></LI>
<LI><A NAME="toc9" HREF="#sect9">METHODS</A></LI>
<LI><A NAME="toc10" HREF="#sect10">ASSOCIATED METHODS</A></LI>
<LI><A NAME="toc11" HREF="#sect11">WIDGET-SPECIFIC METHODS</A></LI>
<LI><A NAME="toc12" HREF="#sect12">COMPONENTS</A></LI>
<LI><A NAME="toc13" HREF="#sect13">EXAMPLE</A></LI>
<LI><A NAME="toc14" HREF="#sect14">AUTHOR</A></LI>
<LI><A NAME="toc15" HREF="#sect15">KEYWORDS</A></LI>
</UL>
</BODY></HTML>
|
