projects / OpenSPARC-T2-DV / blame
| Commit | Line | Data |
|---|---|---|
| 86530b38 AT |
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 "Tk::ProgressBar 3" | |
| 132 | .TH Tk::ProgressBar 3 "2000-12-30" "Tk800.023" "perl/Tk Documentation" | |
| 133 | .SH "NAME" | |
| 134 | Tk::ProgressBar \- A graphical progress bar | |
| 135 | .SH "SYNOPSIS" | |
| 136 | .IX Header "SYNOPSIS" | |
| 137 | .Vb 1 | |
| 138 | \& use Tk::ProgressBar; | |
| 139 | .Ve | |
| 140 | .PP | |
| 141 | .Vb 10 | |
| 142 | \& $progress = $parent->ProgressBar( | |
| 143 | \& -width => 200, | |
| 144 | \& -length => 20, | |
| 145 | \& -anchor => 's', | |
| 146 | \& -from => 0, | |
| 147 | \& -to => 100, | |
| 148 | \& -blocks => 10, | |
| 149 | \& -colors => [0, 'green', 50, 'yellow' , 80, 'red'], | |
| 150 | \& -variable => \e$percent_done | |
| 151 | \& ); | |
| 152 | .Ve | |
| 153 | .PP | |
| 154 | .Vb 1 | |
| 155 | \& $progress->value($position); | |
| 156 | .Ve | |
| 157 | .SH "DESCRIPTION" | |
| 158 | .IX Header "DESCRIPTION" | |
| 159 | \&\fBTk::ProgressBar\fR provides a widget which will show a graphical representation | |
| 160 | of a value, given maximum and minimum reference values. | |
| 161 | .SH "STANDARD OPTIONS" | |
| 162 | .IX Header "STANDARD OPTIONS" | |
| 163 | The following standard widget options are supported: | |
| 164 | .IP "\fB\-borderwidth\fR" 4 | |
| 165 | .IX Item "-borderwidth" | |
| 166 | .PD 0 | |
| 167 | .IP "\fB\-highlightthickness\fR" 4 | |
| 168 | .IX Item "-highlightthickness" | |
| 169 | .PD | |
| 170 | Defaults to 0. | |
| 171 | .IP "\fB\-padx\fR" 4 | |
| 172 | .IX Item "-padx" | |
| 173 | Defaults to 0. | |
| 174 | .IP "\fB\-pady\fR" 4 | |
| 175 | .IX Item "-pady" | |
| 176 | Defaults to 0. | |
| 177 | .IP "\fB\-relief\fR" 4 | |
| 178 | .IX Item "-relief" | |
| 179 | Defaults to \f(CW\*(C`sunken\*(C'\fR | |
| 180 | .IP "\fB\-troughcolor\fR" 4 | |
| 181 | .IX Item "-troughcolor" | |
| 182 | The color to be used for the background (trough) of the progress bar. | |
| 183 | Default is to use grey55. | |
| 184 | .SH "WIDGET-SPECIFIC OPTIONS" | |
| 185 | .IX Header "WIDGET-SPECIFIC OPTIONS" | |
| 186 | .IP "\fB\-anchor\fR" 4 | |
| 187 | .IX Item "-anchor" | |
| 188 | This can be used to position the start point of the bar. Default | |
| 189 | is 'w' (horizontal bar starting from the left). A vertical bar can be | |
| 190 | configured by using either 's' or 'n'. | |
| 191 | .IP "\fB\-blocks\fR" 4 | |
| 192 | .IX Item "-blocks" | |
| 193 | This controls the number of blocks to be used to construct the progress | |
| 194 | bar. The default is to break the bar into 10 blocks. | |
| 195 | .IP "\fB\-colors\fR" 4 | |
| 196 | .IX Item "-colors" | |
| 197 | Controls the colors to be used for different positions of the progress bar. | |
| 198 | The colors should be supplied as a reference to an array containing pairs | |
| 199 | of positions and colors. | |
| 200 | .Sp | |
| 201 | .Vb 1 | |
| 202 | \& -colors => [ 0, 'green', 50, 'red' ] | |
| 203 | .Ve | |
| 204 | .Sp | |
| 205 | means that for the range 0 to 50 the progress bar should be green | |
| 206 | and for higher values it should be red. | |
| 207 | .IP "\fB\-from\fR" 4 | |
| 208 | .IX Item "-from" | |
| 209 | This sets the lower limit of the progress bar. If the bar is set to a | |
| 210 | value below the lower limt no bar will be displayed. Defaults to 0. | |
| 211 | See the \f(CW\*(C`\-to\*(C'\fR description for more information. | |
| 212 | .IP "\fB\-gap\fR" 4 | |
| 213 | .IX Item "-gap" | |
| 214 | This is the spacing (in pixels) between each block. Defaults to 1. | |
| 215 | Use 0 to get a continuous bar. | |
| 216 | .IP "\fB\-length\fR" 4 | |
| 217 | .IX Item "-length" | |
| 218 | Specifies the desired long dimension of the ProgressBar in screen | |
| 219 | units (i.e. any of the forms acceptable to Tk_GetPixels). For vertical | |
| 220 | ProgressBars this is the ProgressBars height; for horizontal scales it | |
| 221 | is the ProgressBars width. The default length is calculated from the | |
| 222 | values of \f(CW\*(C`\-padx\*(C'\fR, \f(CW\*(C`\-borderwidth\*(C'\fR, \f(CW\*(C`\-highlightthickness\*(C'\fR and the | |
| 223 | difference between \f(CW\*(C`\-from\*(C'\fR and \f(CW\*(C`\-to\*(C'\fR. | |
| 224 | .IP "\fB\-resolution\fR" 4 | |
| 225 | .IX Item "-resolution" | |
| 226 | A real value specifying the resolution for the scale. If this value is greater | |
| 227 | than zero then the scale's value will always be rounded to an even multiple of | |
| 228 | this value, as will tick marks and the endpoints of the scale. If the value is | |
| 229 | less than zero then no rounding occurs. Defaults to 1 (i.e., the value will be | |
| 230 | integral). | |
| 231 | .IP "\fB\-to\fR" 4 | |
| 232 | .IX Item "-to" | |
| 233 | This sets the upper limit of the progress bar. If a value is specified | |
| 234 | (for example, using the \f(CW\*(C`value\*(C'\fR method) that lies above this value the | |
| 235 | full progress bar will be displayed. Defaults to 100. | |
| 236 | .IP "\fB\-variable\fR" 4 | |
| 237 | .IX Item "-variable" | |
| 238 | Specifies the reference to a scalar variable to link to the ProgressBar. | |
| 239 | Whenever the value of the variable changes, the ProgressBar will upate | |
| 240 | to reflect this value. (See also the \fBvalue\fR method below.) | |
| 241 | .IP "\fB\-value\fR" 4 | |
| 242 | .IX Item "-value" | |
| 243 | The can be used to set the current position of the progress bar | |
| 244 | when used in conjunction with the standard \f(CW\*(C`configure\*(C'\fR. It is | |
| 245 | usually recommended to use the \fBvalue\fR method instead. | |
| 246 | .IP "\fB\-width\fR" 4 | |
| 247 | .IX Item "-width" | |
| 248 | Specifies the desired narrow dimension of the ProgressBar in screen | |
| 249 | units (i.e. any of the forms acceptable to Tk_GetPixels). For | |
| 250 | vertical ProgressBars this is the ProgressBars width; for horizontal | |
| 251 | bars this is the ProgressBars height. The default width is derived | |
| 252 | from the values of \f(CW\*(C`\-borderwidth\*(C'\fR and \f(CW\*(C`\-pady\*(C'\fR and \f(CW\*(C`\-highlightthickness\*(C'\fR. | |
| 253 | .SH "WIDGET METHODS" | |
| 254 | .IX Header "WIDGET METHODS" | |
| 255 | .IP "\fI$ProgressBar\fR\->\fBvalue\fR(?\fIvalue\fR?)" 4 | |
| 256 | .IX Item "$ProgressBar->value(?value?)" | |
| 257 | If \fIvalue\fR is omitted, returns the current value of the ProgressBar. If | |
| 258 | \&\fIvalue\fR is given, the value of the ProgressBar is set. If \fI$value\fR is | |
| 259 | given but undefined the value of the option \fB\-from\fR is used. | |
| 260 | .SH "AUTHOR" | |
| 261 | .IX Header "AUTHOR" | |
| 262 | Graham Barr <\fIgbarr@pobox.com\fR> | |
| 263 | .SH "COPYRIGHT" | |
| 264 | .IX Header "COPYRIGHT" | |
| 265 | Copyright (c) 1997\-1998 Graham Barr. All rights reserved. | |
| 266 | This program is free software; you can redistribute it and/or modify it | |
| 267 | under the same terms as Perl itself. |