| 1 | .\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13 |
| 2 | .\" |
| 3 | .\" Standard preamble: |
| 4 | .\" ======================================================================== |
| 5 | .de Sh \" Subsection heading |
| 6 | .br |
| 7 | .if t .Sp |
| 8 | .ne 5 |
| 9 | .PP |
| 10 | \fB\\$1\fR |
| 11 | .PP |
| 12 | .. |
| 13 | .de Sp \" Vertical space (when we can't use .PP) |
| 14 | .if t .sp .5v |
| 15 | .if n .sp |
| 16 | .. |
| 17 | .de Vb \" Begin verbatim text |
| 18 | .ft CW |
| 19 | .nf |
| 20 | .ne \\$1 |
| 21 | .. |
| 22 | .de Ve \" End verbatim text |
| 23 | .ft R |
| 24 | .fi |
| 25 | .. |
| 26 | .\" Set up some character translations and predefined strings. \*(-- will |
| 27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
| 28 | .\" double quote, and \*(R" will give a right double quote. | will give a |
| 29 | .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to |
| 30 | .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' |
| 31 | .\" expand to `' in nroff, nothing in troff, for use with C<>. |
| 32 | .tr \(*W-|\(bv\*(Tr |
| 33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
| 34 | .ie n \{\ |
| 35 | . ds -- \(*W- |
| 36 | . ds PI pi |
| 37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
| 38 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
| 39 | . ds L" "" |
| 40 | . ds R" "" |
| 41 | . ds C` "" |
| 42 | . ds C' "" |
| 43 | 'br\} |
| 44 | .el\{\ |
| 45 | . ds -- \|\(em\| |
| 46 | . ds PI \(*p |
| 47 | . ds L" `` |
| 48 | . ds R" '' |
| 49 | 'br\} |
| 50 | .\" |
| 51 | .\" If the F register is turned on, we'll generate index entries on stderr for |
| 52 | .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index |
| 53 | .\" entries marked with X<> in POD. Of course, you'll have to process the |
| 54 | .\" output yourself in some meaningful fashion. |
| 55 | .if \nF \{\ |
| 56 | . de IX |
| 57 | . tm Index:\\$1\t\\n%\t"\\$2" |
| 58 | .. |
| 59 | . nr % 0 |
| 60 | . rr F |
| 61 | .\} |
| 62 | .\" |
| 63 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 64 | .\" way too many mistakes in technical documents. |
| 65 | .hy 0 |
| 66 | .if n .na |
| 67 | .\" |
| 68 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
| 69 | .\" Fear. Run. Save yourself. No user-serviceable parts. |
| 70 | . \" fudge factors for nroff and troff |
| 71 | .if n \{\ |
| 72 | . ds #H 0 |
| 73 | . ds #V .8m |
| 74 | . ds #F .3m |
| 75 | . ds #[ \f1 |
| 76 | . ds #] \fP |
| 77 | .\} |
| 78 | .if t \{\ |
| 79 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
| 80 | . ds #V .6m |
| 81 | . ds #F 0 |
| 82 | . ds #[ \& |
| 83 | . ds #] \& |
| 84 | .\} |
| 85 | . \" simple accents for nroff and troff |
| 86 | .if n \{\ |
| 87 | . ds ' \& |
| 88 | . ds ` \& |
| 89 | . ds ^ \& |
| 90 | . ds , \& |
| 91 | . ds ~ ~ |
| 92 | . ds / |
| 93 | .\} |
| 94 | .if t \{\ |
| 95 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
| 96 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' |
| 97 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' |
| 98 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' |
| 99 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' |
| 100 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' |
| 101 | .\} |
| 102 | . \" troff and (daisy-wheel) nroff accents |
| 103 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
| 104 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' |
| 105 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
| 106 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' |
| 107 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' |
| 108 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] |
| 109 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] |
| 110 | .ds ae a\h'-(\w'a'u*4/10)'e |
| 111 | .ds Ae A\h'-(\w'A'u*4/10)'E |
| 112 | . \" corrections for vroff |
| 113 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
| 114 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' |
| 115 | . \" for low resolution devices (crt and lpr) |
| 116 | .if \n(.H>23 .if \n(.V>19 \ |
| 117 | \{\ |
| 118 | . ds : e |
| 119 | . ds 8 ss |
| 120 | . ds o a |
| 121 | . ds d- d\h'-1'\(ga |
| 122 | . ds D- D\h'-1'\(hy |
| 123 | . ds th \o'bp' |
| 124 | . ds Th \o'LP' |
| 125 | . ds ae ae |
| 126 | . ds Ae AE |
| 127 | .\} |
| 128 | .rm #[ #] #H #V #F C |
| 129 | .\" ======================================================================== |
| 130 | .\" |
| 131 | .IX Title "OPTIONS 1" |
| 132 | .TH OPTIONS 1 "2000-12-30" "perl v5.8.0" "User Contributed Perl Documentation" |
| 133 | .SH "NAME" |
| 134 | Tk::options \- Standard options supported by widgets and their manipulation |
| 135 | .SH "SYNOPSIS" |
| 136 | .IX Header "SYNOPSIS" |
| 137 | \&\ \fI$value\fR = \fI$widget\fR\->\fBcget\fR('\fI\-option\fR'); |
| 138 | .PP |
| 139 | \&\ \fI$widget\fR\->\fBconfigure\fR(\fI\-option\fR=>\fIvalue\fR ?,\fI\-option\fR=>\fIvalue\fR ...?); |
| 140 | .PP |
| 141 | \&\ \fI@list\fR = \fI$widget\fR\->\fBconfigure\fR('\fI\-option\fR'); |
| 142 | .PP |
| 143 | \&\ \fI@lol\fR = \fI$widget\fR\->\fBconfigure\fR; |
| 144 | .SH "DESCRIPTION" |
| 145 | .IX Header "DESCRIPTION" |
| 146 | All widgets, and images have a standard mechanism for setting and querying |
| 147 | attibutes or options. The mechanism is based on two methods \fBconfigure\fR |
| 148 | and \fBcget\fR. The behaviour of these methods is as follows: |
| 149 | .IP "\fI$widget\fR\->\fBconfigure\fR(\fI\-option\fR=>\fIvalue\fR ?,\fI\-option\fR=>\fIvalue\fR ...?);" 4 |
| 150 | .IX Item "$widget->configure(-option=>value ?,-option=>value ...?);" |
| 151 | Sets the values of \fI\-option\fR to \fIvalue\fR for each \fI\-option\fR=>\fIvalue\fR |
| 152 | pair. The internal \fBnew\fR method does an implicit \fBconfigure\fR in this |
| 153 | form with options passed in at widget create time. |
| 154 | .IP "\fI$widget\fR\->\fBconfigure\fR('\fI\-option\fR')" 4 |
| 155 | .IX Item "$widget->configure('-option')" |
| 156 | In array context returns a list of five or two elements. If \fI\-option\fR |
| 157 | is an alias for another options it return a list consisting of the |
| 158 | alias option and the name for the option is is an alias for, e.g., |
| 159 | \&\f(CW\*(C`('\-bg', 'background')\*(C'\fR. If \fI\-option\fR is not an alias the returned |
| 160 | list has the following five elements: |
| 161 | .RS 4 |
| 162 | .IP "\fIOption Name\fR" 8 |
| 163 | .IX Item "Option Name" |
| 164 | The value of \fI\-option\fR, e.g., \fB\-background\fR. |
| 165 | .IP "\fIName\fR" 8 |
| 166 | .IX Item "Name" |
| 167 | The option's name in the option database, e.g., \f(CW\*(C`background\*(C'\fR. |
| 168 | .IP "\fIClass\fR" 8 |
| 169 | .IX Item "Class" |
| 170 | The option's class value in the option database, e.g., \f(CW\*(C`Background\*(C'\fR. |
| 171 | .IP "\fIDefault\fR" 8 |
| 172 | .IX Item "Default" |
| 173 | The default value for the option if not specified or in the option database, |
| 174 | e.g., \f(CW\*(C`grey\*(C'\fR. |
| 175 | .IP "\fIValue\fR" 8 |
| 176 | .IX Item "Value" |
| 177 | The current value (as returned by \fBcget\fR), e.g., \f(CW\*(C`white\*(C'\fR. |
| 178 | .RE |
| 179 | .RS 4 |
| 180 | .RE |
| 181 | .IP "\fI$widget\fR\->\fBconfigure\fR" 4 |
| 182 | .IX Item "$widget->configure" |
| 183 | Returns a list of lists for all the options supported by \fI$widget\fR. |
| 184 | Each sub-list is in the form returned by \fBconfigure\fR('\fI\-option\fR'). |
| 185 | (This mechanism is used by the \fBTk::Derived\fR class to determine |
| 186 | the options available from base class.) |
| 187 | .IP "\fI$widget\fR\->\fBcget\fR('\fI\-option\fR')" 4 |
| 188 | .IX Item "$widget->cget('-option')" |
| 189 | Returns the current value of \fI\-option\fR for \fI$widget\fR. |
| 190 | .Sp |
| 191 | \&\fBcget\fR('\fI\-option\fR') is clumsy with the need for \fB''\fR due to perl's |
| 192 | parsing rules. Something more subtle using tie might look better. |
| 193 | .PP |
| 194 | The following paragraphs describe the common configuration options supported by |
| 195 | widgets in the Tk toolkit. Every widget does not necessarily support every option |
| 196 | (see the the documentation entries for individual widgets for a list of the |
| 197 | standard options supported by that widget), but if a widget does support an option |
| 198 | with one of the names listed below, then the option has exactly the effect |
| 199 | described below. |
| 200 | .PP |
| 201 | In the descriptions below, ``Name'' refers to the option's name in the option |
| 202 | database. ``Class'' refers to the option's class value |
| 203 | in the option database. ``Switch'' refers to the switch used in widget-creation |
| 204 | and \fBconfigure\fR widget methods to set this value. For example, if an option's |
| 205 | configure option is \fB\-foreground\fR and there exists a widget \fI$widget\fR, then the |
| 206 | call: |
| 207 | .PP |
| 208 | \&\ \fI$widget\fR\->\fBconfigure\fR(\fB\-foreground\fR=>\fB'black'\fR) |
| 209 | .PP |
| 210 | may be used to specify the value \fBblack\fR for the option in the widget \fI$widget\fR. |
| 211 | Configure options may be abbreviated, as long as the abbreviation is unambiguous |
| 212 | (abbreviation is deprecated in perl/Tk). |
| 213 | .Sh "Creation options: Widget Name and Class" |
| 214 | .IX Subsection "Creation options: Widget Name and Class" |
| 215 | The \fBName\fR and \fB\-class\fR options can only be specified when a widget is |
| 216 | created, and cannot be changed with \fBconfigure\fR. These options determine |
| 217 | the widget's identity and how Tk applies resource values from the |
| 218 | option database (see Tk::option) and so they |
| 219 | cannot be assigned by the options database. |
| 220 | .IP "Name: \fIname\fR" 4 |
| 221 | .IX Item "Name: name" |
| 222 | .PD 0 |
| 223 | .IP "Switch: \fBName\fR" 4 |
| 224 | .IX Item "Switch: Name" |
| 225 | .PD |
| 226 | Specifies the path element for the widget. Names generally begin with a |
| 227 | lowercase letter. |
| 228 | .Sp |
| 229 | Each widget has a unique \fIpathname\fR that follows the hierarchy from the |
| 230 | \&\fBMainWindow\fR to the widget itself. Since the widget's \fBPathName\fR is |
| 231 | used to assign options from the options database, it is important to |
| 232 | specify a distinctive \fBName\fR for any widget that will have non-default |
| 233 | options. See Tk::option for details. |
| 234 | .IP "Name: \fIclass\fR" 4 |
| 235 | .IX Item "Name: class" |
| 236 | .PD 0 |
| 237 | .IP "Switch: \fB\-class\fR" 4 |
| 238 | .IX Item "Switch: -class" |
| 239 | .PD |
| 240 | Specifies a class for the window. Classes generally begin with an |
| 241 | uppercase letter. |
| 242 | .Sp |
| 243 | This class will be used when querying the option database for |
| 244 | the window's other options (see Tk::options), and it will also be used |
| 245 | later for other purposes such as bindings. One typically assigns a class |
| 246 | to a \fBTopLevel\fR or \fBFrame\fR so that the class will apply to all of |
| 247 | that widget's children. |
| 248 | .Sh "Reconfigurable options" |
| 249 | .IX Subsection "Reconfigurable options" |
| 250 | These options can be set at widget creation or changed later via \fBconfigure\fR. |
| 251 | .IP "Name: \fBactiveBackground\fR" 4 |
| 252 | .IX Item "Name: activeBackground" |
| 253 | .PD 0 |
| 254 | .IP "Class: \fBForeground\fR" 4 |
| 255 | .IX Item "Class: Foreground" |
| 256 | .IP "Switch: \fB\-activebackground\fR" 4 |
| 257 | .IX Item "Switch: -activebackground" |
| 258 | .PD |
| 259 | Specifies background color to use when drawing active elements. |
| 260 | An element (a widget or portion of a widget) is active if the |
| 261 | mouse cursor is positioned over the element and pressing a mouse button |
| 262 | will cause some action to occur. |
| 263 | If strict Motif compliance has been requested by setting the |
| 264 | \&\fB$Tk::strictMotif\fR variable, this option will normally be |
| 265 | ignored; the normal background color will be used instead. |
| 266 | For some elements on Windows and Macintosh systems, the active color |
| 267 | will only be used while mouse button 1 is pressed over the element. |
| 268 | .IP "Name: \fBactiveBorderWidth\fR" 4 |
| 269 | .IX Item "Name: activeBorderWidth" |
| 270 | .PD 0 |
| 271 | .IP "Class: \fBBorderWidth\fR" 4 |
| 272 | .IX Item "Class: BorderWidth" |
| 273 | .IP "Switch: \fB\-activeborderwidth\fR" 4 |
| 274 | .IX Item "Switch: -activeborderwidth" |
| 275 | .PD |
| 276 | Specifies a non-negative value indicating |
| 277 | the width of the 3\-D border drawn around active elements. |
| 278 | See above for definition of active elements. |
| 279 | The value may have any of the forms acceptable to \fBTk_GetPixels\fR. |
| 280 | This option is typically only available in widgets displaying more |
| 281 | than one element at a time (e.g. menus but not buttons). |
| 282 | .IP "Name: \fBactiveForeground\fR" 4 |
| 283 | .IX Item "Name: activeForeground" |
| 284 | .PD 0 |
| 285 | .IP "Class: \fBBackground\fR" 4 |
| 286 | .IX Item "Class: Background" |
| 287 | .IP "Switch: \fB\-activeforeground\fR" 4 |
| 288 | .IX Item "Switch: -activeforeground" |
| 289 | .PD |
| 290 | Specifies foreground color to use when drawing active elements. |
| 291 | See above for definition of active elements. |
| 292 | .IP "Name: \fBactivetile\fR" 4 |
| 293 | .IX Item "Name: activetile" |
| 294 | .PD 0 |
| 295 | .IP "Class: \fBTile\fR" 4 |
| 296 | .IX Item "Class: Tile" |
| 297 | .IP "Switch: \fB\-activetile\fR" 4 |
| 298 | .IX Item "Switch: -activetile" |
| 299 | .PD |
| 300 | Specifies image used to display inside active elements of the widget. |
| 301 | See above for definition of active elements. |
| 302 | .IP "Name: \fBanchor\fR" 4 |
| 303 | .IX Item "Name: anchor" |
| 304 | .PD 0 |
| 305 | .IP "Class: \fBAnchor\fR" 4 |
| 306 | .IX Item "Class: Anchor" |
| 307 | .IP "Switch: \fB\-anchor\fR" 4 |
| 308 | .IX Item "Switch: -anchor" |
| 309 | .PD |
| 310 | Specifies how the information in a widget (e.g. text or a bitmap) |
| 311 | is to be displayed in the widget. |
| 312 | Must be one of the values \fBn\fR, \fBne\fR, \fBe\fR, \fBse\fR, |
| 313 | \&\fBs\fR, \fBsw\fR, \fBw\fR, \fBnw\fR, or \fBcenter\fR. |
| 314 | For example, \fBnw\fR means display the information such that its |
| 315 | top-left corner is at the top-left corner of the widget. |
| 316 | .IP "Name: \fBbackground\fR" 4 |
| 317 | .IX Item "Name: background" |
| 318 | .PD 0 |
| 319 | .IP "Class: \fBBackground\fR" 4 |
| 320 | .IX Item "Class: Background" |
| 321 | .IP "Switch: \fB\-background\fR" 4 |
| 322 | .IX Item "Switch: -background" |
| 323 | .IP "Alias: \fB\-bg\fR" 4 |
| 324 | .IX Item "Alias: -bg" |
| 325 | .PD |
| 326 | Specifies the normal background color to use when displaying the |
| 327 | widget. |
| 328 | .IP "Name: \fBbitmap\fR" 4 |
| 329 | .IX Item "Name: bitmap" |
| 330 | .PD 0 |
| 331 | .IP "Class: \fBBitmap\fR" 4 |
| 332 | .IX Item "Class: Bitmap" |
| 333 | .IP "Switch: \fB\-bitmap\fR" 4 |
| 334 | .IX Item "Switch: -bitmap" |
| 335 | .PD |
| 336 | Specifies a bitmap to display in the widget, in any of the forms |
| 337 | acceptable to \fBTk_GetBitmap\fR. |
| 338 | The exact way in which the bitmap is displayed may be affected by |
| 339 | other options such as \fB\-anchor\fR or \fB\-justify\fR. |
| 340 | Typically, if this option is specified then it overrides other |
| 341 | options that specify a textual value to display in the widget; |
| 342 | the \fB\-bitmap\fR option may be reset to an empty string to re-enable |
| 343 | a text display. |
| 344 | In widgets that support both \fB\-bitmap\fR and \fB\-image\fR options, |
| 345 | \&\fB\-image\fR will usually override \fB\-bitmap\fR. |
| 346 | .IP "Name: \fBborderWidth\fR" 4 |
| 347 | .IX Item "Name: borderWidth" |
| 348 | .PD 0 |
| 349 | .IP "Class: \fBBorderWidth\fR" 4 |
| 350 | .IX Item "Class: BorderWidth" |
| 351 | .IP "Switch: \fB\-borderwidth\fR" 4 |
| 352 | .IX Item "Switch: -borderwidth" |
| 353 | .IP "Alias: \fB\-bd\fR" 4 |
| 354 | .IX Item "Alias: -bd" |
| 355 | .PD |
| 356 | Specifies a non-negative value indicating the width |
| 357 | of the 3\-D border to draw around the outside of the widget (if such a |
| 358 | border is being drawn; the \fBrelief\fR option typically determines |
| 359 | this). The value may also be used when drawing 3\-D effects in the |
| 360 | interior of the widget. |
| 361 | The value may have any of the forms acceptable to \fBTk_GetPixels\fR. |
| 362 | .IP "Name: \fBcursor\fR" 4 |
| 363 | .IX Item "Name: cursor" |
| 364 | .PD 0 |
| 365 | .IP "Class: \fBCursor\fR" 4 |
| 366 | .IX Item "Class: Cursor" |
| 367 | .IP "Switch: \fB\-cursor\fR" 4 |
| 368 | .IX Item "Switch: -cursor" |
| 369 | .PD |
| 370 | Specifies the mouse cursor to be used for the widget. |
| 371 | The value may have any of the forms acceptable to \fBTk_GetCursor\fR. |
| 372 | .IP "Name: \fBdash\fR" 4 |
| 373 | .IX Item "Name: dash" |
| 374 | .PD 0 |
| 375 | .IP "Class: \fBDash\fR" 4 |
| 376 | .IX Item "Class: Dash" |
| 377 | .IP "Switch: \fB\-dash\fR" 4 |
| 378 | .IX Item "Switch: -dash" |
| 379 | .PD |
| 380 | The value may have any of the forms accepted by \fBTk_GetDash\fR, |
| 381 | such as \fB4\fR, \fB[6,4]\fR, \fB.\fR, \fB\-\fR, \fB\-.\fR, or \fB\-..\fR. |
| 382 | .IP "Name: \fBdashoffset\fR" 4 |
| 383 | .IX Item "Name: dashoffset" |
| 384 | .PD 0 |
| 385 | .IP "Class: \fBDashoffset\fR" 4 |
| 386 | .IX Item "Class: Dashoffset" |
| 387 | .IP "Switch: \fB\-dashoffset\fR" 4 |
| 388 | .IX Item "Switch: -dashoffset" |
| 389 | .PD |
| 390 | Specifies the offset in the dash list where the drawing starts. |
| 391 | .IP "Name: \fBdisabledForeground\fR" 4 |
| 392 | .IX Item "Name: disabledForeground" |
| 393 | .PD 0 |
| 394 | .IP "Class: \fBDisabledForeground\fR" 4 |
| 395 | .IX Item "Class: DisabledForeground" |
| 396 | .IP "Switch: \fB\-disabledforeground\fR" 4 |
| 397 | .IX Item "Switch: -disabledforeground" |
| 398 | .PD |
| 399 | Specifies foreground color to use when drawing a disabled element. |
| 400 | If the option is specified as an empty string (which is typically the |
| 401 | case on monochrome displays), disabled elements are drawn with the |
| 402 | normal foreground color but they are dimmed by drawing them |
| 403 | with a stippled fill pattern. |
| 404 | .IP "Name: \fBdisabledtile\fR" 4 |
| 405 | .IX Item "Name: disabledtile" |
| 406 | .PD 0 |
| 407 | .IP "Class: \fBTile\fR" 4 |
| 408 | .IX Item "Class: Tile" |
| 409 | .IP "Switch: \fB\-disabledtile\fR" 4 |
| 410 | .IX Item "Switch: -disabledtile" |
| 411 | .PD |
| 412 | Specifies image to use when drawing a disabled element. |
| 413 | .IP "Name: \fBexportSelection\fR" 4 |
| 414 | .IX Item "Name: exportSelection" |
| 415 | .PD 0 |
| 416 | .IP "Class: \fBExportSelection\fR" 4 |
| 417 | .IX Item "Class: ExportSelection" |
| 418 | .IP "Switch: \fB\-exportselection\fR" 4 |
| 419 | .IX Item "Switch: -exportselection" |
| 420 | .PD |
| 421 | Specifies whether or not a selection in the widget should also be |
| 422 | the X selection. |
| 423 | The value may have any of the forms accepted by \fBTcl_GetBoolean\fR, |
| 424 | such as \fBtrue\fR, \fBfalse\fR, \fB0\fR, \fB1\fR, \fByes\fR, or \fBno\fR. |
| 425 | If the selection is exported, then selecting in the widget deselects |
| 426 | the current X selection, selecting outside the widget deselects any |
| 427 | widget selection, and the widget will respond to selection retrieval |
| 428 | requests when it has a selection. The default is usually for widgets |
| 429 | to export selections. |
| 430 | .IP "Name: \fBfont\fR" 4 |
| 431 | .IX Item "Name: font" |
| 432 | .PD 0 |
| 433 | .IP "Class: \fBFont\fR" 4 |
| 434 | .IX Item "Class: Font" |
| 435 | .IP "Switch: \fB\-font\fR" 4 |
| 436 | .IX Item "Switch: -font" |
| 437 | .PD |
| 438 | Specifies the font to use when drawing text inside the widget. |
| 439 | .IP "Name: \fBforeground\fR" 4 |
| 440 | .IX Item "Name: foreground" |
| 441 | .PD 0 |
| 442 | .IP "Class: \fBForeground\fR" 4 |
| 443 | .IX Item "Class: Foreground" |
| 444 | .IP "Switch: \fB\-foreground\fR" 4 |
| 445 | .IX Item "Switch: -foreground" |
| 446 | .IP "Alias: \fB\-fg\fR" 4 |
| 447 | .IX Item "Alias: -fg" |
| 448 | .PD |
| 449 | Specifies the normal foreground color to use when displaying the widget. |
| 450 | .IP "Name: \fBhighlightBackground\fR" 4 |
| 451 | .IX Item "Name: highlightBackground" |
| 452 | .PD 0 |
| 453 | .IP "Class: \fBHighlightBackground\fR" 4 |
| 454 | .IX Item "Class: HighlightBackground" |
| 455 | .IP "Switch: \fB\-highlightbackground\fR" 4 |
| 456 | .IX Item "Switch: -highlightbackground" |
| 457 | .PD |
| 458 | Specifies the color to display in the traversal highlight region when |
| 459 | the widget does not have the input focus. |
| 460 | .IP "Name: \fBhighlightColor\fR" 4 |
| 461 | .IX Item "Name: highlightColor" |
| 462 | .PD 0 |
| 463 | .IP "Class: \fBHighlightColor\fR" 4 |
| 464 | .IX Item "Class: HighlightColor" |
| 465 | .IP "Switch: \fB\-highlightcolor\fR" 4 |
| 466 | .IX Item "Switch: -highlightcolor" |
| 467 | .PD |
| 468 | Specifies the color to use for the traversal highlight rectangle that is |
| 469 | drawn around the widget when it has the input focus. |
| 470 | .IP "Name: \fBhighlightThickness\fR" 4 |
| 471 | .IX Item "Name: highlightThickness" |
| 472 | .PD 0 |
| 473 | .IP "Class: \fBHighlightThickness\fR" 4 |
| 474 | .IX Item "Class: HighlightThickness" |
| 475 | .IP "Switch: \fB\-highlightthickness\fR" 4 |
| 476 | .IX Item "Switch: -highlightthickness" |
| 477 | .PD |
| 478 | Specifies a non-negative value indicating the width of the highlight |
| 479 | rectangle to draw around the outside of the widget when it has the |
| 480 | input focus. |
| 481 | The value may have any of the forms acceptable to \fBTk_GetPixels\fR. |
| 482 | If the value is zero, no focus highlight is drawn around the widget. |
| 483 | .IP "Name: \fBimage\fR" 4 |
| 484 | .IX Item "Name: image" |
| 485 | .PD 0 |
| 486 | .IP "Class: \fBImage\fR" 4 |
| 487 | .IX Item "Class: Image" |
| 488 | .IP "Switch: \fB\-image\fR" 4 |
| 489 | .IX Item "Switch: -image" |
| 490 | .PD |
| 491 | Specifies an image to display in the widget, which must have been |
| 492 | created with an image create. (See Tk::Image for details of image creation.) |
| 493 | Typically, if the \fB\-image\fR option is specified then it overrides other |
| 494 | options that specify a bitmap or textual value to display in the widget; |
| 495 | the \fB\-image\fR option may be reset to an empty string to re-enable |
| 496 | a bitmap or text display. |
| 497 | .IP "Name: \fBinsertBackground\fR" 4 |
| 498 | .IX Item "Name: insertBackground" |
| 499 | .PD 0 |
| 500 | .IP "Class: \fBForeground\fR" 4 |
| 501 | .IX Item "Class: Foreground" |
| 502 | .IP "Switch: \fB\-insertbackground\fR" 4 |
| 503 | .IX Item "Switch: -insertbackground" |
| 504 | .PD |
| 505 | Specifies the color to use as background in the area covered by the |
| 506 | insertion cursor. This color will normally override either the normal |
| 507 | background for the widget (or the selection background if the insertion |
| 508 | cursor happens to fall in the selection). |
| 509 | .IP "Name: \fBinsertBorderWidth\fR" 4 |
| 510 | .IX Item "Name: insertBorderWidth" |
| 511 | .PD 0 |
| 512 | .IP "Class: \fBBorderWidth\fR" 4 |
| 513 | .IX Item "Class: BorderWidth" |
| 514 | .IP "Switch: \fB\-insertborderwidth\fR" 4 |
| 515 | .IX Item "Switch: -insertborderwidth" |
| 516 | .PD |
| 517 | Specifies a non-negative value indicating the width |
| 518 | of the 3\-D border to draw around the insertion cursor. |
| 519 | The value may have any of the forms acceptable to \fBTk_GetPixels\fR. |
| 520 | .IP "Name: \fBinsertOffTime\fR" 4 |
| 521 | .IX Item "Name: insertOffTime" |
| 522 | .PD 0 |
| 523 | .IP "Class: \fBOffTime\fR" 4 |
| 524 | .IX Item "Class: OffTime" |
| 525 | .IP "Switch: \fB\-insertofftime\fR" 4 |
| 526 | .IX Item "Switch: -insertofftime" |
| 527 | .PD |
| 528 | Specifies a non-negative integer value indicating the number of |
| 529 | milliseconds the insertion cursor should remain ``off'' in each blink cycle. |
| 530 | If this option is zero then the cursor doesn't blink: it is on |
| 531 | all the time. |
| 532 | .IP "Name: \fBinsertOnTime\fR" 4 |
| 533 | .IX Item "Name: insertOnTime" |
| 534 | .PD 0 |
| 535 | .IP "Class: \fBOnTime\fR" 4 |
| 536 | .IX Item "Class: OnTime" |
| 537 | .IP "Switch: \fB\-insertontime\fR" 4 |
| 538 | .IX Item "Switch: -insertontime" |
| 539 | .PD |
| 540 | Specifies a non-negative integer value indicating the number of |
| 541 | milliseconds the insertion cursor should remain ``on'' in each blink cycle. |
| 542 | .IP "Name: \fBinsertWidth\fR" 4 |
| 543 | .IX Item "Name: insertWidth" |
| 544 | .PD 0 |
| 545 | .IP "Class: \fBInsertWidth\fR" 4 |
| 546 | .IX Item "Class: InsertWidth" |
| 547 | .IP "Switch: \fB\-insertwidth\fR" 4 |
| 548 | .IX Item "Switch: -insertwidth" |
| 549 | .PD |
| 550 | Specifies a value indicating the total width of the insertion cursor. |
| 551 | The value may have any of the forms acceptable to \fBTk_GetPixels\fR. |
| 552 | If a border has been specified for the insertion |
| 553 | cursor (using the \fBinsertBorderWidth\fR option), the border |
| 554 | will be drawn inside the width specified by the \fBinsertWidth\fR |
| 555 | option. |
| 556 | .IP "Name: \fBjump\fR" 4 |
| 557 | .IX Item "Name: jump" |
| 558 | .PD 0 |
| 559 | .IP "Class: \fBJump\fR" 4 |
| 560 | .IX Item "Class: Jump" |
| 561 | .IP "Switch: \fB\-jump\fR" 4 |
| 562 | .IX Item "Switch: -jump" |
| 563 | .PD |
| 564 | For widgets with a slider that can be dragged to adjust a value, |
| 565 | such as scrollbars, this option determines when |
| 566 | notifications are made about changes in the value. |
| 567 | The option's value must be a boolean of the form accepted by |
| 568 | \&\fBTcl_GetBoolean\fR. |
| 569 | If the value is false, updates are made continuously as the |
| 570 | slider is dragged. |
| 571 | If the value is true, updates are delayed until the mouse button |
| 572 | is released to end the drag; at that point a single notification |
| 573 | is made (the value ``jumps'' rather than changing smoothly). |
| 574 | .IP "Name: \fBjustify\fR" 4 |
| 575 | .IX Item "Name: justify" |
| 576 | .PD 0 |
| 577 | .IP "Class: \fBJustify\fR" 4 |
| 578 | .IX Item "Class: Justify" |
| 579 | .IP "Switch: \fB\-justify\fR" 4 |
| 580 | .IX Item "Switch: -justify" |
| 581 | .PD |
| 582 | When there are multiple lines of text displayed in a widget, this |
| 583 | option determines how the lines line up with each other. |
| 584 | Must be one of \fBleft\fR, \fBcenter\fR, or \fBright\fR. |
| 585 | \&\fBLeft\fR means that the lines' left edges all line up, \fBcenter\fR |
| 586 | means that the lines' centers are aligned, and \fBright\fR means |
| 587 | that the lines' right edges line up. |
| 588 | .IP "Name: \fBoffset\fR" 4 |
| 589 | .IX Item "Name: offset" |
| 590 | .PD 0 |
| 591 | .IP "Class: \fBOffset\fR" 4 |
| 592 | .IX Item "Class: Offset" |
| 593 | .IP "Switch: \fB\-offset\fR" 4 |
| 594 | .IX Item "Switch: -offset" |
| 595 | .PD |
| 596 | Specifies the offset of tiles (see also \fB\-tile\fR option). It can |
| 597 | have two different formats \fB\-offset x,y\fR or \fB\-offset side\fR, |
| 598 | where side can be \fBn\fR, \fBne\fR, \fBe\fR, \fBse\fR, \fBs\fR, |
| 599 | \&\fBsw\fR, \fBw\fR, \fBnw\fR, or \fBcenter\fR. In the first case |
| 600 | the origin is the origin of the toplevel of the current window. |
| 601 | For the canvas itself and canvas objects the origin is the canvas |
| 602 | origin, but putting \fB#\fR in front of the coordinate pair |
| 603 | indicates using the toplevel origin in stead. For canvas objects, |
| 604 | the \fB\-offset\fR option is used for stippling as well. |
| 605 | For the line and polygon canvas items you can also specify |
| 606 | an index as argument, which connects the stipple or tile |
| 607 | origin to one of the coordinate points of the line/polygon. |
| 608 | .IP "Name: \fBorient\fR" 4 |
| 609 | .IX Item "Name: orient" |
| 610 | .PD 0 |
| 611 | .IP "Class: \fBOrient\fR" 4 |
| 612 | .IX Item "Class: Orient" |
| 613 | .IP "Switch: \fB\-orient\fR" 4 |
| 614 | .IX Item "Switch: -orient" |
| 615 | .PD |
| 616 | For widgets that can lay themselves out with either a horizontal |
| 617 | or vertical orientation, such as scrollbars, this option specifies |
| 618 | which orientation should be used. Must be either \fBhorizontal\fR |
| 619 | or \fBvertical\fR or an abbreviation of one of these. |
| 620 | .IP "Name: \fBpadX\fR" 4 |
| 621 | .IX Item "Name: padX" |
| 622 | .PD 0 |
| 623 | .IP "Class: \fBPad\fR" 4 |
| 624 | .IX Item "Class: Pad" |
| 625 | .IP "Switch: \fB\-padx\fR" 4 |
| 626 | .IX Item "Switch: -padx" |
| 627 | .PD |
| 628 | Specifies a non-negative value indicating how much extra space |
| 629 | to request for the widget in the X\-direction. |
| 630 | The value may have any of the forms acceptable to \fBTk_GetPixels\fR. |
| 631 | When computing how large a window it needs, the widget will |
| 632 | add this amount to the width it would normally need (as determined |
| 633 | by the width of the things displayed in the widget); if the geometry |
| 634 | manager can satisfy this request, the widget will end up with extra |
| 635 | internal space to the left and/or right of what it displays inside. |
| 636 | Most widgets only use this option for padding text: if they are |
| 637 | displaying a bitmap or image, then they usually ignore padding |
| 638 | options. |
| 639 | .IP "Name: \fBpadY\fR" 4 |
| 640 | .IX Item "Name: padY" |
| 641 | .PD 0 |
| 642 | .IP "Class: \fBPad\fR" 4 |
| 643 | .IX Item "Class: Pad" |
| 644 | .IP "Switch: \fB\-pady\fR" 4 |
| 645 | .IX Item "Switch: -pady" |
| 646 | .PD |
| 647 | Specifies a non-negative value indicating how much extra space |
| 648 | to request for the widget in the Y\-direction. |
| 649 | The value may have any of the forms acceptable to \fBTk_GetPixels\fR. |
| 650 | When computing how large a window it needs, the widget will add |
| 651 | this amount to the height it would normally need (as determined by |
| 652 | the height of the things displayed in the widget); if the geometry |
| 653 | manager can satisfy this request, the widget will end up with extra |
| 654 | internal space above and/or below what it displays inside. |
| 655 | Most widgets only use this option for padding text: if they are |
| 656 | displaying a bitmap or image, then they usually ignore padding |
| 657 | options. |
| 658 | .IP "Name: \fBrelief\fR" 4 |
| 659 | .IX Item "Name: relief" |
| 660 | .PD 0 |
| 661 | .IP "Class: \fBRelief\fR" 4 |
| 662 | .IX Item "Class: Relief" |
| 663 | .IP "Switch: \fB\-relief\fR" 4 |
| 664 | .IX Item "Switch: -relief" |
| 665 | .PD |
| 666 | Specifies the 3\-D effect desired for the widget. Acceptable |
| 667 | values are \fBraised\fR, \fBsunken\fR, \fBflat\fR, \fBridge\fR, |
| 668 | \&\fBsolid\fR, and \fBgroove\fR. |
| 669 | The value |
| 670 | indicates how the interior of the widget should appear relative |
| 671 | to its exterior; for example, \fBraised\fR means the interior of |
| 672 | the widget should appear to protrude from the screen, relative to |
| 673 | the exterior of the widget. |
| 674 | .IP "Name: \fBrepeatDelay\fR" 4 |
| 675 | .IX Item "Name: repeatDelay" |
| 676 | .PD 0 |
| 677 | .IP "Class: \fBRepeatDelay\fR" 4 |
| 678 | .IX Item "Class: RepeatDelay" |
| 679 | .IP "Switch: \fB\-repeatdelay\fR" 4 |
| 680 | .IX Item "Switch: -repeatdelay" |
| 681 | .PD |
| 682 | Specifies the number of milliseconds a button or key must be held |
| 683 | down before it begins to auto\-repeat. Used, for example, on the |
| 684 | up\- and down-arrows in scrollbars. |
| 685 | .IP "Name: \fBrepeatInterval\fR" 4 |
| 686 | .IX Item "Name: repeatInterval" |
| 687 | .PD 0 |
| 688 | .IP "Class: \fBRepeatInterval\fR" 4 |
| 689 | .IX Item "Class: RepeatInterval" |
| 690 | .IP "Switch: \fB\-repeatinterval\fR" 4 |
| 691 | .IX Item "Switch: -repeatinterval" |
| 692 | .PD |
| 693 | Used in conjunction with \fBrepeatDelay\fR: once auto-repeat |
| 694 | begins, this option determines the number of milliseconds between |
| 695 | auto\-repeats. |
| 696 | .IP "Name: \fBselectBackground\fR" 4 |
| 697 | .IX Item "Name: selectBackground" |
| 698 | .PD 0 |
| 699 | .IP "Class: \fBForeground\fR" 4 |
| 700 | .IX Item "Class: Foreground" |
| 701 | .IP "Switch: \fB\-selectbackground\fR" 4 |
| 702 | .IX Item "Switch: -selectbackground" |
| 703 | .PD |
| 704 | Specifies the background color to use when displaying selected |
| 705 | items. |
| 706 | .IP "Name: \fBselectBorderWidth\fR" 4 |
| 707 | .IX Item "Name: selectBorderWidth" |
| 708 | .PD 0 |
| 709 | .IP "Class: \fBBorderWidth\fR" 4 |
| 710 | .IX Item "Class: BorderWidth" |
| 711 | .IP "Switch: \fB\-selectborderwidth\fR" 4 |
| 712 | .IX Item "Switch: -selectborderwidth" |
| 713 | .PD |
| 714 | Specifies a non-negative value indicating the width |
| 715 | of the 3\-D border to draw around selected items. |
| 716 | The value may have any of the forms acceptable to \fBTk_GetPixels\fR. |
| 717 | .IP "Name: \fBselectForeground\fR" 4 |
| 718 | .IX Item "Name: selectForeground" |
| 719 | .PD 0 |
| 720 | .IP "Class: \fBBackground\fR" 4 |
| 721 | .IX Item "Class: Background" |
| 722 | .IP "Switch: \fB\-selectforeground\fR" 4 |
| 723 | .IX Item "Switch: -selectforeground" |
| 724 | .PD |
| 725 | Specifies the foreground color to use when displaying selected |
| 726 | items. |
| 727 | .IP "Name: \fBsetGrid\fR" 4 |
| 728 | .IX Item "Name: setGrid" |
| 729 | .PD 0 |
| 730 | .IP "Class: \fBSetGrid\fR" 4 |
| 731 | .IX Item "Class: SetGrid" |
| 732 | .IP "Switch: \fB\-setgrid\fR" 4 |
| 733 | .IX Item "Switch: -setgrid" |
| 734 | .PD |
| 735 | Specifies a boolean value that determines whether this widget controls the |
| 736 | resizing grid for its top-level window. |
| 737 | This option is typically used in text widgets, where the information |
| 738 | in the widget has a natural size (the size of a character) and it makes |
| 739 | sense for the window's dimensions to be integral numbers of these units. |
| 740 | These natural window sizes form a grid. |
| 741 | If the \fBsetGrid\fR option is set to true then the widget will |
| 742 | communicate with the window manager so that when the user interactively |
| 743 | resizes the top-level window that contains the widget, the dimensions of |
| 744 | the window will be displayed to the user in grid units and the window |
| 745 | size will be constrained to integral numbers of grid units. |
| 746 | See \*(L"\s-1GRIDDED\s0 \s-1GEOMETRY\s0 \s-1MANAGEMENT\s0\*(R" in Tk::Wm |
| 747 | for more details. |
| 748 | .IP "Name: \fBtakeFocus\fR" 4 |
| 749 | .IX Item "Name: takeFocus" |
| 750 | .PD 0 |
| 751 | .IP "Class: \fBTakeFocus\fR" 4 |
| 752 | .IX Item "Class: TakeFocus" |
| 753 | .IP "Switch: \fB\-takefocus\fR" 4 |
| 754 | .IX Item "Switch: -takefocus" |
| 755 | .PD |
| 756 | Determines whether the window accepts the focus during keyboard |
| 757 | traversal (e.g., Tab and Shift\-Tab). |
| 758 | Before setting the focus to a window, the traversal scripts |
| 759 | consult the value of the \fBtakeFocus\fR option. |
| 760 | A value of \fB0\fR means that the window should be skipped entirely |
| 761 | during keyboard traversal. |
| 762 | \&\fB1\fR means that the window should receive the input |
| 763 | focus as long as it is viewable (it and all of its ancestors are mapped). |
| 764 | An empty value for the option means that the traversal scripts make |
| 765 | the decision about whether or not to focus on the window: the current |
| 766 | algorithm is to skip the window if it is |
| 767 | disabled, if it has no key bindings, or if it is not viewable. |
| 768 | If the value has any other form, then the traversal scripts take |
| 769 | the value, append the name of the window to it (with a separator space), |
| 770 | and evaluate the resulting string as a Callback. |
| 771 | The script must return \fB0\fR, \fB1\fR, or an empty string: a |
| 772 | \&\fB0\fR or \fB1\fR value specifies whether the window will receive |
| 773 | the input focus, and an empty string results in the default decision |
| 774 | described above. |
| 775 | Note: this interpretation of the option is defined entirely by |
| 776 | the Callbacks that implement traversal: the widget implementations |
| 777 | ignore the option entirely, so you can change its meaning if you |
| 778 | redefine the keyboard traversal scripts. |
| 779 | .IP "Name: \fBtext\fR" 4 |
| 780 | .IX Item "Name: text" |
| 781 | .PD 0 |
| 782 | .IP "Class: \fBText\fR" 4 |
| 783 | .IX Item "Class: Text" |
| 784 | .IP "Switch: \fB\-text\fR" 4 |
| 785 | .IX Item "Switch: -text" |
| 786 | .PD |
| 787 | Specifies a string to be displayed inside the widget. The way in which |
| 788 | the string is displayed depends on the particular widget and may be |
| 789 | determined by other options, such as \fBanchor\fR or \fBjustify\fR. |
| 790 | .IP "Name: \fBtextVariable\fR" 4 |
| 791 | .IX Item "Name: textVariable" |
| 792 | .PD 0 |
| 793 | .IP "Class: \fBVariable\fR" 4 |
| 794 | .IX Item "Class: Variable" |
| 795 | .IP "Switch: \fB\-textvariable\fR" 4 |
| 796 | .IX Item "Switch: -textvariable" |
| 797 | .PD |
| 798 | Specifies the name of a variable. The value of the variable is a text |
| 799 | string to be displayed inside the widget; if the variable value changes |
| 800 | then the widget will automatically update itself to reflect the new value. |
| 801 | The way in which the string is displayed in the widget depends on the |
| 802 | particular widget and may be determined by other options, such as |
| 803 | \&\fBanchor\fR or \fBjustify\fR. |
| 804 | .IP "Name: \fBtroughColor\fR" 4 |
| 805 | .IX Item "Name: troughColor" |
| 806 | .PD 0 |
| 807 | .IP "Class: \fBBackground\fR" 4 |
| 808 | .IX Item "Class: Background" |
| 809 | .IP "Switch: \fB\-troughcolor\fR" 4 |
| 810 | .IX Item "Switch: -troughcolor" |
| 811 | .PD |
| 812 | Specifies the color to use for the rectangular trough areas |
| 813 | in widgets such as scrollbars and scales. |
| 814 | .IP "Name: \fBtroughTile\fR" 4 |
| 815 | .IX Item "Name: troughTile" |
| 816 | .PD 0 |
| 817 | .IP "Class: \fBTile\fR" 4 |
| 818 | .IX Item "Class: Tile" |
| 819 | .IP "Switch: \fB\-troughtile\fR" 4 |
| 820 | .IX Item "Switch: -troughtile" |
| 821 | .PD |
| 822 | Specifies image used to display in the rectangular trough areas |
| 823 | in widgets such as scrollbars and scales. |
| 824 | .IP "Name: \fBunderline\fR" 4 |
| 825 | .IX Item "Name: underline" |
| 826 | .PD 0 |
| 827 | .IP "Class: \fBUnderline\fR" 4 |
| 828 | .IX Item "Class: Underline" |
| 829 | .IP "Switch: \fB\-underline\fR" 4 |
| 830 | .IX Item "Switch: -underline" |
| 831 | .PD |
| 832 | Specifies the integer index of a character to underline in the widget. |
| 833 | This option is used by the default bindings to implement keyboard |
| 834 | traversal for menu buttons and menu entries. |
| 835 | 0 corresponds to the first character of the text displayed in the |
| 836 | widget, 1 to the next character, and so on. |
| 837 | .IP "Name: \fBwrapLength\fR" 4 |
| 838 | .IX Item "Name: wrapLength" |
| 839 | .PD 0 |
| 840 | .IP "Class: \fBWrapLength\fR" 4 |
| 841 | .IX Item "Class: WrapLength" |
| 842 | .IP "Switch: \fB\-wraplength\fR" 4 |
| 843 | .IX Item "Switch: -wraplength" |
| 844 | .PD |
| 845 | For widgets that can perform word\-wrapping, this option specifies |
| 846 | the maximum line length. |
| 847 | Lines that would exceed this length are wrapped onto the next line, |
| 848 | so that no line is longer than the specified length. |
| 849 | The value may be specified in any of the standard forms for |
| 850 | screen distances. |
| 851 | If this value is less than or equal to 0 then no wrapping is done: lines |
| 852 | will break only at newline characters in the text. |
| 853 | .IP "Name: \fBxScrollCommand\fR" 4 |
| 854 | .IX Item "Name: xScrollCommand" |
| 855 | .PD 0 |
| 856 | .IP "Class: \fBScrollCommand\fR" 4 |
| 857 | .IX Item "Class: ScrollCommand" |
| 858 | .IP "Switch: \fB\-xscrollcommand\fR" 4 |
| 859 | .IX Item "Switch: -xscrollcommand" |
| 860 | .PD |
| 861 | Specifies a callback used to communicate with horizontal |
| 862 | scrollbars. |
| 863 | When the view in the widget's window changes (or |
| 864 | whenever anything else occurs that could change the display in a |
| 865 | scrollbar, such as a change in the total size of the widget's |
| 866 | contents), the widget will |
| 867 | make a callback passing two numeric arguments in addition to |
| 868 | any specified in the callback. |
| 869 | Each of the numbers is a fraction between 0 and 1, which indicates |
| 870 | a position in the document. 0 indicates the beginning of the document, |
| 871 | 1 indicates the end, .333 indicates a position one third the way through |
| 872 | the document, and so on. |
| 873 | The first fraction indicates the first information in the document |
| 874 | that is visible in the window, and the second fraction indicates |
| 875 | the information just after the last portion that is visible. |
| 876 | Typically the |
| 877 | \&\fBxScrollCommand\fR option consists of the scrollbar widget object |
| 878 | and the method ``set'' i.e. [\fBset\fR => \fI$sb\fR]: |
| 879 | this will cause the scrollbar to be updated whenever the view in the window changes. |
| 880 | If this option is not specified, then no command will be executed. |
| 881 | .IP "Name: \fByScrollCommand\fR" 4 |
| 882 | .IX Item "Name: yScrollCommand" |
| 883 | .PD 0 |
| 884 | .IP "Class: \fBScrollCommand\fR" 4 |
| 885 | .IX Item "Class: ScrollCommand" |
| 886 | .IP "Switch: \fB\-yscrollcommand\fR" 4 |
| 887 | .IX Item "Switch: -yscrollcommand" |
| 888 | .PD |
| 889 | Specifies a calback used to communicate with vertical |
| 890 | scrollbars. This option is treated in the same way as the |
| 891 | \&\fBxScrollCommand\fR option, except that it is used for vertical |
| 892 | scrollbars and is provided by widgets that support vertical scrolling. |
| 893 | See the description of \fBxScrollCommand\fR for details |
| 894 | on how this option is used. |
| 895 | .SH "SEE ALSO" |
| 896 | .IX Header "SEE ALSO" |
| 897 | Tk::option |
| 898 | Tk::callbacks |
| 899 | Tk::configspec |
| 900 | Tk_GetPixels |
| 901 | .SH "KEYWORDS" |
| 902 | .IX Header "KEYWORDS" |
| 903 | class, name, standard option, switch |