| 1 | # Copyright (c) 1990-1994 The Regents of the University of California. |
| 2 | # Copyright (c) 1994-1996 Sun Microsystems, Inc. |
| 3 | # See the file "license.terms" for information on usage and redistribution |
| 4 | # of this file, and for a DISCLAIMER OF ALL WARRANTIES. |
| 5 | # |
| 6 | # |
| 7 | |
| 8 | =head1 NAME |
| 9 | |
| 10 | Tk::Frame - Create and manipulate Frame widgets |
| 11 | |
| 12 | =for category Tk Widget Classes |
| 13 | |
| 14 | =head1 SYNOPSIS |
| 15 | |
| 16 | S< >I<$frame> = I<$parent>-E<gt>B<Frame>(?I<options>?); |
| 17 | |
| 18 | =head1 STANDARD OPTIONS |
| 19 | |
| 20 | B<-borderwidth> B<-highlightbackground> B<-highlightthickness> B<-takefocus> |
| 21 | B<-class> B<-highlightcolor> B<-relief> |
| 22 | B<-cursor> |
| 23 | |
| 24 | See L<Tk::options> for details of the standard options. |
| 25 | |
| 26 | =head1 WIDGET-SPECIFIC OPTIONS |
| 27 | |
| 28 | =over 4 |
| 29 | |
| 30 | =item Name: B<background> |
| 31 | |
| 32 | =item Class: B<Background> |
| 33 | |
| 34 | =item Switch: B<-background> |
| 35 | |
| 36 | This option is the same as the standard B<background> option |
| 37 | except that its value may also be specified as an undefined value. |
| 38 | In this case, the widget will display no background or border, and |
| 39 | no colors will be consumed from its colormap for its background |
| 40 | and border. |
| 41 | |
| 42 | =item Name: B<colormap> |
| 43 | |
| 44 | =item Class: B<Colormap> |
| 45 | |
| 46 | =item Switch: B<-colormap> |
| 47 | |
| 48 | Specifies a colormap to use for the window. |
| 49 | The value may be either B<new>, in which case a new colormap is |
| 50 | created for the window and its children, or the name of another |
| 51 | window (which must be on the same screen and have the same visual |
| 52 | as $widget), in which case the new window will use the colormap |
| 53 | from the specified window. |
| 54 | If the B<colormap> option is not specified, the new window |
| 55 | uses the same colormap as its parent. |
| 56 | This option may not be changed with the B<configure> |
| 57 | method. |
| 58 | |
| 59 | =item Name: B<container> |
| 60 | |
| 61 | =item Class: B<Container> |
| 62 | |
| 63 | =item Switch: B<-container> |
| 64 | |
| 65 | The value must be a boolean. If true, it means that this window will |
| 66 | be used as a container in which some other application will be embedded |
| 67 | (for example, a Tk toplevel can be embedded using the B<-use> option). |
| 68 | The window will support the appropriate window manager protocols for |
| 69 | things like geometry requests. The window should not have any |
| 70 | children of its own in this application. |
| 71 | This option may not be changed with the B<configure> |
| 72 | method. |
| 73 | |
| 74 | =item Name: B<height> |
| 75 | |
| 76 | =item Class: B<Height> |
| 77 | |
| 78 | =item Switch: B<-height> |
| 79 | |
| 80 | Specifies the desired height for the window in any of the forms |
| 81 | acceptable to B<Tk_GetPixels>. |
| 82 | If this option is less than or equal to zero then the window will |
| 83 | not request any size at all. |
| 84 | |
| 85 | =item Name: B<visual> |
| 86 | |
| 87 | =item Class: B<Visual> |
| 88 | |
| 89 | =item Switch: B<-visual> |
| 90 | |
| 91 | Specifies visual information for the new window in any of the |
| 92 | forms accepted by B<Tk_GetVisual>. |
| 93 | If this option is not specified, the new window will use the same |
| 94 | visual as its parent. |
| 95 | The B<visual> option may not be modified with the B<configure> |
| 96 | method. |
| 97 | |
| 98 | =item Name: B<width> |
| 99 | |
| 100 | =item Class: B<Width> |
| 101 | |
| 102 | =item Switch: B<-width> |
| 103 | |
| 104 | Specifies the desired width for the window in any of the forms |
| 105 | acceptable to B<Tk_GetPixels>. |
| 106 | If this option is less than or equal to zero then the window will |
| 107 | not request any size at all. |
| 108 | |
| 109 | =back |
| 110 | |
| 111 | =head1 DESCRIPTION |
| 112 | |
| 113 | The B<Frame> method creates a new window (given by the |
| 114 | $widget argument) and makes it into a frame widget. |
| 115 | Additional |
| 116 | options, described above, may be specified on the command line |
| 117 | or in the option database |
| 118 | to configure aspects of the frame such as its background color |
| 119 | and relief. The B<frame> command returns the |
| 120 | path name of the new window. |
| 121 | |
| 122 | A frame is a simple widget. Its primary purpose is to act as a |
| 123 | spacer or container for complex window layouts. The only features |
| 124 | of a frame are its background color and an optional 3-D border to make the |
| 125 | frame appear raised or sunken. |
| 126 | |
| 127 | =head1 WIDGET METHODS |
| 128 | |
| 129 | The B<Frame> method creates a widget object. |
| 130 | This object supports the B<configure> and B<cget> methods |
| 131 | described in L<Tk::options> which can be used to enquire and |
| 132 | modify the options described above. |
| 133 | The widget also inherits all the methods provided by the generic |
| 134 | L<Tk::Widget|Tk::Widget> class. |
| 135 | |
| 136 | =head1 BINDINGS |
| 137 | |
| 138 | When a new frame is created, it has no default event bindings: |
| 139 | frames are not intended to be interactive. |
| 140 | |
| 141 | =head1 KEYWORDS |
| 142 | |
| 143 | frame, widget |
| 144 | |
| 145 | =cut |
| 146 | |