summaryrefslogtreecommitdiffstats
path: root/doc/toplevel.n
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2019-04-13 16:34:36 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2019-04-13 16:34:36 (GMT)
commit1c417fbb7713c0e591186fdd8da68b58b6a5bb86 (patch)
tree15fbe72db569af7deec187b2bfa6160d2c37eea8 /doc/toplevel.n
parent2e67b676e81edcaf0a65af35abe016fca7140207 (diff)
downloadtk-1c417fbb7713c0e591186fdd8da68b58b6a5bb86.zip
tk-1c417fbb7713c0e591186fdd8da68b58b6a5bb86.tar.gz
tk-1c417fbb7713c0e591186fdd8da68b58b6a5bb86.tar.bz2
Documentation for background images
Diffstat (limited to 'doc/toplevel.n')
-rw-r--r--doc/toplevel.n22
1 files changed, 21 insertions, 1 deletions
diff --git a/doc/toplevel.n b/doc/toplevel.n
index 04fadc4..c56e035 100644
--- a/doc/toplevel.n
+++ b/doc/toplevel.n
@@ -25,6 +25,17 @@ except that its value may also be specified as an empty string.
In this case, the widget will display no background or border, and
no colors will be consumed from its colormap for its background
and border.
+.VS "8.7, TIP262"
+An empty background will disable drawing the background image.
+.OP \-backgroundimage backgroundImage BackgroundImage
+This specifies an image to display on the toplevel's background within
+the border of the toplevel (i.e., the image will be clipped by the
+toplevel's highlight ring and border, if either are present) on top of
+the background;
+subwidgets of the toplevel will be drawn on top. The image must have
+been created with the \fBimage create\fR command. If specified as the
+empty string, no image will be displayed.
+.VE "8.7, TIP262"
.OP \-class class Class
Specifies a class for the window.
This class will be used when querying the option database for
@@ -71,6 +82,15 @@ Defaults to the same screen as its parent.
This option is special in that it may not be specified via the option
database, and it may not be modified with the \fBconfigure\fR
widget command.
+.OP \-tile tile Tile
+.VS "8.7, TIP262"
+This specifies how to draw the background image (see
+\fB\-backgroundimage\fR) on the toplevel.
+If true (according to \fBTcl_GetBoolean\fR), the image will be tiled
+to fill the whole toplevel, with the origin of the first copy of the
+image being the top left of the interior of the toplevel.
+If false (the default), the image will be centered within the toplevel.
+.VE "8.7, TIP262"
.OP \-use use Use
This option is used for embedding. If the value is not an empty string,
it must be the window identifier of a container window, specified as
@@ -109,7 +129,7 @@ top-level window: its X parent is the root window of a screen
rather than the logical parent from its Tk path name. The primary
purpose of a toplevel is to serve as a container for dialog boxes
and other collections of widgets. The only visible features
-of a toplevel are its background color and an optional 3-D border
+of a toplevel are its background and an optional 3-D border
to make the toplevel appear raised or sunken.
.SH "WIDGET COMMAND"
.PP