frame (n)
Create and manipulate frame widgets
SYNOPSIS
frame pathName ?options?
-borderwidth -highlightbackground -highlightthickness -takefocus
-cursor -highlightcolor -relief
WIDGET-SPECIFIC OPTIONS
-background background Background
This option is the same as the standard background 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.
-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 class option may not be changed with the configure
widget command.
-colormap colormap Colormap
Specifies a colormap to use for the window.
The value may be either new, 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 pathName), in which case the new window will use the colormap
from the specified window.
If the colormap option is not specified, the new window
uses the same colormap as its parent.
This option may not be changed with the configure
widget command.
"" br
-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 -use 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 configure
widget command.
-height height Height
Specifies the desired height for the window in any of the forms
acceptable to Tk_GetPixels.
If this option is less than or equal to zero then the window will
not request any size at all.
-visual visual Visual
Specifies visual information for the new window in any of the
forms accepted by Tk_GetVisual.
If this option is not specified, the new window will use the same
visual as its parent.
The visual option may not be modified with the configure
widget command.
-width width Width
Specifies the desired width for the window in any of the forms
acceptable to Tk_GetPixels.
If this option is less than or equal to zero then the window will
not request any size at all.
DESCRIPTION
The frame command creates a new window (given by the
pathName 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 frame command returns the
path name of the new window.
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.
WIDGET COMMAND
The frame 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:
pathName option ?arg arg ...?
PathName is the name of the command, which is the same as
the frame widget's path name. Option and the args
determine the exact behavior of the command. The following
commands are possible for frame widgets:
pathName cget option
Returns the current value of the configuration option given
by option.
Option may have any of the values accepted by the frame
command.
pathName configure ?option? ?value option value ...?
Query or modify the configuration options of the widget.
If no option is specified, returns a list describing all of
the available options for pathName (see Tk_ConfigureInfo for
information on the format of this list). If option is specified
with no value, 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 option is specified). If
one or more option-value 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.
Option may have any of the values accepted by the frame
command.
BINDINGS
When a new frame is created, it has no default event bindings:
frames are not intended to be interactive.
KEYWORDS
frame, widget
'\"
'\" Copyright (c) 1996, Expert Interface Technologies
'\"
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
'\" The definitions below are for supplemental macros used in Tix
'\" manual entries.
'\"
'\" .HS name section [date [version]]
'\" Replacement for .TH in other man pages. See below for valid
'\" section names.
'\"
'\" .AP type name in/out [indent]
'\" Start paragraph describing an argument to a library procedure.
'\" type is type of argument (int, etc.), in/out is either "in", "out",
'\" or "in/out" to describe whether procedure reads or modifies arg,
'\" and indent is equivalent to second arg of .IP (shouldn't ever be
'\" needed; use .AS below instead)
'\"
'\" .AS [type [name]]
'\" Give maximum sizes of arguments for setting tab stops. Type and
'\" name are examples of largest possible arguments that will be passed
'\" to .AP later. If args are omitted, default tab stops are used.
'\"
'\" .BS
'\" Start box enclosure. From here until next .BE, everything will be
'\" enclosed in one large box.
'\"
'\" .BE
'\" End of box enclosure.
'\"
'\" .VS
'\" Begin vertical sidebar, for use in marking newly-changed parts
'\" of man pages.
'\"
'\" .VE
'\" End of vertical sidebar.
'\"
'\" .DS
'\" Begin an indented unfilled display.
'\"
'\" .DE
'\" End of indented unfilled display.
'\"
|
|