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 "NOTEBOOK 1" | |
| 132 | .TH NOTEBOOK 1 "2000-12-30" "perl v5.8.0" "User Contributed Perl Documentation" | |
| 133 | .SH "NAME" | |
| 134 | Tk::NoteBook \- display several windows in limited space with notebook metaphor. | |
| 135 | .SH "SYNOPSIS" | |
| 136 | .IX Header "SYNOPSIS" | |
| 137 | .Vb 7 | |
| 138 | \& use Tk::NoteBook; | |
| 139 | \& ... | |
| 140 | \& $w = $frame->NoteBook(); | |
| 141 | \& $page1 = $w->add("page1", options); | |
| 142 | \& $page2 = $w->add("page2", options); | |
| 143 | \& ... | |
| 144 | \& $page2 = $w->add("page2", options); | |
| 145 | .Ve | |
| 146 | .SH "DESCRIPTION" | |
| 147 | .IX Header "DESCRIPTION" | |
| 148 | The NoteBook widget provides a notebook metaphor to display several | |
| 149 | windows in limited space. The notebook is divided into a stack of pages | |
| 150 | of which only one is displayed at any time. The other pages can be | |
| 151 | selected by means of choosing the visual \*(L"tabs\*(R" at the top of the | |
| 152 | widget. Additionally, the <Tab> key may be used to traverse the pages. | |
| 153 | If \fB\-underline\fR is used, Alt\- bindings will also work. | |
| 154 | .PP | |
| 155 | The widget takes all the options that a Frame does. In addition, | |
| 156 | it supports the following options: | |
| 157 | .IP "\fB\-dynamicgeometry\fR" 4 | |
| 158 | .IX Item "-dynamicgeometry" | |
| 159 | If set to false (default and recommended), the size of the NoteBook | |
| 160 | will match the size of the largest page. Otherwise the size will | |
| 161 | match the size of the current page causing the NoteBook to change | |
| 162 | size when different pages of different sizes are selected. | |
| 163 | .IP "\fB\-ipadx\fR" 4 | |
| 164 | .IX Item "-ipadx" | |
| 165 | The amount of internal horizontal padding around the pages. | |
| 166 | .IP "\fB\-ipady\fR" 4 | |
| 167 | .IX Item "-ipady" | |
| 168 | The amount of internal vertical padding around the pages. | |
| 169 | .SH "METHODS" | |
| 170 | .IX Header "METHODS" | |
| 171 | The following methods may be used with a NoteBook object in addition | |
| 172 | to standard methods. | |
| 173 | .IP "\fBadd(\fR\fIpageName\fR, \fIoptions\fR\fB)\fR" 4 | |
| 174 | .IX Item "add(pageName, options)" | |
| 175 | Adds a page with name \fIpageName\fR to the notebook. Returns an object | |
| 176 | of type \fBFrame\fR. The recognized \fIoptions\fR are: | |
| 177 | .RS 4 | |
| 178 | .IP "\fB\-anchor\fR" 4 | |
| 179 | .IX Item "-anchor" | |
| 180 | Specifies how the information in a tab is to be displayed. Must be | |
| 181 | one of \fBn\fR, \fBne\fR, \fBe\fR, \fBse\fR, \fBs\fR, \fBsw\fR, \fBw\fR, \fBnw\fR or | |
| 182 | \&\fBcenter\fR. | |
| 183 | .IP "\fB\-bitmap\fR" 4 | |
| 184 | .IX Item "-bitmap" | |
| 185 | Specifies a bitmap to display on the tab of this page. The bitmap | |
| 186 | is displayed only if none of the \fB\-label\fR or \fB\-image\fR options | |
| 187 | are specified. | |
| 188 | .IP "\fB\-image\fR" 4 | |
| 189 | .IX Item "-image" | |
| 190 | Specifies an image to display on the tab of this page. The image | |
| 191 | is displayed only if the \fB\-label\fR option is not specified. | |
| 192 | .IP "\fB\-label\fR" 4 | |
| 193 | .IX Item "-label" | |
| 194 | Specifies the text string to display on the tab of this page. | |
| 195 | .IP "\fB\-justify\fR" 4 | |
| 196 | .IX Item "-justify" | |
| 197 | When there are multiple lines of text displayed in a tab, this | |
| 198 | option determines the justification of the lines. | |
| 199 | .IP "\fB\-createcmd\fR" 4 | |
| 200 | .IX Item "-createcmd" | |
| 201 | Specifies a callback to be called the first time the page is | |
| 202 | shown on the screen. This option can be used to delay the creation | |
| 203 | of the contents of a page until necessary. It can be useful in | |
| 204 | situations where there are a large number of pages in a NoteBook | |
| 205 | widget; with \fB\-createcmd\fR you do not have to make the user wait | |
| 206 | until all pages are constructed before displaying the first page. | |
| 207 | .IP "\fB\-raisecmd\fR" 4 | |
| 208 | .IX Item "-raisecmd" | |
| 209 | Specifies a callback to be called whenever this page is raised | |
| 210 | by the user. | |
| 211 | .IP "\fB\-state\fR" 4 | |
| 212 | .IX Item "-state" | |
| 213 | Specifies whether this page can be raised by the user. Must be | |
| 214 | either \fBnormal\fR or \fBdisabled\fR. | |
| 215 | .IP "\fB\-underline\fR" 4 | |
| 216 | .IX Item "-underline" | |
| 217 | Specifies the integer index of a character to underline in the | |
| 218 | tab. This option is used by the default bindings to implement | |
| 219 | keyboard traversal for menu buttons and menu entries. 0 | |
| 220 | corresponds to the first character of text displayed on the | |
| 221 | widget, 1 to the next character and so on. | |
| 222 | .IP "\fB\-wraplength\fR" 4 | |
| 223 | .IX Item "-wraplength" | |
| 224 | This option specifies the maximum line length of the label string | |
| 225 | on this tab. If the line length of the label string exceeds this | |
| 226 | length, then it is wrapped onto the next line so that no line is | |
| 227 | longer than the specified length. The value may be specified in | |
| 228 | any standard forms for screen distances. If this value is less | |
| 229 | than or equal to 0, then no wrapping is done: lines will break | |
| 230 | only at newline characters in the text. | |
| 231 | .RE | |
| 232 | .RS 4 | |
| 233 | .RE | |
| 234 | .IP "\fBdelete(\fR\fIpageName\fR\fB)\fR" 4 | |
| 235 | .IX Item "delete(pageName)" | |
| 236 | Deletes the page identified by \fIpageName\fR. | |
| 237 | .IP "\fBpagecget(\fR\fIpageName\fR, \fI\-option\fR\fB)\fR" 4 | |
| 238 | .IX Item "pagecget(pageName, -option)" | |
| 239 | Returns the current value of the configuration option given by | |
| 240 | \&\fI\-option\fR in the page given by \fIpageName\fR. \fIOption\fR may have any of | |
| 241 | the values accepted in the \fBadd\fR method. | |
| 242 | .IP "\fBpageconfigure(\fR\fIpageName\fR, \fIoptions\fR\fB)\fR" 4 | |
| 243 | .IX Item "pageconfigure(pageName, options)" | |
| 244 | Like configure for the page indicated by \fIpageName\fR. \fIOptions\fR may | |
| 245 | be any of the options accepted by the \fBadd\fR method. | |
| 246 | .IP "\fBraise(\fR\fIpageName\fR\fB)\fR" 4 | |
| 247 | .IX Item "raise(pageName)" | |
| 248 | Raise the page identified by \fIpageName\fR. | |
| 249 | .IP "\fB\f(BIraised()\fB\fR" 4 | |
| 250 | .IX Item "raised()" | |
| 251 | Returns the name of the currently raised page. | |
| 252 | .SH "AUTHORS" | |
| 253 | .IX Header "AUTHORS" | |
| 254 | \&\fBRajappa Iyer\fR <rsi@earthling.net> | |
| 255 | Nick Ing-Simmons <nick@ni\-s.u\-net.com> | |
| 256 | .PP | |
| 257 | This code and documentation was derived from NoteBook.tcl in | |
| 258 | Tix4.0 written by Ioi Lam. It may be distributed under the same | |
| 259 | conditions as Perl itself. |