| 1 |
578 |
markom |
<HTML>
|
| 2 |
|
|
<HEAD>
|
| 3 |
|
|
<TITLE>iwidgets2.2.0 User Commands - scrolledframe</TITLE>
|
| 4 |
|
|
</HEAD>
|
| 5 |
|
|
<BODY BGCOLOR="#FFFFFF">
|
| 6 |
|
|
<H1>iwidgets2.2.0 User Commands - scrolledframe</H1>
|
| 7 |
|
|
<HR>
|
| 8 |
|
|
<PRE>
|
| 9 |
|
|
|
| 10 |
|
|
</PRE>
|
| 11 |
|
|
<H2><HR ALIGN=LEFT WIDTH=70% SIZE=3></H2><PRE>
|
| 12 |
|
|
|
| 13 |
|
|
|
| 14 |
|
|
</PRE>
|
| 15 |
|
|
<H2>NAME</H2><PRE>
|
| 16 |
|
|
scrolledframe - Create and manipulate scrolled frame widgets
|
| 17 |
|
|
|
| 18 |
|
|
|
| 19 |
|
|
</PRE>
|
| 20 |
|
|
<H2>SYNOPSIS</H2><PRE>
|
| 21 |
|
|
<STRONG>scrolledframe</STRONG> <EM>pathName</EM> ?<EM>options</EM>?
|
| 22 |
|
|
|
| 23 |
|
|
|
| 24 |
|
|
</PRE>
|
| 25 |
|
|
<H2>INHERITANCE</H2><PRE>
|
| 26 |
|
|
itk::Widget <- Labeledwidget <- scrolledframe
|
| 27 |
|
|
|
| 28 |
|
|
|
| 29 |
|
|
</PRE>
|
| 30 |
|
|
<H2>STANDARD OPTIONS</H2><PRE>
|
| 31 |
|
|
<STRONG>activeBackground</STRONG> <STRONG>background</STRONG> <STRONG>borderWidthcursor</STRONG>
|
| 32 |
|
|
<STRONG>font</STRONG> <STRONG>foreground</STRONG> <STRONG>highlightColor</STRONG> <STRONG>highlightThickness</STRONG>
|
| 33 |
|
|
<STRONG>relief</STRONG> <STRONG>repeatDelay</STRONG> <STRONG>repeatInterval</STRONG> <STRONG>selectBackground</STRONG>
|
| 34 |
|
|
<STRONG>selectBorderWidth</STRONG> <STRONG>selectForeground</STRONG>
|
| 35 |
|
|
|
| 36 |
|
|
See the "options" manual entry for details on the standard
|
| 37 |
|
|
options.
|
| 38 |
|
|
|
| 39 |
|
|
|
| 40 |
|
|
</PRE>
|
| 41 |
|
|
<H2>ASSOCIATED OPTIONS</H2><PRE>
|
| 42 |
|
|
<STRONG>activeRelief</STRONG> <STRONG>elementBorderWidth</STRONG> <STRONG>jumptroughColor</STRONG>
|
| 43 |
|
|
|
| 44 |
|
|
See the "scrollbar" manual entry for details on the associ-
|
| 45 |
|
|
ated options.
|
| 46 |
|
|
|
| 47 |
|
|
|
| 48 |
|
|
</PRE>
|
| 49 |
|
|
<H2>INHERITED OPTIONS</H2><PRE>
|
| 50 |
|
|
<STRONG>LabelBitmap</STRONG> <STRONG>labelFont</STRONG> <STRONG>labelImage</STRONG> <STRONG>labelMargin</STRONG>
|
| 51 |
|
|
<STRONG>labelPos</STRONG> <STRONG>labelText</STRONG> <STRONG>labelVariable</STRONG>
|
| 52 |
|
|
|
| 53 |
|
|
See the "labeledwidget" class manual entry for details on
|
| 54 |
|
|
the inherited options.
|
| 55 |
|
|
|
| 56 |
|
|
|
| 57 |
|
|
</PRE>
|
| 58 |
|
|
<H2>WIDGET-SPECIFIC OPTIONS</H2><PRE>
|
| 59 |
|
|
Name: <STRONG>height</STRONG>
|
| 60 |
|
|
Class: <STRONG>Height</STRONG>
|
| 61 |
|
|
Command-Line Switch: <STRONG>-height</STRONG>
|
| 62 |
|
|
|
| 63 |
|
|
Specifies the height of the scrolled frame widget in
|
| 64 |
|
|
any of the forms acceptable to <STRONG>Tk_GetPixels</STRONG>. The
|
| 65 |
|
|
default height is 100 pixels.
|
| 66 |
|
|
|
| 67 |
|
|
Name: <STRONG>hscrollMode</STRONG>
|
| 68 |
|
|
Class: <STRONG>ScrollMode</STRONG>
|
| 69 |
|
|
Command-Line Switch: <STRONG>-hscrollmode</STRONG>
|
| 70 |
|
|
|
| 71 |
|
|
Specifies the the display mode to be used for the hor-
|
| 72 |
|
|
izontal scrollbar: <STRONG>static</STRONG>, <STRONG>dynamic</STRONG>, or <STRONG>none</STRONG>. In static
|
| 73 |
|
|
mode, the scroll bar is displayed at all times.
|
| 74 |
|
|
Dynamic mode displays the scroll bar as required, and
|
| 75 |
|
|
none disables the scroll bar display. The default is
|
| 76 |
|
|
static.
|
| 77 |
|
|
|
| 78 |
|
|
Name: <STRONG>sbWidth</STRONG>
|
| 79 |
|
|
Class: <STRONG>Width</STRONG>
|
| 80 |
|
|
Command-Line Switch: <STRONG>-sbwidth</STRONG>
|
| 81 |
|
|
|
| 82 |
|
|
Specifies the width of the scrollbar in any of the
|
| 83 |
|
|
forms acceptable to <STRONG>Tk_GetPixels</STRONG>. The default width is
|
| 84 |
|
|
15 pixels.
|
| 85 |
|
|
|
| 86 |
|
|
Name: <STRONG>scrollMargin</STRONG>
|
| 87 |
|
|
Class: <STRONG>Margin</STRONG>
|
| 88 |
|
|
Command-Line Switch: <STRONG>-scrollmargin</STRONG>
|
| 89 |
|
|
|
| 90 |
|
|
Specifies the distance between the frame and scrollbar
|
| 91 |
|
|
in any of the forms acceptable to <STRONG>Tk_GetPixels</STRONG>. The
|
| 92 |
|
|
default is 3 pixels.
|
| 93 |
|
|
|
| 94 |
|
|
Name: <STRONG>vscrollMode</STRONG>
|
| 95 |
|
|
Class: <STRONG>ScrollMode</STRONG>
|
| 96 |
|
|
Command-Line Switch: <STRONG>-vscrollmode</STRONG>
|
| 97 |
|
|
|
| 98 |
|
|
Specifies the the display mode to be used for the vert-
|
| 99 |
|
|
ical scrollbar: <STRONG>static</STRONG>, <STRONG>dynamic</STRONG>, or <STRONG>none</STRONG>. In static
|
| 100 |
|
|
mode, the scroll bar is displayed at all times.
|
| 101 |
|
|
Dynamic mode displays the scroll bar as required, and
|
| 102 |
|
|
none disables the scroll bar display. The default is
|
| 103 |
|
|
static.
|
| 104 |
|
|
|
| 105 |
|
|
Name: <STRONG>width</STRONG>
|
| 106 |
|
|
Class: <STRONG>Width</STRONG>
|
| 107 |
|
|
Command-Line Switch: <STRONG>-width</STRONG>
|
| 108 |
|
|
|
| 109 |
|
|
Specifies the width of the scrolled frame widget in any
|
| 110 |
|
|
of the forms acceptable to <STRONG>Tk_GetPixels</STRONG>. The default
|
| 111 |
|
|
height is 100 pixels.
|
| 112 |
|
|
|
| 113 |
|
|
</PRE>
|
| 114 |
|
|
<H2><HR ALIGN=LEFT WIDTH=70% SIZE=3></H2><PRE>
|
| 115 |
|
|
|
| 116 |
|
|
|
| 117 |
|
|
|
| 118 |
|
|
</PRE>
|
| 119 |
|
|
<H2>DESCRIPTION</H2><PRE>
|
| 120 |
|
|
The <STRONG>scrolledframe</STRONG> combines the functionallity of scrolling
|
| 121 |
|
|
with that of a typical frame widget to implement a clipable
|
| 122 |
|
|
viewing area whose visible region may be modified with the
|
| 123 |
|
|
scroll bars. This enables the contruction of visually larger
|
| 124 |
|
|
areas than which could normally be displayed, containing a
|
| 125 |
|
|
heterogenous mix of other widgets. Options exist which allow
|
| 126 |
|
|
full control over which scrollbars are displayed and the
|
| 127 |
|
|
method, i.e. statically or dynamically. The frame itself may
|
| 128 |
|
|
be accessed by the <STRONG>childsite</STRONG> method and then filled with
|
| 129 |
|
|
other widget combinations.
|
| 130 |
|
|
|
| 131 |
|
|
|
| 132 |
|
|
|
| 133 |
|
|
</PRE>
|
| 134 |
|
|
<H2>METHODS</H2><PRE>
|
| 135 |
|
|
|
| 136 |
|
|
The <STRONG>scrolledframe</STRONG> command creates a new Tcl command whose
|
| 137 |
|
|
name is <EM>pathName</EM>. This command may be used to invoke vari-
|
| 138 |
|
|
ous operations on the widget. It has the following general
|
| 139 |
|
|
form:
|
| 140 |
|
|
|
| 141 |
|
|
<EM>pathName</EM> <EM>option</EM> ?<EM>arg</EM> <EM>arg</EM> ...?
|
| 142 |
|
|
|
| 143 |
|
|
<EM>Option</EM> and the <EM>arg</EM>s determine the exact behavior of the com-
|
| 144 |
|
|
mand. The following commands are possible for scrolledframe
|
| 145 |
|
|
widgets:
|
| 146 |
|
|
|
| 147 |
|
|
|
| 148 |
|
|
</PRE>
|
| 149 |
|
|
<H2>ASSOCIATED METHODS</H2><PRE>
|
| 150 |
|
|
<STRONG>xview</STRONG> <STRONG>yview</STRONG>
|
| 151 |
|
|
|
| 152 |
|
|
See the "canvas" manual entry for details on the associated
|
| 153 |
|
|
methods.
|
| 154 |
|
|
|
| 155 |
|
|
|
| 156 |
|
|
|
| 157 |
|
|
</PRE>
|
| 158 |
|
|
<H2>WIDGET-SPECIFIC METHODS</H2><PRE>
|
| 159 |
|
|
<EM>pathName</EM> <STRONG>cget</STRONG> <EM>option</EM>
|
| 160 |
|
|
Returns the current value of the configuration option
|
| 161 |
|
|
given by <EM>option</EM>. <EM>Option</EM> may have any of the values
|
| 162 |
|
|
accepted by the <STRONG>scrolledframe</STRONG> command.
|
| 163 |
|
|
|
| 164 |
|
|
<EM>pathName</EM> <STRONG>childsite</STRONG>
|
| 165 |
|
|
Return the path name of the child site.
|
| 166 |
|
|
|
| 167 |
|
|
<EM>pathName</EM> <STRONG>configure</STRONG> ?<EM>option</EM>? ?<EM>value</EM> <EM>option</EM> <EM>value</EM> ...?
|
| 168 |
|
|
Query or modify the configuration options of the
|
| 169 |
|
|
widget. If no <EM>option</EM> is specified, returns a list
|
| 170 |
|
|
describing all of the available options for <EM>pathName</EM>
|
| 171 |
|
|
(see <STRONG>Tk_ConfigureInfo</STRONG> for information on the format of
|
| 172 |
|
|
this list). If <EM>option</EM> is specified with no <EM>value</EM>, then
|
| 173 |
|
|
the command returns a list describing the one named
|
| 174 |
|
|
option (this list will be identical to the correspond-
|
| 175 |
|
|
ing sublist of the value returned if no <EM>option</EM> is
|
| 176 |
|
|
specified). If one or more <EM>option</EM> - <EM>value</EM> pairs are
|
| 177 |
|
|
specified, then the command modifies the given widget
|
| 178 |
|
|
option(s) to have the given value(s); in this case the
|
| 179 |
|
|
command returns an empty string. <EM>Option</EM> may have any
|
| 180 |
|
|
of the values accepted by the <STRONG>scrolledframe</STRONG> command.
|
| 181 |
|
|
|
| 182 |
|
|
<EM>pathName</EM> <STRONG>justify</STRONG> <EM>direction</EM>
|
| 183 |
|
|
Justifies the frame contents via the scroll bars in one
|
| 184 |
|
|
of four directions: <STRONG>left</STRONG>, <STRONG>right</STRONG>, <STRONG>top</STRONG>, or <STRONG>bottom</STRONG>.
|
| 185 |
|
|
|
| 186 |
|
|
|
| 187 |
|
|
|
| 188 |
|
|
</PRE>
|
| 189 |
|
|
<H2>COMPONENTS</H2><PRE>
|
| 190 |
|
|
Name: <STRONG>canvasFrame</STRONG>
|
| 191 |
|
|
Class: <STRONG>Frame</STRONG>
|
| 192 |
|
|
|
| 193 |
|
|
The canvasFrame component provides relief for the
|
| 194 |
|
|
scrCanvas component. See the "frame" widget manual
|
| 195 |
|
|
entry for details on the canvasFrame component item.
|
| 196 |
|
|
|
| 197 |
|
|
Name: <STRONG>scrCanvas</STRONG>
|
| 198 |
|
|
Class: <STRONG>Canvas</STRONG>
|
| 199 |
|
|
|
| 200 |
|
|
The scrCanvas component provides the scrolling region
|
| 201 |
|
|
for the scrolled frame. See the "canvas" widget manual
|
| 202 |
|
|
entry for details on the scrCanvas component item.
|
| 203 |
|
|
|
| 204 |
|
|
Name: <STRONG>scrFrame</STRONG>
|
| 205 |
|
|
Class: <STRONG>Frame</STRONG>
|
| 206 |
|
|
|
| 207 |
|
|
The scrFrame component is internal to the scrCanvas
|
| 208 |
|
|
component, providing a container for children of the
|
| 209 |
|
|
scrolled frame. See the "frame" widget manual entry
|
| 210 |
|
|
for details on the scrFrame component item.
|
| 211 |
|
|
|
| 212 |
|
|
Name: <STRONG>hSB</STRONG>
|
| 213 |
|
|
Class: <STRONG>Scrollbar</STRONG>
|
| 214 |
|
|
|
| 215 |
|
|
The hSB component is the horizontal scroll bar. See
|
| 216 |
|
|
the "ScrollBar" widget manual entry for details on the
|
| 217 |
|
|
hSB component item.
|
| 218 |
|
|
|
| 219 |
|
|
Name: <STRONG>vSB</STRONG>
|
| 220 |
|
|
Class: <STRONG>Scrollbar</STRONG>
|
| 221 |
|
|
|
| 222 |
|
|
The vSB component is the vertical scroll bar. See the
|
| 223 |
|
|
"ScrollBar" widget manual entry for details on the vSB
|
| 224 |
|
|
component item.
|
| 225 |
|
|
|
| 226 |
|
|
|
| 227 |
|
|
|
| 228 |
|
|
</PRE>
|
| 229 |
|
|
<H2>EXAMPLE</H2><PRE>
|
| 230 |
|
|
scrolledframe .sf -width 150 -height 180 -labelon yes -labeltext scrolledframe
|
| 231 |
|
|
|
| 232 |
|
|
set cs [.sf childsite]
|
| 233 |
|
|
pack [button $cs.b1 -text Hello] -pady 10
|
| 234 |
|
|
pack [button $cs.b2 -text World] -pady 10
|
| 235 |
|
|
pack [button $cs.b3 -text "This is a test"] -pady 10
|
| 236 |
|
|
pack [button $cs.b4 -text "This is a really big button"] -pady 10
|
| 237 |
|
|
pack [button $cs.b5 -text "This is another really big button"] -pady 10
|
| 238 |
|
|
pack [button $cs.b6 -text "This is the last really big button"] -pady 10
|
| 239 |
|
|
|
| 240 |
|
|
pack .sf -expand yes -fill both -padx 10 -pady 10
|
| 241 |
|
|
|
| 242 |
|
|
|
| 243 |
|
|
|
| 244 |
|
|
</PRE>
|
| 245 |
|
|
<H2>AUTHOR</H2><PRE>
|
| 246 |
|
|
Sue Yockey
|
| 247 |
|
|
|
| 248 |
|
|
Mark L. Ulferts
|
| 249 |
|
|
|
| 250 |
|
|
|
| 251 |
|
|
</PRE>
|
| 252 |
|
|
<H2>KEYWORDS</H2><PRE>
|
| 253 |
|
|
scrolledframe, frame, widget
|
| 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 |
|
|
</PRE>
|
| 305 |
|
|
</BODY>
|
| 306 |
|
|
</HTML>
|
