132 lines
5.4 KiB
Plaintext
132 lines
5.4 KiB
Plaintext
'\"
|
|
'\" Copyright (c) 1990-1994 The Regents of the University of California.
|
|
'\" Copyright (c) 1994-1995 Sun Microsystems, Inc.
|
|
'\"
|
|
'\" See the file "license.terms" for information on usage and redistribution
|
|
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
|
'\"
|
|
'\"
|
|
'\" @(#) frame.n 1.23 95/08/12 17:35:08
|
|
'\"
|
|
.so STk-man.macros
|
|
.TH frame n 8.0 STk "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\fI \fIwidget\-name ?\fIoptions\fR?)
|
|
.SO
|
|
:borderwidth :highlightbackground :highlightthickness :takefocus
|
|
:cursor :highlightcolor :relief
|
|
.SE
|
|
.SH "WIDGET-SPECIFIC OPTIONS"
|
|
.OP :background 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 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 procedure.
|
|
.OP :colormap 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 \fIwidget\-name\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 procedure.
|
|
.VS "" br
|
|
.OP :container 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.
|
|
.VE
|
|
.OP :height 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 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 procedure.
|
|
.OP :width 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 procedure creates a new window (given by the
|
|
\fIwidget\-name\fR argument) and makes it into a frame widget.
|
|
Additional
|
|
options, described above, may be specified on the procedure line
|
|
or in the option database
|
|
to configure aspects of the frame such as its background color
|
|
and relief. The \fBframe\fR procedure 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 PROCEDURE"
|
|
.PP
|
|
The \fBframe\fR procedure creates a new STk procedure whose
|
|
name is the same as the path name of the frame's window. This
|
|
procedure may be used to invoke various
|
|
operations on the widget. It has the following general form:
|
|
.CS
|
|
(\fIwidget\-name option \fR?\fIarg arg ...\fR?)
|
|
.CE
|
|
\fIPathName\fR is the name of the procedure, which is the same as
|
|
the frame widget's path name. \fIOption\fR and the \fIarg\fRs
|
|
determine the exact behavior of the procedure. The following
|
|
procedures are possible for frame widgets:
|
|
.TP
|
|
(\fIwidget\-name '\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
|
|
procedure.
|
|
.TP
|
|
(\fIwidget\-name \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 \fIwidget\-name\fR (see \fBTk_ConfigureInfo\fR for
|
|
information on the format of this list). If \fIoption\fR is specified
|
|
with no \fIvalue\fR, then the procedure 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 procedure
|
|
modifies the given widget option(s) to have the given value(s); in
|
|
this case the procedure returns an empty string.
|
|
\fIOption\fR may have any of the values accepted by the \fBframe\fR
|
|
procedure.
|
|
|
|
.SH BINDINGS
|
|
.PP
|
|
When a new frame is created, it has no default event bindings:
|
|
frames are not intended to be interactive.
|