From 1c417fbb7713c0e591186fdd8da68b58b6a5bb86 Mon Sep 17 00:00:00 2001 From: dkf Date: Sat, 13 Apr 2019 16:34:36 +0000 Subject: Documentation for background images --- doc/frame.n | 21 ++++++++++++++++++++- doc/toplevel.n | 22 +++++++++++++++++++++- 2 files changed, 41 insertions(+), 2 deletions(-) diff --git a/doc/frame.n b/doc/frame.n index 9c34d03..54e8e2f 100644 --- a/doc/frame.n +++ b/doc/frame.n @@ -25,6 +25,16 @@ 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 frame's background within +the border of the frame (i.e., the image will be clipped by the +frame's highlight ring and border, if either are present); subwidgets +of the frame 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 @@ -62,6 +72,15 @@ sets the total height of the frame, any \fB\-borderwidth\fR or similar is not added. Normally \fB\-height\fR should not be used if a propagating geometry manager, such as \fBgrid\fR or \fBpack\fR, is used within the frame since the geometry manager will override the height of the frame. +.OP \-tile tile Tile +.VS "8.7, TIP262" +This specifies how to draw the background image (see +\fB\-backgroundimage\fR) on the frame. +If true (according to \fBTcl_GetBoolean\fR), the image will be tiled +to fill the whole frame, with the origin of the first copy of the +image being the top left of the interior of the frame. +If false (the default), the image will be centered within the frame. +.VE "8.7, TIP262" .OP \-visual visual Visual Specifies visual information for the new window in any of the forms accepted by \fBTk_GetVisual\fR. @@ -91,7 +110,7 @@ path name of the new window. .PP A frame is a simple widget. Its primary purpose is to act as a spacer or container for complex window layouts. The only features -of a frame are its background color and an optional 3-D border to make the +of a frame are its background and an optional 3-D border to make the frame appear raised or sunken. .SH "WIDGET COMMAND" .PP 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 -- cgit v0.12