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
|
'\"
'\" Copyright (c) 1995 DSC Technologies Corporation
'\"
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
'\" @(#) ScrolledListBox.n 1.21 94/12/17 16:04:44
'\"
.so man.macros
.HS iwidgets::scrolledcanvas iwid
.BS
'\" Note: do not modify the .SH NAME line immediately below!
.SH NAME
iwidgets::scrolledcanvas \- Create and manipulate scrolled canvas widgets
.SH SYNOPSIS
\fBiwidgets::scrolledcanvas\fI \fIpathName \fR?\fIoptions\fR?
.SH "INHERITANCE"
itk::Widget <- iwidgets::Labeledwidget <- iwidgets::Scrolledwidget <- iwidgets::Scrolledcanvas
.SH "STANDARD OPTIONS"
.LP
.nf
.ta 4c 8c 12c
\fB
activeBackground background borderWidth cursor
exportSelection font foreground highlightColor
highlightThickness insertBorderWidth insertOffTime insertOnTime
insertWidth relief selectBackground selectBorderWidth
selectForeground\fR
.fi
.LP
See the "options" manual entry for details on the standard options.
.SH "ASSOCIATED OPTIONS"
.LP
.nf
.ta 4c 8c 12c
\fBcloseEnough\fR \fBconfine\fR \fBscrollRegion\fR \fBxScrollIncrement\fR
\fByScrollIncrement\fR
.fi
.LP
See the "canvas" widget manual entry for details on the above
associated options.
.LP
.nf
.ta 4c 8c 12c
\fBactiveRelief\fR \fBelementBorderWidth\fR \fBjump\fR \fBtroughColor\fR
.fi
.LP
See the "scrollbar" widget manual entry for details on the above
associated options.
.SH "INHERITED OPTIONS"
.LP
.nf
.ta 4c 8c 12c
\fBdisabledForeground\fR \fBlabelBitmap\fR \fBlabelFont\fR \fBlabelImage\fR
\fBlabelMargin\fR \fBlabelPos\fR \fBlabelText\fR \fBlabelVariable\fR
\fBstate\fR \fBsticky\fR
.fi
.LP
See the "labeledwidget" class manual entry for details on the inherited options.
.SH "WIDGET-SPECIFIC OPTIONS"
.LP
.nf
Name: \fBautoMargin\fR
Class: \fBAutoMargin\fR
Command-Line Switch: \fB-automargin\fR
.fi
.IP
Specifies the autoresize extra margin to reserve. This option is only
effective with autoresize turned on. The default is 10.
.LP
.nf
Name: \fBautoResize\fR
Class: \fBAutoResize\fR
Command-Line Switch: \fB-autoresize\fR
.fi
.IP
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.
.LP
.nf
Name: \fBheight\fR
Class: \fBHeight\fR
Command-Line Switch: \fB-height\fR
.fi
.IP
Specifies the height of the scrolled canvas widget in any of the forms
acceptable to \fBTk_GetPixels\fR. The default height is 30 pixels.
.LP
.nf
Name: \fBhscrollMode\fR
Class: \fBScrollMode\fR
Command-Line Switch: \fB-hscrollmode\fR
.fi
.IP
Specifies the the display mode to be used for the horizontal
scrollbar: \fBstatic, dynamic,\fR or \fBnone\fR. 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.
.LP
.nf
Name: \fBsbWidth\fR
Class: \fBWidth\fR
Command-Line Switch: \fB-sbwidth\fR
.fi
.IP
Specifies the width of the scrollbar in any of the forms acceptable
to \fBTk_GetPixels\fR. The default width is 15 pixels..
.LP
.nf
Name: \fBscrollMargin\fR
Class: \fBScrollMargin\fR
Command-Line Switch: \fB-scrollmargin\fR
.fi
.IP
Specifies the distance between the canvas and scrollbar in any of the
forms acceptable to \fBTk_GetPixels\fR. The default is 3 pixels.
.LP
.nf
Name: \fBtextBackground\fR
Class: \fBBackground\fR
Command-Line Switch \fB-textbackground\fR
.fi
.IP
Specifies the background color for the canvas. This allows the background
within the canvas to be different from the normal background color.
.LP
.nf
Name: \fBvscrollMode\fR
Class: \fBScrollMode\fR
Command-Line Switch: \fB-vscrollmode\fR
.fi
.IP
Specifies the the display mode to be used for the vertical
scrollbar: \fBstatic, dynamic,\fR or \fBnone\fR. 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.
.LP
.nf
Name: \fBwidth\fR
Class: \fBWidth\fR
Command-Line Switch: \fB-width\fR
.fi
.IP
Specifies the width of the scrolled canvas widget in any of the forms
acceptable to \fBTk_GetPixels\fR. The default height is 30 pixels.
.BE
.SH DESCRIPTION
.PP
The \fBiwidgets::scrolledcanvas\fR 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.
.SH "METHODS"
.PP
The \fBiwidgets::scrolledcanvas\fR command creates a new Tcl command whose
name is \fIpathName\fR. This
command may be used to invoke various
operations on the widget. It has the following general form:
.DS C
\fIpathName option \fR?\fIarg arg ...\fR?
.DE
\fIOption\fR and the \fIarg\fRs
determine the exact behavior of the command. The following
commands are possible for scrolledcanvas widgets:
.SH "ASSOCIATED METHODS"
.LP
.nf
.ta 4c 8c 12c
\fBaddtag\fR \fBbbox\fR \fBbind\fR \fBcanvasx\fR
\fBcanvasy\fB \fBcoords\fR \fBcreate\fR \fBdchars\fR
\fBdelete\fR \fBdtag\fR \fBfind\fR \fBfocus\fR
\fBgettags\fR \fBicursor\fR \fBindex\fR \fBinsert\fR
\fBitemconfigure\fR \fBlower\fR \fBmove\fR \fBpostscript\fR
\fBraise\fR \fBscale\fR \fBscan\fR \fBselect\fR
\fBtype\fR \fBxview\fR \fByview\fR
.fi
.LP
See the "canvas" manual entry for details on the associated methods.
.SH "WIDGET-SPECIFIC METHODS"
.TP
\fIpathName \fBcget\fR \fIoption\fR
Returns the current value of the configuration option given
by \fIoption\fR.
\fIOption\fR may have any of the values accepted by the \fBiwidgets::scrolledcanvas\fR
command.
.TP
\fIpathName \fBchildsite\fR
Returns the child site widget path name.
.TP
\fIpathName\fR \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
Query or modify the configuration options of the widget.
If no \fIoption\fR is specified, returns a list describing all of
the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
information on the format of this list). If \fIoption\fR is specified
with no \fIvalue\fR, 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 \fIoption\fR is specified). If
one or more \fIoption\-value\fR 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.
\fIOption\fR may have any of the values accepted by the \fBiwidgets::scrolledcanvas\fR
command.
.TP
\fIpathName \fBjustify \fIdirection\fR
Justifies the canvas contents via the scroll bars in one of four directions:
\fBleft\fR, \fBright\fR, \fBtop\fR, or \fBbottom\fR.
.SH "COMPONENTS"
.LP
.nf
Name: \fBcanvas\fR
Class: \fBCanvas\fR
.fi
.IP
The canvas component is the canvas widget. See the "canvas" widget
manual entry for details on the canvas component item.
.LP
.nf
Name: \fBhorizsb\fR
Class: \fBScrollbar\fR
.fi
.IP
The horizsb component is the horizontal scroll bar. See the "ScrollBar"
widget manual entry for details on the horizsb component item.
.LP
.nf
Name: \fBvertsb\fR
Class: \fBScrollbar\fR
.fi
.IP
The vertsb component is the vertical scroll bar. See the "ScrollBar" widget
manual entry for details on the vertsb component item.
.fi
.SH EXAMPLE
.DS
package require Iwidgets 4.0
iwidgets::scrolledcanvas .sc
.sc create rectangle 100 100 400 400 -fill red
.sc create rectangle 300 300 600 600 -fill green
.sc create rectangle 200 200 500 500 -fill blue
pack .sc -padx 10 -pady 10 -fill both -expand yes
.DE
.SH AUTHOR
Mark L. Ulferts
.SH KEYWORDS
scrolledcanvas, canvas, widget
|
