place(3tk)

πŸ“¦
version 9.0.4 Β· 2 versions
, in debian trixie, ubuntu questing, ubuntu resolute, ubuntu stonking

🌸 NAME 🌸

place β€” the geometry manager for fixed or rubber-sheet placement πŸ’…


✨ SYNOPSIS ✨

place option arg ?arg ...?

πŸ¦‹ DESCRIPTION πŸ¦‹

okay so bestie, the placer is a geometry manager for Tk, and honestly it's giving main character energy. πŸ’– Here's the tea: it does simple fixed placement of windows, where you literally just say the exact size and location of one window β€” that one's called the content β€” inside another window, which we call the container.

Then it ALSO does rubber-sheet placement πŸŽ€, where you describe the size and location of the content in terms of the dimensions of the container, so the content changes size and location in response to changes in the size of the container. Responsive queen. It ate.

And last but not least, the placer lets you mix these styles of placement, so that β€” for example β€” the content has a fixed width and height but is centered inside the container. Obsessed, actually. ✨

🫢 place window option value ?option value ...?

Arrange for the placer to manage the geometry of a content whose pathName is window. The remaining arguments consist of one or more option-value pairs that specify the way in which window's geometry is managed. Option may have any of the values accepted by the place configure command. iykyk. πŸ’«

πŸŽ€ place configure window ?option? ?value option value ...?

Query or modify the geometry options of the content given by window. Here's how it goes:

  • If no option is specified, this command returns a list describing the available options (see Tk_ConfigureInfo for information on the format of this list).
  • If option is specified with no value, 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 option is specified).
  • If one or more option-value 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. no cap. 🫑

The following option-value pairs are supported:

  • -anchor where β€” Where specifies which point of window is to be positioned at the (x,y) location selected by the -x, -y, -relx, and -rely options. The anchor point is in terms of the outer area of window including its border, if any. So if where is se, then the lower-right corner of window's border will appear at the given (x,y) location in the container. The anchor position defaults to nw. πŸ“
  • -bordermode mode β€” Mode determines the degree to which borders within the container are used in determining the placement of the content. The default and most common value is inside. In this case the placer considers the area of the container to be the innermost area of the container, inside any border: an option of -x 0 corresponds to an x-coordinate just inside the border and an option of -relwidth 1.0 means window will fill the area inside the container's border.

If mode is outside then the placer considers the area of the container to include its border; this mode is typically used when placing window outside its container, as with the options -x 0 -y 0 -anchor ne. Lastly, mode may be specified as ignore, in which case borders are ignored: the area of the container is considered to be its official X area, which includes any internal border but no external border. A bordermode of ignore is probably not very useful. πŸ’€

  • -height size β€” Size specifies the height for window in screen units (i.e. any of the forms accepted by Tk_GetPixels). The height will be the outer dimension of window including its border, if any. If size is an empty string, or if no -height or -relheight option is specified, then the height requested internally by the window will be used. πŸ“
  • -in container β€” Container specifies the path name of the window relative to which window is to be placed. Container must either be window's parent or a descendant of window's parent. In addition, container and window must both be descendants of the same top-level window. These restrictions are necessary to guarantee that window is visible whenever container is visible. If this option is not specified then the other window defaults to window's parent. πŸ‘‘ (yes, "the other window", that's the original's wording, we don't make the rules)
  • -relheight size β€” Size specifies the height for window. In this case the height is specified as a floating-point number relative to the height of the container: 0.5 means window will be half as high as the container, 1.0 means window will have the same height as the container, and so on. If both -height and -relheight are specified for a content, their values are summed. For example, -relheight 1.0 -height -2 makes the content 2 pixels shorter than the container. ✨
  • -relwidth size β€” Size specifies the width for window. In this case the width is specified as a floating-point number relative to the width of the container: 0.5 means window will be half as wide as the container, 1.0 means window will have the same width as the container, and so on. If both -width and -relwidth are specified for a content, their values are summed. For example, -relwidth 1.0 -width 5 makes the content 5 pixels wider than the container. 🌈
  • -relx location β€” Location specifies the x-coordinate within the container window of the anchor point for window. 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 container and 1.0 corresponds to the right edge of the container. Location need not be in the range 0.0-1.0. If both -x and -relx are specified for a content then their values are summed. For example, -relx 0.5 -x -2 positions the left edge of the content 2 pixels to the left of the center of its container. 🧚
  • -rely location β€” Location specifies the y-coordinate within the container window of the anchor point for window. 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 container and 1.0 corresponds to the bottom edge of the container. Location need not be in the range 0.0-1.0. If both -y and -rely are specified for a content then their values are summed. For example, -rely 0.5 -x 3 positions the top edge of the content 3 pixels below the center of its container. πŸ¦‹
  • -width size β€” Size specifies the width for window in screen units (i.e. any of the forms accepted by Tk_GetPixels). The width will be the outer width of window including its border, if any. If size is an empty string, or if no -width or -relwidth option is specified, then the width requested internally by the window will be used. πŸ’–
  • -x location β€” Location specifies the x-coordinate within the container window of the anchor point for window. The location is specified in screen units (i.e. any of the forms accepted by Tk_GetPixels) and need not lie within the bounds of the container window. ⭐
  • -y location β€” Location specifies the y-coordinate within the container window of the anchor point for window. The location is specified in screen units (i.e. any of the forms accepted by Tk_GetPixels) and need not lie within the bounds of the container window. ⭐
okay so important little footnote bestie: if the same value is specified separately with two different options, such as -x and -relx, then the most recent option is used and the older one is ignored. so the last one to the party wins. πŸŽ‰

πŸ’œ place content window

Returns a list of all the content windows for which window is the container. If there is no content for window then an empty string is returned. 🫢

πŸ“ place forget window

Causes the placer to stop managing the geometry of window. As a side effect of this command window will be unmapped so that it does not appear on the screen. If window is not currently managed by the placer then the command has no effect. This command returns an empty string. πŸ‘‹ (it's not goodbye, it's just... unmanaged)

🧚 place info window

Returns a list giving the current configuration of window. The list consists of option-value pairs in exactly the same form as might be specified to the place configure command. πŸ“‹βœ¨

🌟 place slaves window

Synonym for place content window. same vibe, different name, slay. πŸ’…


If the configuration of a window has been retrieved with place info, that configuration can be restored later by first using place forget to erase any existing information for the window and then invoking place configure with the saved information. πŸ’Ύ (save your fave fits and re-wear them later, literally)

more incoming in part 2, don't go anywhere πŸ‘€

✨ FINE POINTS ✨

okay so the big glow-up here: your container window does NOT have to be the parent of the content window. like, at all. and bestie, this is useful in at least two situations, so let's get into it πŸ’…

First one: for complex window layouts it means you can build a whole hierarchy of subwindows whose entire personality is just helping lay out the parent. The β€œreal children” of the parent β€” meaning the windows that actually matter for your app's user interface β€” can still be children of the parent, but they get placed inside the windows of the geometry-management hierarchy. So what does that get you? The path names of the β€œreal children” do not reflect the geometry-management hierarchy, which means users can specify options for the real children without ever knowing the geometry-management hierarchy exists. iconic, honestly. πŸŽ€

Second reason to have a container that's different from the content's parent: tying two siblings together. For example, the placer can force a window to always be positioned centered just below one of its siblings by specifying this configuration:

-in sibling -relx 0.5 -rely 1.0 -anchor n -bordermode outside

and then whenever the sibling gets repositioned in the future, the content gets repositioned right along with it. siblings that move together stay together fr fr 🫢


Now, unlike a bunch of other geometry managers (looking at you, the packer πŸ‘€), the placer makes no attempt whatsoever to manipulate the geometry of the container windows or the parents of content windows. like, it does not set their requested sizes. zero. none. To control the sizes of those windows, you gotta make them windows like frames and canvases that actually give you configuration options for that purpose. placer is not your size guy, bestie, it's your position guy. periodt.

🌈 EXAMPLE 🌈

Make the label occupy the middle bit of the toplevel, no matter how it is resized:

label .l -text "In the\nMiddle!" -bg black -fg white
place .l -relwidth .3 -relx .35 -relheight .3 -rely .35

centered king behavior, no cap πŸ‘‘

πŸ‘€ SEE ALSO πŸ‘€

πŸ”‘ KEYWORDS πŸ”‘

geometry manager, height, location, container, place, rubber sheet, content, width


and that's the whole page, bestie!! πŸ¦‹ this was the place(3tk) manual page from Tk, and ngl it's lowkey one of the most underrated tools in the whole toolkit. now go place some windows and make them slay πŸ’–βœ¨

πŸ“¦ where this page comes from