.\" Automatically generated by Pod::Man 4.07 (Pod::Simple 3.32) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .if !\nF .nr F 0 .if \nF>0 \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} .\} .\" ======================================================================== .\" .IX Title "Frame 3pm" .TH Frame 3pm "2015-05-03" "perl v5.24.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Tk::Frame \- Create and manipulate Frame widgets .SH "SYNOPSIS" .IX Header "SYNOPSIS"     \fI\f(CI$frame\fI\fR = \fI\f(CI$parent\fI\fR\->\fBFrame\fR(?\fIoptions\fR?); .SH "STANDARD OPTIONS" .IX Header "STANDARD OPTIONS" \&\fB\-borderwidth\fR \fB\-highlightbackground\fR \fB\-highlightthickness\fR \fB\-takefocus\fR \&\fB\-class\fR \fB\-highlightcolor\fR \fB\-relief\fR \&\fB\-cursor\fR .PP See Tk::options for details of the standard options. .SH "WIDGET-SPECIFIC OPTIONS" .IX Header "WIDGET-SPECIFIC OPTIONS" .IP "Name: \fBbackground\fR" 4 .IX Item "Name: background" .PD 0 .IP "Class: \fBBackground\fR" 4 .IX Item "Class: Background" .IP "Switch: \fB\-background\fR" 4 .IX Item "Switch: -background" .PD This option is the same as the standard \fBbackground\fR option except that its value may also be specified as an undefined value. 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. .IP "Name: \fBcolormap\fR" 4 .IX Item "Name: colormap" .PD 0 .IP "Class: \fBColormap\fR" 4 .IX Item "Class: Colormap" .IP "Switch: \fB\-colormap\fR" 4 .IX Item "Switch: -colormap" .PD 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 \f(CW$widget\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 method. .IP "Name: \fBcontainer\fR" 4 .IX Item "Name: container" .PD 0 .IP "Class: \fBContainer\fR" 4 .IX Item "Class: Container" .IP "Switch: \fB\-container\fR" 4 .IX Item "Switch: -container" .PD 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 method. .IP "Name: \fBheight\fR" 4 .IX Item "Name: height" .PD 0 .IP "Class: \fBHeight\fR" 4 .IX Item "Class: Height" .IP "Switch: \fB\-height\fR" 4 .IX Item "Switch: -height" .PD 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. .IP "Name: \fBvisual\fR" 4 .IX Item "Name: visual" .PD 0 .IP "Class: \fBVisual\fR" 4 .IX Item "Class: Visual" .IP "Switch: \fB\-visual\fR" 4 .IX Item "Switch: -visual" .PD 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 method. .IP "Name: \fBwidth\fR" 4 .IX Item "Name: width" .PD 0 .IP "Class: \fBWidth\fR" 4 .IX Item "Class: Width" .IP "Switch: \fB\-width\fR" 4 .IX Item "Switch: -width" .PD 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. .SH "DESCRIPTION" .IX Header "DESCRIPTION" The \fBFrame\fR method creates a new window (given by the \&\f(CW$widget\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 METHODS" .IX Header "WIDGET METHODS" The \fBFrame\fR method creates a widget object. This object supports the \fBconfigure\fR and \fBcget\fR methods described in Tk::options which can be used to enquire and modify the options described above. The widget also inherits all the methods provided by the generic Tk::Widget class. .SH "BINDINGS" .IX Header "BINDINGS" When a new frame is created, it has no default event bindings: frames are not intended to be interactive. .SH "KEYWORDS" .IX Header "KEYWORDS" frame, widget