| '\" |
| '\" Copyright (c) 1992 The Regents of the University of California. |
| '\" Copyright (c) 1994-1996 Sun Microsystems, Inc. |
| '\" |
| '\" See the file "license.terms" for information on usage and redistribution |
| '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. |
| '\" |
| '\" RCS: @(#) $Id: place.n,v 1.3 2000/08/10 00:21:06 ericm Exp $ |
| '\" |
| '\" The definitions below are for supplemental macros used in Tcl/Tk |
| '\" manual entries. |
| '\" |
| '\" .AP type name in/out ?indent? |
| '\" Start paragraph describing an argument to a library procedure. |
| '\" type is type of argument (int, etc.), in/out is either "in", "out", |
| '\" or "in/out" to describe whether procedure reads or modifies arg, |
| '\" and indent is equivalent to second arg of .IP (shouldn't ever be |
| '\" needed; use .AS below instead) |
| '\" |
| '\" .AS ?type? ?name? |
| '\" Give maximum sizes of arguments for setting tab stops. Type and |
| '\" name are examples of largest possible arguments that will be passed |
| '\" to .AP later. If args are omitted, default tab stops are used. |
| '\" |
| '\" .BS |
| '\" Start box enclosure. From here until next .BE, everything will be |
| '\" enclosed in one large box. |
| '\" |
| '\" .BE |
| '\" End of box enclosure. |
| '\" |
| '\" .CS |
| '\" Begin code excerpt. |
| '\" |
| '\" .CE |
| '\" End code excerpt. |
| '\" |
| '\" .VS ?version? ?br? |
| '\" Begin vertical sidebar, for use in marking newly-changed parts |
| '\" of man pages. The first argument is ignored and used for recording |
| '\" the version when the .VS was added, so that the sidebars can be |
| '\" found and removed when they reach a certain age. If another argument |
| '\" is present, then a line break is forced before starting the sidebar. |
| '\" |
| '\" .VE |
| '\" End of vertical sidebar. |
| '\" |
| '\" .DS |
| '\" Begin an indented unfilled display. |
| '\" |
| '\" .DE |
| '\" End of indented unfilled display. |
| '\" |
| '\" .SO |
| '\" Start of list of standard options for a Tk widget. The |
| '\" options follow on successive lines, in four columns separated |
| '\" by tabs. |
| '\" |
| '\" .SE |
| '\" End of list of standard options for a Tk widget. |
| '\" |
| '\" .OP cmdName dbName dbClass |
| '\" Start of description of a specific option. cmdName gives the |
| '\" option's name as specified in the class command, dbName gives |
| '\" the option's name in the option database, and dbClass gives |
| '\" the option's class in the option database. |
| '\" |
| '\" .UL arg1 arg2 |
| '\" Print arg1 underlined, then print arg2 normally. |
| '\" |
| '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $ |
| '\" |
| '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. |
| .if t .wh -1.3i ^B |
| .nr ^l \n(.l |
| .ad b |
| '\" # Start an argument description |
| .de AP |
| .ie !"\\$4"" .TP \\$4 |
| .el \{\ |
| . ie !"\\$2"" .TP \\n()Cu |
| . el .TP 15 |
| .\} |
| .ta \\n()Au \\n()Bu |
| .ie !"\\$3"" \{\ |
| \&\\$1 \\fI\\$2\\fP (\\$3) |
| .\".b |
| .\} |
| .el \{\ |
| .br |
| .ie !"\\$2"" \{\ |
| \&\\$1 \\fI\\$2\\fP |
| .\} |
| .el \{\ |
| \&\\fI\\$1\\fP |
| .\} |
| .\} |
| .. |
| '\" # define tabbing values for .AP |
| .de AS |
| .nr )A 10n |
| .if !"\\$1"" .nr )A \\w'\\$1'u+3n |
| .nr )B \\n()Au+15n |
| .\" |
| .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n |
| .nr )C \\n()Bu+\\w'(in/out)'u+2n |
| .. |
| .AS Tcl_Interp Tcl_CreateInterp in/out |
| '\" # BS - start boxed text |
| '\" # ^y = starting y location |
| '\" # ^b = 1 |
| .de BS |
| .br |
| .mk ^y |
| .nr ^b 1u |
| .if n .nf |
| .if n .ti 0 |
| .if n \l'\\n(.lu\(ul' |
| .if n .fi |
| .. |
| '\" # BE - end boxed text (draw box now) |
| .de BE |
| .nf |
| .ti 0 |
| .mk ^t |
| .ie n \l'\\n(^lu\(ul' |
| .el \{\ |
| .\" Draw four-sided box normally, but don't draw top of |
| .\" box if the box started on an earlier page. |
| .ie !\\n(^b-1 \{\ |
| \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' |
| .\} |
| .el \}\ |
| \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' |
| .\} |
| .\} |
| .fi |
| .br |
| .nr ^b 0 |
| .. |
| '\" # VS - start vertical sidebar |
| '\" # ^Y = starting y location |
| '\" # ^v = 1 (for troff; for nroff this doesn't matter) |
| .de VS |
| .if !"\\$2"" .br |
| .mk ^Y |
| .ie n 'mc \s12\(br\s0 |
| .el .nr ^v 1u |
| .. |
| '\" # VE - end of vertical sidebar |
| .de VE |
| .ie n 'mc |
| .el \{\ |
| .ev 2 |
| .nf |
| .ti 0 |
| .mk ^t |
| \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' |
| .sp -1 |
| .fi |
| .ev |
| .\} |
| .nr ^v 0 |
| .. |
| '\" # Special macro to handle page bottom: finish off current |
| '\" # box/sidebar if in box/sidebar mode, then invoked standard |
| '\" # page bottom macro. |
| .de ^B |
| .ev 2 |
| 'ti 0 |
| 'nf |
| .mk ^t |
| .if \\n(^b \{\ |
| .\" Draw three-sided box if this is the box's first page, |
| .\" draw two sides but no top otherwise. |
| .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 |
| .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c |
| .\} |
| .if \\n(^v \{\ |
| .nr ^x \\n(^tu+1v-\\n(^Yu |
| \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c |
| .\} |
| .bp |
| 'fi |
| .ev |
| .if \\n(^b \{\ |
| .mk ^y |
| .nr ^b 2 |
| .\} |
| .if \\n(^v \{\ |
| .mk ^Y |
| .\} |
| .. |
| '\" # DS - begin display |
| .de DS |
| .RS |
| .nf |
| .sp |
| .. |
| '\" # DE - end display |
| .de DE |
| .fi |
| .RE |
| .sp |
| .. |
| '\" # SO - start of list of standard options |
| .de SO |
| .SH "STANDARD OPTIONS" |
| .LP |
| .nf |
| .ta 5.5c 11c |
| .ft B |
| .. |
| '\" # SE - end of list of standard options |
| .de SE |
| .fi |
| .ft R |
| .LP |
| See the \\fBoptions\\fR manual entry for details on the standard options. |
| .. |
| '\" # OP - start of full description for a single option |
| .de OP |
| .LP |
| .nf |
| .ta 4c |
| Command-Line Name: \\fB\\$1\\fR |
| Database Name: \\fB\\$2\\fR |
| Database Class: \\fB\\$3\\fR |
| .fi |
| .IP |
| .. |
| '\" # CS - begin code excerpt |
| .de CS |
| .RS |
| .nf |
| .ta .25i .5i .75i 1i |
| .. |
| '\" # CE - end code excerpt |
| .de CE |
| .fi |
| .RE |
| .. |
| .de UL |
| \\$1\l'|0\(ul'\\$2 |
| .. |
| .TH place n "" Tk "Tk Built-In Commands" |
| .BS |
| '\" Note: do not modify the .SH NAME line immediately below! |
| .SH NAME |
| place \- Geometry manager for fixed or rubber-sheet placement |
| .SH SYNOPSIS |
| \fBplace \fIwindow option value \fR?\fIoption value ...\fR? |
| .sp |
| \fBplace configure \fIwindow \fR?\fIoption\fR? ?\fIvalue option value ...\fR? |
| .sp |
| \fBplace forget \fIwindow\fR |
| .sp |
| \fBplace info \fIwindow\fR |
| .sp |
| \fBplace slaves \fIwindow\fR |
| .BE |
| |
| .SH DESCRIPTION |
| .PP |
| The placer is a geometry manager for Tk. |
| It provides simple fixed placement of windows, where you specify |
| the exact size and location of one window, called the \fIslave\fR, |
| within another window, called the \fImaster\fR. |
| The placer also provides rubber-sheet placement, where you specify the |
| size and location of the slave in terms of the dimensions of |
| the master, so that the slave changes size and location |
| in response to changes in the size of the master. |
| Lastly, the placer allows you to mix these styles of placement so |
| that, for example, the slave has a fixed width and height but is |
| centered inside the master. |
| .PP |
| .TP |
| \fBplace \fIwindow option value \fR?\fIoption value ...\fR? |
| Arrange for the placer to manage the geometry of a slave whose |
| pathName is \fIwindow\fR. The remaining arguments consist of one or |
| more \fIoption\-value\fR pairs that specify the way in which |
| \fIwindow\fR's geometry is managed. \fIOption\fR may have any of the |
| values accepted by the \fBplace configure\fR command. |
| .TP |
| \fBplace configure \fIwindow \fR?\fIoption\fR? ?\fIvalue option value ...\fR? |
| Query or modify the geometry options of the slave given by |
| \fIwindow\fR. If no \fIoption\fR is specified, this command returns a |
| list describing the available options (see \fBTk_ConfigureInfo\fR for |
| information on the format of this list). If \fIoption\fR is specified |
| with no \fIvalue\fR, then the command returns a list describing the |
| one named option (this list will be identical to the corresponding |
| sublist of the value returned if no \fIoption\fR is specified). If |
| one or more \fIoption\-value\fR pairs are specified, then the command |
| modifies the given option(s) to have the given value(s); in this case |
| the command returns an empty string. |
| |
| The following \fIoption\-value\fR pairs are supported: |
| .RS |
| .TP |
| \fB\-anchor \fIwhere\fR |
| \fIWhere\fR specifies which point of \fIwindow\fR is to be positioned |
| at the (x,y) location selected by the \fB\-x\fR, \fB\-y\fR, |
| \fB\-relx\fR, and \fB\-rely\fR options. |
| The anchor point is in terms of the outer area of \fIwindow\fR |
| including its border, if any. |
| Thus if \fIwhere\fR is \fBse\fR then the lower-right corner of |
| \fIwindow\fR's border will appear at the given (x,y) location |
| in the master. |
| The anchor position defaults to \fBnw\fR. |
| .TP |
| \fB\-bordermode \fImode\fR |
| \fIMode\fR determines the degree to which borders within the |
| master are used in determining the placement of the slave. |
| The default and most common value is \fBinside\fR. |
| In this case the placer considers the area of the master to |
| be the innermost area of the master, inside any border: |
| an option of \fB\-x 0\fR corresponds to an x-coordinate just |
| inside the border and an option of \fB\-relwidth 1.0\fR |
| means \fIwindow\fR will fill the area inside the master's |
| border. |
| |
| If \fImode\fR is \fBoutside\fR then the placer considers |
| the area of the master to include its border; |
| this mode is typically used when placing \fIwindow\fR |
| outside its master, as with the options \fB\-x 0 \-y 0 \-anchor ne\fR. |
| Lastly, \fImode\fR may be specified as \fBignore\fR, in which |
| case borders are ignored: the area of the master is considered |
| to be its official X area, which includes any internal border but |
| no external border. A bordermode of \fBignore\fR is probably |
| not very useful. |
| .TP |
| \fB\-height \fIsize\fR |
| \fISize\fR specifies the height for \fIwindow\fR in screen units |
| (i.e. any of the forms accepted by \fBTk_GetPixels\fR). |
| The height will be the outer dimension of \fIwindow\fR including its |
| border, if any. |
| If \fIsize\fR is an empty string, or if no \fB\-height\fR or |
| \fB\-relheight\fR option is specified, then the height requested |
| internally by the window will be used. |
| .TP |
| \fB\-in \fImaster\fR |
| \fIMaster\fR specifes the path name of the window relative |
| to which \fIwindow\fR is to be placed. |
| \fIMaster\fR must either be \fIwindow\fR's parent or a descendant |
| of \fIwindow\fR's parent. |
| In addition, \fImaster\fR and \fIwindow\fR must both be descendants |
| of the same top-level window. |
| These restrictions are necessary to guarantee |
| that \fIwindow\fR is visible whenever \fImaster\fR is visible. |
| If this option isn't specified then the master defaults to |
| \fIwindow\fR's parent. |
| .TP |
| \fB\-relheight \fIsize\fR |
| \fISize\fR specifies the height for \fIwindow\fR. |
| In this case the height is specified as a floating-point number |
| relative to the height of the master: 0.5 means \fIwindow\fR will |
| be half as high as the master, 1.0 means \fIwindow\fR will have |
| the same height as the master, and so on. |
| If both \fB\-height\fR and \fB\-relheight\fR are specified for a slave, |
| their values are summed. For example, \fB\-relheight 1.0 \-height \-2\fR |
| makes the slave 2 pixels shorter than the master. |
| .TP |
| \fB\-relwidth \fIsize\fR |
| \fISize\fR specifies the width for \fIwindow\fR. |
| In this case the width is specified as a floating-point number |
| relative to the width of the master: 0.5 means \fIwindow\fR will |
| be half as wide as the master, 1.0 means \fIwindow\fR will have |
| the same width as the master, and so on. |
| If both \fB\-width\fR and \fB\-relwidth\fR are specified for a slave, |
| their values are summed. For example, \fB\-relwidth 1.0 \-width 5\fR |
| makes the slave 5 pixels wider than the master. |
| .TP |
| \fB\-relx \fIlocation\fR |
| \fILocation\fR specifies the x-coordinate within the master window |
| of the anchor point for \fIwindow\fR. |
| In this case the location is specified in a relative fashion |
| as a floating-point number: 0.0 corresponds to the left edge |
| of the master and 1.0 corresponds to the right edge of the master. |
| \fILocation\fR need not be in the range 0.0\-1.0. |
| If both \fB\-x\fR and \fB\-relx\fR are specified for a slave |
| then their values are summed. For example, \fB\-relx 0.5 \-x \-2\fR |
| positions the left edge of the slave 2 pixels to the left of the |
| center of its master. |
| .TP |
| \fB\-rely \fIlocation\fR |
| \fILocation\fR specifies the y-coordinate within the master window |
| of the anchor point for \fIwindow\fR. |
| In this case the value is specified in a relative fashion |
| as a floating-point number: 0.0 corresponds to the top edge |
| of the master and 1.0 corresponds to the bottom edge of the master. |
| \fILocation\fR need not be in the range 0.0\-1.0. |
| If both \fB\-y\fR and \fB\-rely\fR are specified for a slave |
| then their values are summed. For example, \fB\-rely 0.5 \-x 3\fR |
| positions the top edge of the slave 3 pixels below the |
| center of its master. |
| .TP |
| \fB\-width \fIsize\fR |
| \fISize\fR specifies the width for \fIwindow\fR in screen units |
| (i.e. any of the forms accepted by \fBTk_GetPixels\fR). |
| The width will be the outer width of \fIwindow\fR including its |
| border, if any. |
| If \fIsize\fR is an empty string, or if no \fB\-width\fR |
| or \fB\-relwidth\fR option is specified, then the width requested |
| internally by the window will be used. |
| .TP |
| \fB\-x \fIlocation\fR |
| \fILocation\fR specifies the x-coordinate within the master window |
| of the anchor point for \fIwindow\fR. |
| The location is specified in screen units (i.e. any of the forms |
| accepted by \fBTk_GetPixels\fR) and need not lie within the bounds |
| of the master window. |
| .TP |
| \fB\-y \fIlocation\fR |
| \fILocation\fR specifies the y-coordinate within the master window |
| of the anchor point for \fIwindow\fR. |
| The location is specified in screen units (i.e. any of the forms |
| accepted by \fBTk_GetPixels\fR) and need not lie within the bounds |
| of the master window. |
| .PP |
| If the same value is specified separately with |
| two different options, such as \fB\-x\fR and \fB\-relx\fR, then |
| the most recent option is used and the older one is ignored. |
| .RE |
| .TP |
| \fBplace forget \fIwindow\fR |
| Causes the placer to stop managing the geometry of \fIwindow\fR. As a |
| side effect of this command \fIwindow\fR will be unmapped so that it |
| doesn't appear on the screen. If \fIwindow\fR isn't currently managed |
| by the placer then the command has no effect. This command returns an |
| empty string. |
| .TP |
| \fBplace info \fIwindow\fR |
| Returns a list giving the current configuration of \fIwindow\fR. |
| The list consists of \fIoption\-value\fR pairs in exactly the |
| same form as might be specified to the \fBplace configure\fR |
| command. |
| .TP |
| \fBplace slaves \fIwindow\fR |
| Returns a list of all the slave windows for which \fIwindow\fR is the master. |
| If there are no slaves for \fIwindow\fR then an empty string is returned. |
| |
| If the configuration of a window has been retrieved with |
| \fBplace info\fR, that configuration can be restored later by |
| first using \fBplace forget\fR to erase any existing information |
| for the window and then invoking \fBplace configure\fR with |
| the saved information. |
| |
| .SH "FINE POINTS" |
| .PP |
| It is not necessary for the master window to be the parent |
| of the slave window. |
| This feature is useful in at least two situations. |
| First, for complex window layouts it means you can create a |
| hierarchy of subwindows whose only purpose |
| is to assist in the layout of the parent. |
| The ``real children'' of the parent (i.e. the windows that |
| are significant for the application's user interface) can be |
| children of the parent yet be placed inside the windows |
| of the geometry-management hierarchy. |
| This means that the path names of the ``real children'' |
| don't reflect the geometry-management hierarchy and users |
| can specify options for the real children |
| without being aware of the structure of the geometry-management |
| hierarchy. |
| .PP |
| A second reason for having a master different than the slave's |
| parent is to tie two siblings together. |
| For example, the placer can be used to force a window always to |
| be positioned centered just below one of its |
| siblings by specifying the configuration |
| .CS |
| \fB\-in \fIsibling\fB \-relx 0.5 \-rely 1.0 \-anchor n \-bordermode outside\fR |
| .CE |
| Whenever the sibling is repositioned in the future, the slave |
| will be repositioned as well. |
| .PP |
| Unlike many other geometry managers (such as the packer) |
| the placer does not make any attempt to manipulate the geometry of |
| the master windows or the parents of slave windows (i.e. it doesn't |
| set their requested sizes). |
| To control the sizes of these windows, make them windows like |
| frames and canvases that provide configuration options for this purpose. |
| |
| .SH KEYWORDS |
| geometry manager, height, location, master, place, rubber sheet, slave, width |