| 1 |
578 |
markom |
'\"
|
| 2 |
|
|
'\" Copyright (c) 1990-1994 The Regents of the University of California.
|
| 3 |
|
|
'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
|
| 4 |
|
|
'\"
|
| 5 |
|
|
'\" See the file "license.terms" for information on usage and redistribution
|
| 6 |
|
|
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
|
| 7 |
|
|
'\"
|
| 8 |
|
|
'\"
|
| 9 |
|
|
'\" RCS: @(#) $Id: frame.n,v 1.1.1.1 2002-01-16 10:25:49 markom Exp $
|
| 10 |
|
|
'\"
|
| 11 |
|
|
.so man.macros
|
| 12 |
|
|
.TH frame n 8.0 Tk "Tk Built-In Commands"
|
| 13 |
|
|
.BS
|
| 14 |
|
|
'\" Note: do not modify the .SH NAME line immediately below!
|
| 15 |
|
|
.SH NAME
|
| 16 |
|
|
frame \- Create and manipulate frame widgets
|
| 17 |
|
|
.SH SYNOPSIS
|
| 18 |
|
|
\fBframe\fR \fIpathName\fR ?\fIoptions\fR?
|
| 19 |
|
|
.SO
|
| 20 |
|
|
\-borderwidth \-highlightbackground \-highlightthickness \-takefocus
|
| 21 |
|
|
\-cursor \-highlightcolor \-relief
|
| 22 |
|
|
.SE
|
| 23 |
|
|
.SH "WIDGET-SPECIFIC OPTIONS"
|
| 24 |
|
|
.OP \-background background Background
|
| 25 |
|
|
This option is the same as the standard \fBbackground\fR option
|
| 26 |
|
|
except that its value may also be specified as an empty string.
|
| 27 |
|
|
In this case, the widget will display no background or border, and
|
| 28 |
|
|
no colors will be consumed from its colormap for its background
|
| 29 |
|
|
and border.
|
| 30 |
|
|
.OP \-class class Class
|
| 31 |
|
|
Specifies a class for the window.
|
| 32 |
|
|
This class will be used when querying the option database for
|
| 33 |
|
|
the window's other options, and it will also be used later for
|
| 34 |
|
|
other purposes such as bindings.
|
| 35 |
|
|
The \fBclass\fR option may not be changed with the \fBconfigure\fR
|
| 36 |
|
|
widget command.
|
| 37 |
|
|
.OP \-colormap colormap Colormap
|
| 38 |
|
|
Specifies a colormap to use for the window.
|
| 39 |
|
|
The value may be either \fBnew\fR, in which case a new colormap is
|
| 40 |
|
|
created for the window and its children, or the name of another
|
| 41 |
|
|
window (which must be on the same screen and have the same visual
|
| 42 |
|
|
as \fIpathName\fR), in which case the new window will use the colormap
|
| 43 |
|
|
from the specified window.
|
| 44 |
|
|
If the \fBcolormap\fR option is not specified, the new window
|
| 45 |
|
|
uses the same colormap as its parent.
|
| 46 |
|
|
This option may not be changed with the \fBconfigure\fR
|
| 47 |
|
|
widget command.
|
| 48 |
|
|
.VS "" br
|
| 49 |
|
|
.OP \-container container Container
|
| 50 |
|
|
The value must be a boolean. If true, it means that this window will
|
| 51 |
|
|
be used as a container in which some other application will be embedded
|
| 52 |
|
|
(for example, a Tk toplevel can be embedded using the \fB\-use\fR option).
|
| 53 |
|
|
The window will support the appropriate window manager protocols for
|
| 54 |
|
|
things like geometry requests. The window should not have any
|
| 55 |
|
|
children of its own in this application.
|
| 56 |
|
|
This option may not be changed with the \fBconfigure\fR
|
| 57 |
|
|
widget command.
|
| 58 |
|
|
.VE
|
| 59 |
|
|
.OP \-height height Height
|
| 60 |
|
|
Specifies the desired height for the window in any of the forms
|
| 61 |
|
|
acceptable to \fBTk_GetPixels\fR.
|
| 62 |
|
|
If this option is less than or equal to zero then the window will
|
| 63 |
|
|
not request any size at all.
|
| 64 |
|
|
.OP \-visual visual Visual
|
| 65 |
|
|
Specifies visual information for the new window in any of the
|
| 66 |
|
|
forms accepted by \fBTk_GetVisual\fR.
|
| 67 |
|
|
If this option is not specified, the new window will use the same
|
| 68 |
|
|
visual as its parent.
|
| 69 |
|
|
The \fBvisual\fR option may not be modified with the \fBconfigure\fR
|
| 70 |
|
|
widget command.
|
| 71 |
|
|
.OP \-width width Width
|
| 72 |
|
|
Specifies the desired width for the window in any of the forms
|
| 73 |
|
|
acceptable to \fBTk_GetPixels\fR.
|
| 74 |
|
|
If this option is less than or equal to zero then the window will
|
| 75 |
|
|
not request any size at all.
|
| 76 |
|
|
.BE
|
| 77 |
|
|
|
| 78 |
|
|
.SH DESCRIPTION
|
| 79 |
|
|
.PP
|
| 80 |
|
|
The \fBframe\fR command creates a new window (given by the
|
| 81 |
|
|
\fIpathName\fR argument) and makes it into a frame widget.
|
| 82 |
|
|
Additional
|
| 83 |
|
|
options, described above, may be specified on the command line
|
| 84 |
|
|
or in the option database
|
| 85 |
|
|
to configure aspects of the frame such as its background color
|
| 86 |
|
|
and relief. The \fBframe\fR command returns the
|
| 87 |
|
|
path name of the new window.
|
| 88 |
|
|
.PP
|
| 89 |
|
|
A frame is a simple widget. Its primary purpose is to act as a
|
| 90 |
|
|
spacer or container for complex window layouts. The only features
|
| 91 |
|
|
of a frame are its background color and an optional 3-D border to make the
|
| 92 |
|
|
frame appear raised or sunken.
|
| 93 |
|
|
|
| 94 |
|
|
.SH "WIDGET COMMAND"
|
| 95 |
|
|
.PP
|
| 96 |
|
|
The \fBframe\fR command creates a new Tcl command whose
|
| 97 |
|
|
name is the same as the path name of the frame's window. This
|
| 98 |
|
|
command may be used to invoke various
|
| 99 |
|
|
operations on the widget. It has the following general form:
|
| 100 |
|
|
.CS
|
| 101 |
|
|
\fIpathName option \fR?\fIarg arg ...\fR?
|
| 102 |
|
|
.CE
|
| 103 |
|
|
\fIPathName\fR is the name of the command, which is the same as
|
| 104 |
|
|
the frame widget's path name. \fIOption\fR and the \fIarg\fRs
|
| 105 |
|
|
determine the exact behavior of the command. The following
|
| 106 |
|
|
commands are possible for frame widgets:
|
| 107 |
|
|
.TP
|
| 108 |
|
|
\fIpathName \fBcget\fR \fIoption\fR
|
| 109 |
|
|
Returns the current value of the configuration option given
|
| 110 |
|
|
by \fIoption\fR.
|
| 111 |
|
|
\fIOption\fR may have any of the values accepted by the \fBframe\fR
|
| 112 |
|
|
command.
|
| 113 |
|
|
.TP
|
| 114 |
|
|
\fIpathName \fBconfigure\fR ?\fIoption\fR? \fI?value option value ...\fR?
|
| 115 |
|
|
Query or modify the configuration options of the widget.
|
| 116 |
|
|
If no \fIoption\fR is specified, returns a list describing all of
|
| 117 |
|
|
the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
| 118 |
|
|
information on the format of this list). If \fIoption\fR is specified
|
| 119 |
|
|
with no \fIvalue\fR, then the command returns a list describing the
|
| 120 |
|
|
one named option (this list will be identical to the corresponding
|
| 121 |
|
|
sublist of the value returned if no \fIoption\fR is specified). If
|
| 122 |
|
|
one or more \fIoption\-value\fR pairs are specified, then the command
|
| 123 |
|
|
modifies the given widget option(s) to have the given value(s); in
|
| 124 |
|
|
this case the command returns an empty string.
|
| 125 |
|
|
\fIOption\fR may have any of the values accepted by the \fBframe\fR
|
| 126 |
|
|
command.
|
| 127 |
|
|
|
| 128 |
|
|
.SH BINDINGS
|
| 129 |
|
|
.PP
|
| 130 |
|
|
When a new frame is created, it has no default event bindings:
|
| 131 |
|
|
frames are not intended to be interactive.
|
| 132 |
|
|
|
| 133 |
|
|
.SH KEYWORDS
|
| 134 |
|
|
frame, widget
|
