1frame(n)                     Tk Built-In Commands                     frame(n)
2
3
4
5______________________________________________________________________________
6

NAME

8       frame - Create and manipulate 'frame' simple container widgets
9

SYNOPSIS

11       frame pathName ?options?
12

STANDARD OPTIONS

14       -borderwidth          -highlightcolor      -pady
15       -cursor               -highlightthickness  -relief
16       -highlightbackground  -padx                -takefocus
17
18       See the options manual entry for details on the standard options.
19

WIDGET-SPECIFIC OPTIONS

21       Command-Line Name:-background
22       Database Name:  background
23       Database Class: Background
24
25              This  option  is  the  same  as  the standard -background 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,
28              and no colors will be consumed from its colormap for  its  back‐
29              ground and border.
30
31       Command-Line Name:-class
32       Database Name:  class
33       Database Class: Class
34
35              Specifies  a class for the window.  This class will be used when
36              querying the option database for the window's other options, and
37              it  will also be used later for other purposes such as bindings.
38              The -class option may not be changed with the  configure  widget
39              command.
40
41       Command-Line Name:-colormap
42       Database Name:  colormap
43       Database Class: Colormap
44
45              Specifies  a  colormap  to use for the window.  The value may be
46              either new, in which case a new colormap is created for the win‐
47              dow  and its children, or the name of another window (which must
48              be on the same screen and have the same visual as pathName),  in
49              which  case the new window will use the colormap from the speci‐
50              fied window.  If the -colormap option is not specified, the  new
51              window  uses  the  same colormap as its parent.  This option may
52              not be changed with the configure widget command.
53
54       Command-Line Name:-container
55       Database Name:  container
56       Database Class: Container
57
58              The value must be a boolean.  If true, it means that this window
59              will be used as a container in which some other application will
60              be embedded (for example, a Tk toplevel can  be  embedded  using
61              the  -use option).  The window will support the appropriate win‐
62              dow manager protocols for things like  geometry  requests.   The
63              window  should not have any children of its own in this applica‐
64              tion.  This option may not be changed with the configure  widget
65              command.   Note  that  -borderwidth, -padx and -pady are ignored
66              when configured as a container since a container has no border.
67
68       Command-Line Name:-height
69       Database Name:  height
70       Database Class: Height
71
72              Specifies the desired height for the window in any of the  forms
73              acceptable  to  Tk_GetPixels.   If  this  option is less than or
74              equal to zero then the window will not request any size at  all.
75              Note  that this sets the total height of the frame, any -border‐
76              width or similar is not added.  Normally -height should  not  be
77              used if a propagating geometry manager, such as grid or pack, is
78              used within the frame since the geometry manager  will  override
79              the height of the frame.
80
81       Command-Line Name:-visual
82       Database Name:  visual
83       Database Class: Visual
84
85              Specifies  visual  information  for the new window in any of the
86              forms accepted by Tk_GetVisual.  If this option  is  not  speci‐
87              fied,  the  new  window  will use the same visual as its parent.
88              The -visual option may not be modified with the configure widget
89              command.
90
91       Command-Line Name:-width
92       Database Name:  width
93       Database Class: Width
94
95              Specifies  the  desired width for the window in any of the forms
96              acceptable to Tk_GetPixels.  If this  option  is  less  than  or
97              equal  to zero then the window will not request any size at all.
98              Note that this sets the total width of the frame,  any  -border‐
99              width  or  similar  is not added.  Normally -width should not be
100              used if a propagating geometry manager, such as grid or pack, is
101              used  within  the frame since the geometry manager will override
102              the width of the frame.
103______________________________________________________________________________
104

DESCRIPTION

106       The frame command creates a new window (given by the pathName argument)
107       and makes it into a frame widget.  Additional options, described above,
108       may be specified on the command line or in the option database to  con‐
109       figure  aspects  of  the frame such as its background color and relief.
110       The frame command returns the path name of the new window.
111
112       A frame is a simple widget.  Its primary purpose is to act as a  spacer
113       or  container for complex window layouts.  The only features of a frame
114       are its background color and an optional 3-D border to make  the  frame
115       appear raised or sunken.
116

WIDGET COMMAND

118       The  frame  command creates a new Tcl command whose name is the same as
119       the path name of the frame's window.   This  command  may  be  used  to
120       invoke  various operations on the widget.  It has the following general
121       form:
122              pathName option ?arg arg ...?
123       PathName is the name of the command, which is the  same  as  the  frame
124       widget's  path  name.  Option and the args determine the exact behavior
125       of the command.  The following commands are possible for frame widgets:
126
127       pathName cget option
128              Returns the current value of the configuration option  given  by
129              option.  Option may have any of the values accepted by the frame
130              command.
131
132       pathName configure ?option? ?value option value ...?
133              Query or modify the configuration options of the widget.  If  no
134              option is specified, returns a list describing all of the avail‐
135              able options for pathName (see Tk_ConfigureInfo for  information
136              on  the  format  of  this list).  If option is specified with no
137              value, then the command returns a list describing the one  named
138              option (this list will be identical to the corresponding sublist
139              of the value returned if no option is  specified).   If  one  or
140              more option-value pairs are specified, then the command modifies
141              the given widget option(s) to have the given value(s);  in  this
142              case  the  command returns an empty string.  Option may have any
143              of the values accepted by the frame command.
144

BINDINGS

146       When a new frame is created, it has no default event  bindings:  frames
147       are not intended to be interactive.
148

SEE ALSO

150       labelframe(n), toplevel(n), ttk::frame(n)
151

KEYWORDS

153       frame, widget
154
155
156
157Tk                                    8.4                             frame(n)
Impressum