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::Pane 3" | |
| 132 | .TH Tk::Pane 3 "2000-12-30" "Tk800.023" "perl/Tk Documentation" | |
| 133 | .SH "NAME" | |
| 134 | Tk::Pane \- A window panner | |
| 135 | .SH "SYNOPSIS" | |
| 136 | .IX Header "SYNOPSIS" | |
| 137 | .Vb 1 | |
| 138 | \& use Tk::Pane; | |
| 139 | .Ve | |
| 140 | .PP | |
| 141 | .Vb 5 | |
| 142 | \& $pane = $mw->Scrolled(Pane, Name => 'fred', | |
| 143 | \& -scrollbars => 'soe', | |
| 144 | \& -sticky => 'we', | |
| 145 | \& -gridded => 'y' | |
| 146 | \& ); | |
| 147 | .Ve | |
| 148 | .PP | |
| 149 | .Vb 1 | |
| 150 | \& $pane->Frame; | |
| 151 | .Ve | |
| 152 | .PP | |
| 153 | .Vb 1 | |
| 154 | \& $pane->pack; | |
| 155 | .Ve | |
| 156 | .SH "DESCRIPTION" | |
| 157 | .IX Header "DESCRIPTION" | |
| 158 | \&\fBTk::Pane\fR provides a scrollable frame widget. Once created it can be | |
| 159 | treated as a frame, except it is scrollable. | |
| 160 | .SH "OPTIONS" | |
| 161 | .IX Header "OPTIONS" | |
| 162 | .IP "\fB\-gridded\fR => \fIdirection\fR" 4 | |
| 163 | .IX Item "-gridded => direction" | |
| 164 | Specifies if the top and left edges of the pane should snap to a | |
| 165 | grid column. This option is only useful if the widgets in the pane | |
| 166 | are managed by the \fIgrid\fR geometry manager. Possible values are | |
| 167 | \&\fBx\fR, \fBy\fR and \fBxy\fR. | |
| 168 | .IP "\fB\-sticky\fR => \fIstyle\fR" 4 | |
| 169 | .IX Item "-sticky => style" | |
| 170 | If Pane is larger than its requested dimensions, this option may be used to | |
| 171 | position (or stretch) the slave within its cavity. \fIStyle\fR is a string that | |
| 172 | contains zero or more of the characters n, s, e or w. The string can optionally | |
| 173 | contains spaces or commas, but they are ignored. Each letter refers to a side | |
| 174 | (north, south, east, or west) that the slave will \*(L"stick\*(R" to. If both n and s | |
| 175 | (or e and w) are specified, the slave will be stretched to fill the entire | |
| 176 | height (or width) of its cavity. | |
| 177 | .SH "METHODS" | |
| 178 | .IX Header "METHODS" | |
| 179 | .IP "\fI$pane\fR\->\fBsee\fR(\fI$widget\fR ?,\fIoptions\fR?)" 4 | |
| 180 | .IX Item "$pane->see($widget ?,options?)" | |
| 181 | Adjusts the view so that \fI$widget\fR is visable. Aditional parameters in | |
| 182 | \&\fIoptions-value\fR pairs can be passed, each \fIoption-value\fR pair must be | |
| 183 | one of the following | |
| 184 | .RS 4 | |
| 185 | .IP "\fB\-anchor\fR => \fIanchor\fR" 8 | |
| 186 | .IX Item "-anchor => anchor" | |
| 187 | Specifies how to make the widget visable. If not given then as much of | |
| 188 | the widget as possible is made visable. | |
| 189 | .Sp | |
| 190 | Possible values are \fBn\fR, \fBs\fR, \fBw\fR, \fBe\fR, \fBnw\fR, \fBne\fR, \fBsw\fR and \fBse\fR. | |
| 191 | This will cause an edge on the widget to be aligned with the corresponding | |
| 192 | edge on the pane. for example \fBnw\fR will cause the top left of the widget | |
| 193 | to be placed at the top left of the pane. \fBs\fR will cause the bottom of the | |
| 194 | widget to be placed at the bottom of the pane, and as much of the widget | |
| 195 | as possible made visable in the x direction. | |
| 196 | .RE | |
| 197 | .RS 4 | |
| 198 | .RE | |
| 199 | .IP "\fI$pane\fR\->\fBxview\fR" 4 | |
| 200 | .IX Item "$pane->xview" | |
| 201 | Returns a list containing two elements, both of which are real fractions | |
| 202 | between 0 and 1. The first element gives the position of the left of the | |
| 203 | window, relative to the Pane as a whole (0.5 means it is halfway through the | |
| 204 | Pane, for example). The second element gives the position of the right of the | |
| 205 | window, relative to the Pane as a whole. | |
| 206 | .IP "\fI$pane\fR\->\fBxview\fR(\fI$widget\fR)" 4 | |
| 207 | .IX Item "$pane->xview($widget)" | |
| 208 | Adjusts the view in the window so that \fIwidget\fR is displayed at the left of | |
| 209 | the window. | |
| 210 | .IP "\fI$pane\fR\->\fBxview\fR(\fBmoveto\fR => \fIfraction\fR)" 4 | |
| 211 | .IX Item "$pane->xview(moveto => fraction)" | |
| 212 | Adjusts the view in the window so that \fIfraction\fR of the total width of the | |
| 213 | Pane is off-screen to the left. fraction must be a fraction between 0 and 1. | |
| 214 | .IP "\fI$pane\fR\->\fBxview\fR(\fBscroll\fR => \fInumber\fR, \fIwhat\fR)" 4 | |
| 215 | .IX Item "$pane->xview(scroll => number, what)" | |
| 216 | This command shifts the view in the window left or right according to \fInumber\fR | |
| 217 | and \fIwhat\fR. \fINumber\fR must be an integer. \fIWhat\fR must be either \fBunits\fR or | |
| 218 | \&\fBpages\fR or an abbreviation of one of these. If \fIwhat\fR is \fBunits\fR, the view | |
| 219 | adjusts left or right by \fInumber\fR*10 screen units on the display; if it is | |
| 220 | \&\fBpages\fR then the view adjusts by number screenfuls. If number is negative then | |
| 221 | widgets farther to the left become visible; if it is positive then widgets | |
| 222 | farther to the right become visible. | |
| 223 | .IP "\fI$pane\fR\->\fByview\fR" 4 | |
| 224 | .IX Item "$pane->yview" | |
| 225 | Returns a list containing two elements, both of which are real fractions | |
| 226 | between 0 and 1. The first element gives the position of the top of the | |
| 227 | window, relative to the Pane as a whole (0.5 means it is halfway through the | |
| 228 | Pane, for example). The second element gives the position of the bottom of the | |
| 229 | window, relative to the Pane as a whole. | |
| 230 | .IP "\fI$pane\fR\->\fByview\fR(\fI$widget\fR)" 4 | |
| 231 | .IX Item "$pane->yview($widget)" | |
| 232 | Adjusts the view in the window so that \fIwidget\fR is displayed at the top of the | |
| 233 | window. | |
| 234 | .IP "\fI$pane\fR\->\fByview\fR(\fBmoveto\fR => \fIfraction\fR)" 4 | |
| 235 | .IX Item "$pane->yview(moveto => fraction)" | |
| 236 | Adjusts the view in the window so that \fIfraction\fR of the total width of the | |
| 237 | Pane is off-screen to the top. fraction must be a fraction between 0 and 1. | |
| 238 | .IP "\fI$pane\fR\->\fByview\fR(\fBscroll\fR => \fInumber\fR, \fIwhat\fR)" 4 | |
| 239 | .IX Item "$pane->yview(scroll => number, what)" | |
| 240 | This command shifts the view in the window up or down according to \fInumber\fR | |
| 241 | and \fIwhat\fR. \fINumber\fR must be an integer. \fIWhat\fR must be either \fBunits\fR or | |
| 242 | \&\fBpages\fR or an abbreviation of one of these. If \fIwhat\fR is \fBunits\fR, the view | |
| 243 | adjusts up or down by \fInumber\fR*10 screen units on the display; if it is | |
| 244 | \&\fBpages\fR then the view adjusts by number screenfuls. If number is negative then | |
| 245 | widgets farther up become visible; if it is positive then widgets farther down | |
| 246 | become visible. | |
| 247 | .SH "AUTHOR" | |
| 248 | .IX Header "AUTHOR" | |
| 249 | Graham Barr <\fIgbarr@pobox.com\fR> | |
| 250 | .SH "COPYRIGHT" | |
| 251 | .IX Header "COPYRIGHT" | |
| 252 | Copyright (c) 1997\-1998 Graham Barr. All rights reserved. | |
| 253 | This program is free software; you can redistribute it and/or modify it | |
| 254 | under the same terms as Perl itself. |