diff options
Diffstat (limited to 'doc/frame.n')
| -rw-r--r-- | doc/frame.n | 31 |
1 files changed, 25 insertions, 6 deletions
diff --git a/doc/frame.n b/doc/frame.n index 4800461..97ff3b1 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 @@ -56,12 +66,21 @@ Note that \fB\-borderwidth\fR, \fB\-padx\fR and \fB\-pady\fR are ignored when configured as a container since a container has no border. .OP \-height height Height Specifies the desired height for the window in any of the forms -acceptable to \fBTk_GetPixels\fR. If this option is less than or equal -to zero then the window will not request any size at all. Note that this +acceptable to \fBTk_GetPixels\fR. If this option is negative or +zero then the window will not request any size at all. Note that this 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. @@ -71,8 +90,8 @@ The \fB\-visual\fR option may not be modified with the \fBconfigure\fR widget command. .OP \-width width Width Specifies the desired width for the window in any of the forms -acceptable to \fBTk_GetPixels\fR. If this option is less than or equal -to zero then the window will not request any size at all. Note that this +acceptable to \fBTk_GetPixels\fR. If this option is negative or +zero then the window will not request any size at all. Note that this sets the total width of the frame, any \fB\-borderwidth\fR or similar is not added. Normally \fB\-width\fR should not be used if a propagating geometry manager, such as \fBgrid\fR or \fBpack\fR, is used within the @@ -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 @@ -101,7 +120,7 @@ command may be used to invoke various operations on the widget. It has the following general form: .PP .CS -\fIpathName option \fR?\fIarg arg ...\fR? +\fIpathName option \fR?\fIarg ...\fR? .CE .PP \fIPathName\fR is the name of the command, which is the same as |