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 "TOPLEVEL 1" | |
| 132 | .TH TOPLEVEL 1 "2000-12-30" "perl v5.8.0" "User Contributed Perl Documentation" | |
| 133 | .SH "NAME" | |
| 134 | Tk::Toplevel \- Create and manipulate Toplevel widgets | |
| 135 | .SH "SYNOPSIS" | |
| 136 | .IX Header "SYNOPSIS" | |
| 137 | \&\ \fI$toplevel\fR = \fI$parent\fR\->\fBToplevel\fR(?\fIoptions\fR?); | |
| 138 | .SH "STANDARD OPTIONS" | |
| 139 | .IX Header "STANDARD OPTIONS" | |
| 140 | \&\fB\-borderwidth\fR \fB\-highlightbackground\fR \fB\-highlightthickness\fR \fB\-takefocus\fR | |
| 141 | \&\fB\-class\fR \fB\-highlightcolor\fR \fB\-relief\fR | |
| 142 | \&\fB\-cursor\fR | |
| 143 | .PP | |
| 144 | See Tk::options for details of the standard options. | |
| 145 | .SH "WIDGET-SPECIFIC OPTIONS" | |
| 146 | .IX Header "WIDGET-SPECIFIC OPTIONS" | |
| 147 | .IP "Name: \fBbackground\fR" 4 | |
| 148 | .IX Item "Name: background" | |
| 149 | .PD 0 | |
| 150 | .IP "Class: \fBBackground\fR" 4 | |
| 151 | .IX Item "Class: Background" | |
| 152 | .IP "Switch: \fB\-background\fR" 4 | |
| 153 | .IX Item "Switch: -background" | |
| 154 | .PD | |
| 155 | This option is the same as the standard \fBbackground\fR option | |
| 156 | except that its value may also be specified as an undefined value. | |
| 157 | In this case, the widget will display no background or border, and | |
| 158 | no colors will be consumed from its colormap for its background | |
| 159 | and border. | |
| 160 | .IP "Name: \fBcolormap\fR" 4 | |
| 161 | .IX Item "Name: colormap" | |
| 162 | .PD 0 | |
| 163 | .IP "Class: \fBColormap\fR" 4 | |
| 164 | .IX Item "Class: Colormap" | |
| 165 | .IP "Switch: \fB\-colormap\fR" 4 | |
| 166 | .IX Item "Switch: -colormap" | |
| 167 | .PD | |
| 168 | Specifies a colormap to use for the window. | |
| 169 | The value may be either \fBnew\fR, in which case a new colormap is | |
| 170 | created for the window and its children, or the name of another | |
| 171 | window (which must be on the same screen and have the same visual | |
| 172 | as \f(CW$widget\fR), in which case the new window will use the colormap | |
| 173 | from the specified window. | |
| 174 | If the \fBcolormap\fR option is not specified, the new window | |
| 175 | uses the default colormap of its screen. | |
| 176 | This option may not be changed with the \fBconfigure\fR | |
| 177 | method. | |
| 178 | .IP "Name: \fBcontainer\fR" 4 | |
| 179 | .IX Item "Name: container" | |
| 180 | .PD 0 | |
| 181 | .IP "Class: \fBContainer\fR" 4 | |
| 182 | .IX Item "Class: Container" | |
| 183 | .IP "Switch: \fB\-container\fR" 4 | |
| 184 | .IX Item "Switch: -container" | |
| 185 | .PD | |
| 186 | The value must be a boolean. If true, it means that this window will | |
| 187 | be used as a container in which some other application will be embedded | |
| 188 | (for example, a Tk toplevel can be embedded using the \fB\-use\fR option). | |
| 189 | The window will support the appropriate window manager protocols for | |
| 190 | things like geometry requests. The window should not have any | |
| 191 | children of its own in this application. | |
| 192 | This option may not be changed with the \fBconfigure\fR | |
| 193 | method. | |
| 194 | .IP "Name: \fBheight\fR" 4 | |
| 195 | .IX Item "Name: height" | |
| 196 | .PD 0 | |
| 197 | .IP "Class: \fBHeight\fR" 4 | |
| 198 | .IX Item "Class: Height" | |
| 199 | .IP "Switch: \fB\-height\fR" 4 | |
| 200 | .IX Item "Switch: -height" | |
| 201 | .PD | |
| 202 | Specifies the desired height for the window in any of the forms | |
| 203 | acceptable to \fBTk_GetPixels\fR. | |
| 204 | If this option is less than or equal to zero then the window will | |
| 205 | not request any size at all. | |
| 206 | .IP "Name: \fBmenu\fR" 4 | |
| 207 | .IX Item "Name: menu" | |
| 208 | .PD 0 | |
| 209 | .IP "Class: \fBMenu\fR" 4 | |
| 210 | .IX Item "Class: Menu" | |
| 211 | .IP "Switch: \fB\-menu\fR" 4 | |
| 212 | .IX Item "Switch: -menu" | |
| 213 | .PD | |
| 214 | Specifies a menu widget to be used as a menubar. On the Macintosh, the | |
| 215 | menubar will be displayed accross the top of the main monitor. On | |
| 216 | Microsoft Windows and all \s-1UNIX\s0 platforms, the menu will appear accross | |
| 217 | the toplevel window as part of the window dressing maintained by the | |
| 218 | window manager. | |
| 219 | .ie n .IP "Name: \fB""""\fR" 4 | |
| 220 | .el .IP "Name: \fB``''\fR" 4 | |
| 221 | .IX Item "Name: """"" | |
| 222 | .PD 0 | |
| 223 | .ie n .IP "Class: \fB""""\fR" 4 | |
| 224 | .el .IP "Class: \fB``''\fR" 4 | |
| 225 | .IX Item "Class: """"" | |
| 226 | .IP "Switch: \fB\-screen\fR" 4 | |
| 227 | .IX Item "Switch: -screen" | |
| 228 | .PD | |
| 229 | Specifies the screen on which to place the new window. | |
| 230 | Any valid screen name may be used, even one associated with a | |
| 231 | different display. | |
| 232 | Defaults to the same screen as its parent. | |
| 233 | This option is special in that it may not be specified via the option | |
| 234 | database, and it may not be modified with the \fBconfigure\fR | |
| 235 | method. | |
| 236 | .IP "Name: \fBuse\fR" 4 | |
| 237 | .IX Item "Name: use" | |
| 238 | .PD 0 | |
| 239 | .IP "Class: \fBUse\fR" 4 | |
| 240 | .IX Item "Class: Use" | |
| 241 | .IP "Switch: \fB\-use\fR" 4 | |
| 242 | .IX Item "Switch: -use" | |
| 243 | .PD | |
| 244 | This option is used for embedding. If the value isn't an empty string, | |
| 245 | it must be the the window identifier of a container window, specified as | |
| 246 | a hexadecimal string like the ones returned by the \fBwinfo id\fR | |
| 247 | command. The toplevel widget will be created as a child of the given | |
| 248 | container instead of the root window for the screen. If the container | |
| 249 | window is in a Tk application, it must be a frame or toplevel widget for | |
| 250 | which the \fB\-container\fR option was specified. | |
| 251 | This option may not be changed with the \fBconfigure\fR | |
| 252 | method. | |
| 253 | .IP "Name: \fBvisual\fR" 4 | |
| 254 | .IX Item "Name: visual" | |
| 255 | .PD 0 | |
| 256 | .IP "Class: \fBVisual\fR" 4 | |
| 257 | .IX Item "Class: Visual" | |
| 258 | .IP "Switch: \fB\-visual\fR" 4 | |
| 259 | .IX Item "Switch: -visual" | |
| 260 | .PD | |
| 261 | Specifies visual information for the new window in any of the | |
| 262 | forms accepted by \fBTk_GetVisual\fR. | |
| 263 | If this option is not specified, the new window will use the default | |
| 264 | visual for its screen. | |
| 265 | The \fBvisual\fR option may not be modified with the \fBconfigure\fR | |
| 266 | method. | |
| 267 | .IP "Name: \fBwidth\fR" 4 | |
| 268 | .IX Item "Name: width" | |
| 269 | .PD 0 | |
| 270 | .IP "Class: \fBWidth\fR" 4 | |
| 271 | .IX Item "Class: Width" | |
| 272 | .IP "Switch: \fB\-width\fR" 4 | |
| 273 | .IX Item "Switch: -width" | |
| 274 | .PD | |
| 275 | Specifies the desired width for the window in any of the forms | |
| 276 | acceptable to \fBTk_GetPixels\fR. | |
| 277 | If this option is less than or equal to zero then the window will | |
| 278 | not request any size at all. | |
| 279 | .SH "DESCRIPTION" | |
| 280 | .IX Header "DESCRIPTION" | |
| 281 | The \fBToplevel\fR method creates a new toplevel widget (given | |
| 282 | by the \f(CW$widget\fR argument). Additional | |
| 283 | options, described above, may be specified on the command line | |
| 284 | or in the option database | |
| 285 | to configure aspects of the toplevel such as its background color | |
| 286 | and relief. The \fBtoplevel\fR command returns the | |
| 287 | path name of the new window. | |
| 288 | .PP | |
| 289 | A toplevel is similar to a frame except that it is created as a | |
| 290 | top-level window: its X parent is the root window of a screen | |
| 291 | rather than the logical parent from its path name. The primary | |
| 292 | purpose of a toplevel is to serve as a container for dialog boxes | |
| 293 | and other collections of widgets. The only visible features | |
| 294 | of a toplevel are its background color and an optional 3\-D border | |
| 295 | to make the toplevel appear raised or sunken. | |
| 296 | .SH "WIDGET METHODS" | |
| 297 | .IX Header "WIDGET METHODS" | |
| 298 | The \fBToplevel\fR method creates a widget object. | |
| 299 | This object supports the \fBconfigure\fR and \fBcget\fR methods | |
| 300 | described in Tk::options which can be used to enquire and | |
| 301 | modify the options described above. | |
| 302 | The widget also inherits all the methods provided by the generic | |
| 303 | Tk::Widget class, and the Tk::Wm class. | |
| 304 | .SH "BINDINGS" | |
| 305 | .IX Header "BINDINGS" | |
| 306 | When a new toplevel is created, it has no default event bindings: | |
| 307 | toplevels are not intended to be interactive. | |
| 308 | .SH "SEE ALSO" | |
| 309 | .IX Header "SEE ALSO" | |
| 310 | Tk::Widget | |
| 311 | Tk::Wm | |
| 312 | .SH "KEYWORDS" | |
| 313 | .IX Header "KEYWORDS" | |
| 314 | toplevel, widget |