diff options
Diffstat (limited to 'tcl/doc/frame.n')
-rw-r--r-- | tcl/doc/frame.n | 136 |
1 files changed, 0 insertions, 136 deletions
diff --git a/tcl/doc/frame.n b/tcl/doc/frame.n deleted file mode 100644 index b2e88d472f0..00000000000 --- a/tcl/doc/frame.n +++ /dev/null @@ -1,136 +0,0 @@ -'\" -'\" Copyright (c) 1990-1994 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$ -'\" -.so man.macros -.TH frame n 8.4 Tk "Tk Built-In Commands" -.BS -'\" Note: do not modify the .SH NAME line immediately below! -.SH NAME -frame \- Create and manipulate frame widgets -.SH SYNOPSIS -\fBframe\fR \fIpathName\fR ?\fIoptions\fR? -.SO -\-borderwidth \-highlightcolor \-pady -\-cursor \-highlightthickness \-relief -\-highlightbackground \-padx \-takefocus -.SE -.SH "WIDGET-SPECIFIC OPTIONS" -.OP \-background background Background -This option is the same as the standard \fBbackground\fR option -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. -.OP \-class class Class -Specifies a class for the window. -This class will be used when querying the option database for -the window's other options, and it will also be used later for -other purposes such as bindings. -The \fBclass\fR option may not be changed with the \fBconfigure\fR -widget command. -.OP \-colormap colormap Colormap -Specifies a colormap to use for the window. -The value may be either \fBnew\fR, in which case a new colormap is -created for the window and its children, or the name of another -window (which must be on the same screen and have the same visual -as \fIpathName\fR), in which case the new window will use the colormap -from the specified window. -If the \fBcolormap\fR option is not specified, the new window -uses the same colormap as its parent. -This option may not be changed with the \fBconfigure\fR -widget command. -.OP \-container container Container -The value must be a boolean. If true, it means that this window will -be used as a container in which some other application will be embedded -(for example, a Tk toplevel can be embedded using the \fB\-use\fR option). -The window will support the appropriate window manager protocols for -things like geometry requests. The window should not have any -children of its own in this application. -This option may not be changed with the \fBconfigure\fR -widget command. -.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. -.OP \-visual visual Visual -Specifies visual information for the new window in any of the -forms accepted by \fBTk_GetVisual\fR. -If this option is not specified, the new window will use the same -visual as its parent. -The \fBvisual\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. -.BE - -.SH DESCRIPTION -.PP -The \fBframe\fR command creates a new window (given by the -\fIpathName\fR argument) and makes it into a frame widget. -Additional -options, described above, may be specified on the command line -or in the option database -to configure aspects of the frame such as its background color -and relief. The \fBframe\fR command returns the -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 -frame appear raised or sunken. - -.SH "WIDGET COMMAND" -.PP -The \fBframe\fR command creates a new Tcl command whose -name is the same as the path name of the frame's window. This -command may be used to invoke various -operations on the widget. It has the following general form: -.CS -\fIpathName option \fR?\fIarg arg ...\fR? -.CE -\fIPathName\fR is the name of the command, which is the same as -the frame widget's path name. \fIOption\fR and the \fIarg\fRs -determine the exact behavior of the command. The following -commands are possible for frame widgets: -.TP -\fIpathName \fBcget\fR \fIoption\fR -Returns the current value of the configuration option given -by \fIoption\fR. -\fIOption\fR may have any of the values accepted by the \fBframe\fR -command. -.TP -\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR? -Query or modify the configuration options of the widget. -If no \fIoption\fR is specified, returns a list describing all of -the available options for \fIpathName\fR (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 widget option(s) to have the given value(s); in -this case the command returns an empty string. -\fIOption\fR may have any of the values accepted by the \fBframe\fR -command. - -.SH BINDINGS -.PP -When a new frame is created, it has no default event bindings: -frames are not intended to be interactive. - -.SH "SEE ALSO" -labelframe(n), toplevel(n) - -.SH KEYWORDS -frame, widget |