| 1 | '\" |
| 2 | '\" Copyright (c) 1990-1994 The Regents of the University of California. |
| 3 | '\" Copyright (c) 1994-1996 Sun Microsystems, Inc. |
| 4 | '\" |
| 5 | '\" See the file "license.terms" for information on usage and redistribution |
| 6 | '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. |
| 7 | '\" |
| 8 | '\" RCS: @(#) $Id: pack-old.n,v 1.2.26.1 2004/11/19 09:48:02 rmax Exp $ |
| 9 | '\" |
| 10 | '\" The definitions below are for supplemental macros used in Tcl/Tk |
| 11 | '\" manual entries. |
| 12 | '\" |
| 13 | '\" .AP type name in/out ?indent? |
| 14 | '\" Start paragraph describing an argument to a library procedure. |
| 15 | '\" type is type of argument (int, etc.), in/out is either "in", "out", |
| 16 | '\" or "in/out" to describe whether procedure reads or modifies arg, |
| 17 | '\" and indent is equivalent to second arg of .IP (shouldn't ever be |
| 18 | '\" needed; use .AS below instead) |
| 19 | '\" |
| 20 | '\" .AS ?type? ?name? |
| 21 | '\" Give maximum sizes of arguments for setting tab stops. Type and |
| 22 | '\" name are examples of largest possible arguments that will be passed |
| 23 | '\" to .AP later. If args are omitted, default tab stops are used. |
| 24 | '\" |
| 25 | '\" .BS |
| 26 | '\" Start box enclosure. From here until next .BE, everything will be |
| 27 | '\" enclosed in one large box. |
| 28 | '\" |
| 29 | '\" .BE |
| 30 | '\" End of box enclosure. |
| 31 | '\" |
| 32 | '\" .CS |
| 33 | '\" Begin code excerpt. |
| 34 | '\" |
| 35 | '\" .CE |
| 36 | '\" End code excerpt. |
| 37 | '\" |
| 38 | '\" .VS ?version? ?br? |
| 39 | '\" Begin vertical sidebar, for use in marking newly-changed parts |
| 40 | '\" of man pages. The first argument is ignored and used for recording |
| 41 | '\" the version when the .VS was added, so that the sidebars can be |
| 42 | '\" found and removed when they reach a certain age. If another argument |
| 43 | '\" is present, then a line break is forced before starting the sidebar. |
| 44 | '\" |
| 45 | '\" .VE |
| 46 | '\" End of vertical sidebar. |
| 47 | '\" |
| 48 | '\" .DS |
| 49 | '\" Begin an indented unfilled display. |
| 50 | '\" |
| 51 | '\" .DE |
| 52 | '\" End of indented unfilled display. |
| 53 | '\" |
| 54 | '\" .SO |
| 55 | '\" Start of list of standard options for a Tk widget. The |
| 56 | '\" options follow on successive lines, in four columns separated |
| 57 | '\" by tabs. |
| 58 | '\" |
| 59 | '\" .SE |
| 60 | '\" End of list of standard options for a Tk widget. |
| 61 | '\" |
| 62 | '\" .OP cmdName dbName dbClass |
| 63 | '\" Start of description of a specific option. cmdName gives the |
| 64 | '\" option's name as specified in the class command, dbName gives |
| 65 | '\" the option's name in the option database, and dbClass gives |
| 66 | '\" the option's class in the option database. |
| 67 | '\" |
| 68 | '\" .UL arg1 arg2 |
| 69 | '\" Print arg1 underlined, then print arg2 normally. |
| 70 | '\" |
| 71 | '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $ |
| 72 | '\" |
| 73 | '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. |
| 74 | .if t .wh -1.3i ^B |
| 75 | .nr ^l \n(.l |
| 76 | .ad b |
| 77 | '\" # Start an argument description |
| 78 | .de AP |
| 79 | .ie !"\\$4"" .TP \\$4 |
| 80 | .el \{\ |
| 81 | . ie !"\\$2"" .TP \\n()Cu |
| 82 | . el .TP 15 |
| 83 | .\} |
| 84 | .ta \\n()Au \\n()Bu |
| 85 | .ie !"\\$3"" \{\ |
| 86 | \&\\$1 \\fI\\$2\\fP (\\$3) |
| 87 | .\".b |
| 88 | .\} |
| 89 | .el \{\ |
| 90 | .br |
| 91 | .ie !"\\$2"" \{\ |
| 92 | \&\\$1 \\fI\\$2\\fP |
| 93 | .\} |
| 94 | .el \{\ |
| 95 | \&\\fI\\$1\\fP |
| 96 | .\} |
| 97 | .\} |
| 98 | .. |
| 99 | '\" # define tabbing values for .AP |
| 100 | .de AS |
| 101 | .nr )A 10n |
| 102 | .if !"\\$1"" .nr )A \\w'\\$1'u+3n |
| 103 | .nr )B \\n()Au+15n |
| 104 | .\" |
| 105 | .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n |
| 106 | .nr )C \\n()Bu+\\w'(in/out)'u+2n |
| 107 | .. |
| 108 | .AS Tcl_Interp Tcl_CreateInterp in/out |
| 109 | '\" # BS - start boxed text |
| 110 | '\" # ^y = starting y location |
| 111 | '\" # ^b = 1 |
| 112 | .de BS |
| 113 | .br |
| 114 | .mk ^y |
| 115 | .nr ^b 1u |
| 116 | .if n .nf |
| 117 | .if n .ti 0 |
| 118 | .if n \l'\\n(.lu\(ul' |
| 119 | .if n .fi |
| 120 | .. |
| 121 | '\" # BE - end boxed text (draw box now) |
| 122 | .de BE |
| 123 | .nf |
| 124 | .ti 0 |
| 125 | .mk ^t |
| 126 | .ie n \l'\\n(^lu\(ul' |
| 127 | .el \{\ |
| 128 | .\" Draw four-sided box normally, but don't draw top of |
| 129 | .\" box if the box started on an earlier page. |
| 130 | .ie !\\n(^b-1 \{\ |
| 131 | \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' |
| 132 | .\} |
| 133 | .el \}\ |
| 134 | \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' |
| 135 | .\} |
| 136 | .\} |
| 137 | .fi |
| 138 | .br |
| 139 | .nr ^b 0 |
| 140 | .. |
| 141 | '\" # VS - start vertical sidebar |
| 142 | '\" # ^Y = starting y location |
| 143 | '\" # ^v = 1 (for troff; for nroff this doesn't matter) |
| 144 | .de VS |
| 145 | .if !"\\$2"" .br |
| 146 | .mk ^Y |
| 147 | .ie n 'mc \s12\(br\s0 |
| 148 | .el .nr ^v 1u |
| 149 | .. |
| 150 | '\" # VE - end of vertical sidebar |
| 151 | .de VE |
| 152 | .ie n 'mc |
| 153 | .el \{\ |
| 154 | .ev 2 |
| 155 | .nf |
| 156 | .ti 0 |
| 157 | .mk ^t |
| 158 | \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' |
| 159 | .sp -1 |
| 160 | .fi |
| 161 | .ev |
| 162 | .\} |
| 163 | .nr ^v 0 |
| 164 | .. |
| 165 | '\" # Special macro to handle page bottom: finish off current |
| 166 | '\" # box/sidebar if in box/sidebar mode, then invoked standard |
| 167 | '\" # page bottom macro. |
| 168 | .de ^B |
| 169 | .ev 2 |
| 170 | 'ti 0 |
| 171 | 'nf |
| 172 | .mk ^t |
| 173 | .if \\n(^b \{\ |
| 174 | .\" Draw three-sided box if this is the box's first page, |
| 175 | .\" draw two sides but no top otherwise. |
| 176 | .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c |
| 177 | .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c |
| 178 | .\} |
| 179 | .if \\n(^v \{\ |
| 180 | .nr ^x \\n(^tu+1v-\\n(^Yu |
| 181 | \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c |
| 182 | .\} |
| 183 | .bp |
| 184 | 'fi |
| 185 | .ev |
| 186 | .if \\n(^b \{\ |
| 187 | .mk ^y |
| 188 | .nr ^b 2 |
| 189 | .\} |
| 190 | .if \\n(^v \{\ |
| 191 | .mk ^Y |
| 192 | .\} |
| 193 | .. |
| 194 | '\" # DS - begin display |
| 195 | .de DS |
| 196 | .RS |
| 197 | .nf |
| 198 | .sp |
| 199 | .. |
| 200 | '\" # DE - end display |
| 201 | .de DE |
| 202 | .fi |
| 203 | .RE |
| 204 | .sp |
| 205 | .. |
| 206 | '\" # SO - start of list of standard options |
| 207 | .de SO |
| 208 | .SH "STANDARD OPTIONS" |
| 209 | .LP |
| 210 | .nf |
| 211 | .ta 5.5c 11c |
| 212 | .ft B |
| 213 | .. |
| 214 | '\" # SE - end of list of standard options |
| 215 | .de SE |
| 216 | .fi |
| 217 | .ft R |
| 218 | .LP |
| 219 | See the \\fBoptions\\fR manual entry for details on the standard options. |
| 220 | .. |
| 221 | '\" # OP - start of full description for a single option |
| 222 | .de OP |
| 223 | .LP |
| 224 | .nf |
| 225 | .ta 4c |
| 226 | Command-Line Name: \\fB\\$1\\fR |
| 227 | Database Name: \\fB\\$2\\fR |
| 228 | Database Class: \\fB\\$3\\fR |
| 229 | .fi |
| 230 | .IP |
| 231 | .. |
| 232 | '\" # CS - begin code excerpt |
| 233 | .de CS |
| 234 | .RS |
| 235 | .nf |
| 236 | .ta .25i .5i .75i 1i |
| 237 | .. |
| 238 | '\" # CE - end code excerpt |
| 239 | .de CE |
| 240 | .fi |
| 241 | .RE |
| 242 | .. |
| 243 | .de UL |
| 244 | \\$1\l'|0\(ul'\\$2 |
| 245 | .. |
| 246 | .TH pack-old n 4.0 Tk "Tk Built-In Commands" |
| 247 | .BS |
| 248 | '\" Note: do not modify the .SH NAME line immediately below! |
| 249 | .SH NAME |
| 250 | pack-old \- Obsolete syntax for packer geometry manager |
| 251 | .SH SYNOPSIS |
| 252 | \fBpack after \fIsibling \fIwindow options\fR ?\fIwindow options \fR...? |
| 253 | .sp |
| 254 | \fBpack append \fIparent \fIwindow options\fR ?\fIwindow options \fR...? |
| 255 | .sp |
| 256 | \fBpack before \fIsibling \fIwindow options\fR ?\fIwindow options \fR...? |
| 257 | .sp |
| 258 | \fBpack unpack \fIwindow\fR |
| 259 | .BE |
| 260 | |
| 261 | .SH DESCRIPTION |
| 262 | .PP |
| 263 | \fINote: this manual entry describes the syntax for the \fBpack\fI |
| 264 | command as it existed before Tk version 3.3. |
| 265 | Although this syntax continues to be supported for backward |
| 266 | compatibility, it is obsolete and should not be used anymore. |
| 267 | At some point in the future it may cease to be supported.\fR |
| 268 | .PP |
| 269 | The packer is a geometry manager that arranges the |
| 270 | children of a parent by packing them in order around the edges of |
| 271 | the parent. The first child is placed against one side of |
| 272 | the window, occupying the entire span of the window along that |
| 273 | side. This reduces the space remaining for other children as |
| 274 | if the side had been moved in by the size of the first child. |
| 275 | Then the next child is placed against one side of the remaining |
| 276 | cavity, and so on until all children have been placed or there |
| 277 | is no space left in the cavity. |
| 278 | .PP |
| 279 | The \fBbefore\fR, \fBafter\fR, and \fBappend\fR forms of the \fBpack\fR |
| 280 | command are used to insert one or more children into the packing order |
| 281 | for their parent. The \fBbefore\fR form inserts the children before |
| 282 | window \fIsibling\fR in the order; all of the other windows must be |
| 283 | siblings of \fIsibling\fR. The \fBafter\fR form inserts the windows |
| 284 | after \fIsibling\fR, and the \fBappend\fR form appends one or more |
| 285 | windows to the end of the packing order for \fIparent\fR. If a |
| 286 | \fIwindow\fR named in any of these commands is already packed in |
| 287 | its parent, it is removed from its current position in the packing |
| 288 | order and repositioned as indicated by the command. All of these |
| 289 | commands return an empty string as result. |
| 290 | .PP |
| 291 | The \fBunpack\fR form of the \fBpack\fR command removes \fIwindow\fR |
| 292 | from the packing order of its parent and unmaps it. After the |
| 293 | execution of this command the packer will no longer manage |
| 294 | \fIwindow\fR's geometry. |
| 295 | .PP |
| 296 | The placement of each child is actually a four-step process; |
| 297 | the \fIoptions\fR argument following each \fIwindow\fR consists of |
| 298 | a list of one or more fields that govern the placement of that |
| 299 | window. In the discussion below, the term \fIcavity\fR refers |
| 300 | to the space left in a parent when a particular child is placed |
| 301 | (i.e. all the space that wasn't claimed by earlier children in |
| 302 | the packing order). The term \fIparcel\fR refers to the space |
| 303 | allocated to a particular child; this is not necessarily the |
| 304 | same as the child window's final geometry. |
| 305 | .PP |
| 306 | The first step in placing a child is to determine which side of |
| 307 | the cavity it will lie against. Any one of the following options |
| 308 | may be used to specify a side: |
| 309 | .TP |
| 310 | \fBtop\fR |
| 311 | Position the child's parcel against the top of the cavity, |
| 312 | occupying the full width of the cavity. |
| 313 | .TP |
| 314 | \fBbottom\fR |
| 315 | Position the child's parcel against the bottom of the cavity, |
| 316 | occupying the full width of the cavity. |
| 317 | .TP |
| 318 | \fBleft\fR |
| 319 | Position the child's parcel against the left side of the cavity, |
| 320 | occupying the full height of the cavity. |
| 321 | .TP |
| 322 | \fBright\fR |
| 323 | Position the child's parcel against the right side of the cavity, |
| 324 | occupying the full height of the cavity. |
| 325 | .LP |
| 326 | At most one of these options should be specified for any given window. |
| 327 | If no side is specified, then the default is \fBtop\fR. |
| 328 | .PP |
| 329 | The second step is to decide on a parcel for the child. For \fBtop\fR |
| 330 | and \fBbottom\fR windows, the desired parcel width is normally the cavity |
| 331 | width and the desired parcel height is the window's requested height, |
| 332 | as passed to \fBTk_GeometryRequest\fR. For \fBleft\fR and \fBright\fR |
| 333 | windows, the desired parcel height is normally the cavity height and the |
| 334 | desired width is the window's requested width. However, extra |
| 335 | space may be requested for the window using any of the following |
| 336 | options: |
| 337 | .TP 12 |
| 338 | \fBpadx \fInum\fR |
| 339 | Add \fInum\fR pixels to the window's requested width before computing |
| 340 | the parcel size as described above. |
| 341 | .TP 12 |
| 342 | \fBpady \fInum\fR |
| 343 | Add \fInum\fR pixels to the window's requested height before computing |
| 344 | the parcel size as described above. |
| 345 | .TP 12 |
| 346 | \fBexpand\fR |
| 347 | This option requests that the window's parcel absorb any extra space left over |
| 348 | in the parent's cavity after packing all the children. |
| 349 | The amount of space left over depends on the sizes requested by the |
| 350 | other children, and may be zero. If several windows have all specified |
| 351 | \fBexpand\fR then the extra width will be divided equally among all the |
| 352 | \fBleft\fR and \fBright\fR windows that specified \fBexpand\fR and |
| 353 | the extra height will be divided equally among all the \fBtop\fR and |
| 354 | \fBbottom\fR windows that specified \fBexpand\fR. |
| 355 | .LP |
| 356 | If the desired width or height for a parcel is larger than the corresponding |
| 357 | dimension of the cavity, then the cavity's dimension is used instead. |
| 358 | .PP |
| 359 | The third step in placing the window is to decide on the window's |
| 360 | width and height. The default is for the window to receive either |
| 361 | its requested width and height or the those of the parcel, whichever |
| 362 | is smaller. If the parcel is larger than the window's requested |
| 363 | size, then the following options may be used to expand the |
| 364 | window to partially or completely fill the parcel: |
| 365 | .TP |
| 366 | \fBfill\fR |
| 367 | Set the window's size to equal the parcel size. |
| 368 | .TP |
| 369 | \fBfillx\fR |
| 370 | Increase the window's width to equal the parcel's width, but retain |
| 371 | the window's requested height. |
| 372 | .TP |
| 373 | \fBfilly\fR |
| 374 | Increase the window's height to equal the parcel's height, but retain |
| 375 | the window's requested width. |
| 376 | .PP |
| 377 | The last step is to decide the window's location within its parcel. |
| 378 | If the window's size equals the parcel's size, then the window simply |
| 379 | fills the entire parcel. If the parcel is larger than the window, |
| 380 | then one of |
| 381 | the following options may be used to specify where the window should |
| 382 | be positioned within its parcel: |
| 383 | .TP 15 |
| 384 | \fBframe center\fR |
| 385 | Center the window in its parcel. This is the default if no framing |
| 386 | option is specified. |
| 387 | .TP 15 |
| 388 | \fBframe n\fR |
| 389 | Position the window with its top edge centered on the top edge of |
| 390 | the parcel. |
| 391 | .TP 15 |
| 392 | \fBframe ne\fR |
| 393 | Position the window with its upper-right corner at the upper-right corner |
| 394 | of the parcel. |
| 395 | .TP 15 |
| 396 | \fBframe e\fR |
| 397 | Position the window with its right edge centered on the right edge of |
| 398 | the parcel. |
| 399 | .TP 15 |
| 400 | \fBframe se\fR |
| 401 | Position the window with its lower-right corner at the lower-right corner |
| 402 | of the parcel. |
| 403 | .TP 15 |
| 404 | \fBframe s\fR |
| 405 | Position the window with its bottom edge centered on the bottom edge of |
| 406 | the parcel. |
| 407 | .TP 15 |
| 408 | \fBframe sw\fR |
| 409 | Position the window with its lower-left corner at the lower-left corner |
| 410 | of the parcel. |
| 411 | .TP 15 |
| 412 | \fBframe w\fR |
| 413 | Position the window with its left edge centered on the left edge of |
| 414 | the parcel. |
| 415 | .TP 15 |
| 416 | \fBframe nw\fR |
| 417 | Position the window with its upper-left corner at the upper-left corner |
| 418 | of the parcel. |
| 419 | .PP |
| 420 | The packer manages the mapped/unmapped state of all the packed |
| 421 | children windows. It automatically maps the windows when it packs |
| 422 | them, and it unmaps any windows for which there was no space left |
| 423 | in the cavity. |
| 424 | .PP |
| 425 | The packer makes geometry requests on behalf of the parent windows |
| 426 | it manages. For each parent window it requests a size large enough |
| 427 | to accommodate all the options specified by all the packed children, |
| 428 | such that zero space would be leftover for \fBexpand\fR options. |
| 429 | |
| 430 | .SH KEYWORDS |
| 431 | geometry manager, location, packer, parcel, size |