xref: /inferno-os/man/9/frame (revision 46439007cf417cbd9ac8049bb4122c890097a0fa)
FRAME 9
NAME
frame - Create and manipulate frame widgets
SYNOPSIS
\f5frame pathName ?options?
STANDARD OPTIONS
.EX -borderwidth -relief
"WIDGET-SPECIFIC OPTIONS"

-background colour This option is the same as the standard \f5background 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 colours will be consumed from its colourmap for its background and border.

-height dist Specifies the desired height for the window. If this option is less than or equal to zero then the window will not request any size at all.

-width dist Specifies the desired width for the window. If this option is less than or equal to zero then the window will not request any size at all.

DESCRIPTION
The \f5frame 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 to configure aspects of the frame such as its background colour and relief. The \f5frame 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 colour and an optional 3-D border to make the frame appear raised or sunken.

"WIDGET COMMAND"
The \f5frame command creates a new Tk command whose name is pathName.. This command may be used to invoke various operations on the widget. It has the following general form:

.EX 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 behaviour of the command. The following commands are possible for frame widgets:

pathName \f5cget option Returns the current value of the configuration option given by option. Option may have any of the values accepted by the \f5frame command.

pathName \f5configure ?option? ?value option value ...? Query or modify the configuration options of the widget. If no option is specified, returns a list of all of the available options for pathName. 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 \f5frame command.

BINDINGS
When a new frame is created, it has no default event bindings: frames are not intended to be interactive.
SEE ALSO
options (9), types (9)