Commit | Line | Data |
---|---|---|
86530b38 AT |
1 | .\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13 |
2 | .\" | |
3 | .\" Standard preamble: | |
4 | .\" ======================================================================== | |
5 | .de Sh \" Subsection heading | |
6 | .br | |
7 | .if t .Sp | |
8 | .ne 5 | |
9 | .PP | |
10 | \fB\\$1\fR | |
11 | .PP | |
12 | .. | |
13 | .de Sp \" Vertical space (when we can't use .PP) | |
14 | .if t .sp .5v | |
15 | .if n .sp | |
16 | .. | |
17 | .de Vb \" Begin verbatim text | |
18 | .ft CW | |
19 | .nf | |
20 | .ne \\$1 | |
21 | .. | |
22 | .de Ve \" End verbatim text | |
23 | .ft R | |
24 | .fi | |
25 | .. | |
26 | .\" Set up some character translations and predefined strings. \*(-- will | |
27 | .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left | |
28 | .\" double quote, and \*(R" will give a right double quote. | will give a | |
29 | .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to | |
30 | .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' | |
31 | .\" expand to `' in nroff, nothing in troff, for use with C<>. | |
32 | .tr \(*W-|\(bv\*(Tr | |
33 | .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' | |
34 | .ie n \{\ | |
35 | . ds -- \(*W- | |
36 | . ds PI pi | |
37 | . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch | |
38 | . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch | |
39 | . ds L" "" | |
40 | . ds R" "" | |
41 | . ds C` "" | |
42 | . ds C' "" | |
43 | 'br\} | |
44 | .el\{\ | |
45 | . ds -- \|\(em\| | |
46 | . ds PI \(*p | |
47 | . ds L" `` | |
48 | . ds R" '' | |
49 | 'br\} | |
50 | .\" | |
51 | .\" If the F register is turned on, we'll generate index entries on stderr for | |
52 | .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index | |
53 | .\" entries marked with X<> in POD. Of course, you'll have to process the | |
54 | .\" output yourself in some meaningful fashion. | |
55 | .if \nF \{\ | |
56 | . de IX | |
57 | . tm Index:\\$1\t\\n%\t"\\$2" | |
58 | .. | |
59 | . nr % 0 | |
60 | . rr F | |
61 | .\} | |
62 | .\" | |
63 | .\" For nroff, turn off justification. Always turn off hyphenation; it makes | |
64 | .\" way too many mistakes in technical documents. | |
65 | .hy 0 | |
66 | .if n .na | |
67 | .\" | |
68 | .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). | |
69 | .\" Fear. Run. Save yourself. No user-serviceable parts. | |
70 | . \" fudge factors for nroff and troff | |
71 | .if n \{\ | |
72 | . ds #H 0 | |
73 | . ds #V .8m | |
74 | . ds #F .3m | |
75 | . ds #[ \f1 | |
76 | . ds #] \fP | |
77 | .\} | |
78 | .if t \{\ | |
79 | . ds #H ((1u-(\\\\n(.fu%2u))*.13m) | |
80 | . ds #V .6m | |
81 | . ds #F 0 | |
82 | . ds #[ \& | |
83 | . ds #] \& | |
84 | .\} | |
85 | . \" simple accents for nroff and troff | |
86 | .if n \{\ | |
87 | . ds ' \& | |
88 | . ds ` \& | |
89 | . ds ^ \& | |
90 | . ds , \& | |
91 | . ds ~ ~ | |
92 | . ds / | |
93 | .\} | |
94 | .if t \{\ | |
95 | . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" | |
96 | . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' | |
97 | . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' | |
98 | . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' | |
99 | . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' | |
100 | . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' | |
101 | .\} | |
102 | . \" troff and (daisy-wheel) nroff accents | |
103 | .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' | |
104 | .ds 8 \h'\*(#H'\(*b\h'-\*(#H' | |
105 | .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] | |
106 | .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' | |
107 | .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' | |
108 | .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] | |
109 | .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] | |
110 | .ds ae a\h'-(\w'a'u*4/10)'e | |
111 | .ds Ae A\h'-(\w'A'u*4/10)'E | |
112 | . \" corrections for vroff | |
113 | .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' | |
114 | .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' | |
115 | . \" for low resolution devices (crt and lpr) | |
116 | .if \n(.H>23 .if \n(.V>19 \ | |
117 | \{\ | |
118 | . ds : e | |
119 | . ds 8 ss | |
120 | . ds o a | |
121 | . ds d- d\h'-1'\(ga | |
122 | . ds D- D\h'-1'\(hy | |
123 | . ds th \o'bp' | |
124 | . ds Th \o'LP' | |
125 | . ds ae ae | |
126 | . ds Ae AE | |
127 | .\} | |
128 | .rm #[ #] #H #V #F C | |
129 | .\" ======================================================================== | |
130 | .\" | |
131 | .IX Title "FRAME 1" | |
132 | .TH FRAME 1 "2000-12-30" "perl v5.8.0" "User Contributed Perl Documentation" | |
133 | .SH "NAME" | |
134 | Tk::Frame \- Create and manipulate Frame widgets | |
135 | .SH "SYNOPSIS" | |
136 | .IX Header "SYNOPSIS" | |
137 | \&\ \fI$frame\fR = \fI$parent\fR\->\fBFrame\fR(?\fIoptions\fR?); | |
138 | .SH "STANDARD OPTIONS" | |
139 | .IX Header "STANDARD OPTIONS" | |
140 | \&\fB\-borderwidth\fR \fB\-highlightbackground\fR \fB\-highlightthickness\fR \fB\-takefocus\fR | |
141 | \&\fB\-class\fR \fB\-highlightcolor\fR \fB\-relief\fR | |
142 | \&\fB\-cursor\fR | |
143 | .PP | |
144 | See Tk::options for details of the standard options. | |
145 | .SH "WIDGET-SPECIFIC OPTIONS" | |
146 | .IX Header "WIDGET-SPECIFIC OPTIONS" | |
147 | .IP "Name: \fBbackground\fR" 4 | |
148 | .IX Item "Name: background" | |
149 | .PD 0 | |
150 | .IP "Class: \fBBackground\fR" 4 | |
151 | .IX Item "Class: Background" | |
152 | .IP "Switch: \fB\-background\fR" 4 | |
153 | .IX Item "Switch: -background" | |
154 | .PD | |
155 | This option is the same as the standard \fBbackground\fR option | |
156 | except that its value may also be specified as an undefined value. | |
157 | In this case, the widget will display no background or border, and | |
158 | no colors will be consumed from its colormap for its background | |
159 | and border. | |
160 | .IP "Name: \fBcolormap\fR" 4 | |
161 | .IX Item "Name: colormap" | |
162 | .PD 0 | |
163 | .IP "Class: \fBColormap\fR" 4 | |
164 | .IX Item "Class: Colormap" | |
165 | .IP "Switch: \fB\-colormap\fR" 4 | |
166 | .IX Item "Switch: -colormap" | |
167 | .PD | |
168 | Specifies a colormap to use for the window. | |
169 | The value may be either \fBnew\fR, in which case a new colormap is | |
170 | created for the window and its children, or the name of another | |
171 | window (which must be on the same screen and have the same visual | |
172 | as \f(CW$widget\fR), in which case the new window will use the colormap | |
173 | from the specified window. | |
174 | If the \fBcolormap\fR option is not specified, the new window | |
175 | uses the same colormap as its parent. | |
176 | This option may not be changed with the \fBconfigure\fR | |
177 | method. | |
178 | .IP "Name: \fBcontainer\fR" 4 | |
179 | .IX Item "Name: container" | |
180 | .PD 0 | |
181 | .IP "Class: \fBContainer\fR" 4 | |
182 | .IX Item "Class: Container" | |
183 | .IP "Switch: \fB\-container\fR" 4 | |
184 | .IX Item "Switch: -container" | |
185 | .PD | |
186 | The value must be a boolean. If true, it means that this window will | |
187 | be used as a container in which some other application will be embedded | |
188 | (for example, a Tk toplevel can be embedded using the \fB\-use\fR option). | |
189 | The window will support the appropriate window manager protocols for | |
190 | things like geometry requests. The window should not have any | |
191 | children of its own in this application. | |
192 | This option may not be changed with the \fBconfigure\fR | |
193 | method. | |
194 | .IP "Name: \fBheight\fR" 4 | |
195 | .IX Item "Name: height" | |
196 | .PD 0 | |
197 | .IP "Class: \fBHeight\fR" 4 | |
198 | .IX Item "Class: Height" | |
199 | .IP "Switch: \fB\-height\fR" 4 | |
200 | .IX Item "Switch: -height" | |
201 | .PD | |
202 | Specifies the desired height for the window in any of the forms | |
203 | acceptable to \fBTk_GetPixels\fR. | |
204 | If this option is less than or equal to zero then the window will | |
205 | not request any size at all. | |
206 | .IP "Name: \fBvisual\fR" 4 | |
207 | .IX Item "Name: visual" | |
208 | .PD 0 | |
209 | .IP "Class: \fBVisual\fR" 4 | |
210 | .IX Item "Class: Visual" | |
211 | .IP "Switch: \fB\-visual\fR" 4 | |
212 | .IX Item "Switch: -visual" | |
213 | .PD | |
214 | Specifies visual information for the new window in any of the | |
215 | forms accepted by \fBTk_GetVisual\fR. | |
216 | If this option is not specified, the new window will use the same | |
217 | visual as its parent. | |
218 | The \fBvisual\fR option may not be modified with the \fBconfigure\fR | |
219 | method. | |
220 | .IP "Name: \fBwidth\fR" 4 | |
221 | .IX Item "Name: width" | |
222 | .PD 0 | |
223 | .IP "Class: \fBWidth\fR" 4 | |
224 | .IX Item "Class: Width" | |
225 | .IP "Switch: \fB\-width\fR" 4 | |
226 | .IX Item "Switch: -width" | |
227 | .PD | |
228 | Specifies the desired width for the window in any of the forms | |
229 | acceptable to \fBTk_GetPixels\fR. | |
230 | If this option is less than or equal to zero then the window will | |
231 | not request any size at all. | |
232 | .SH "DESCRIPTION" | |
233 | .IX Header "DESCRIPTION" | |
234 | The \fBFrame\fR method creates a new window (given by the | |
235 | \&\f(CW$widget\fR argument) and makes it into a frame widget. | |
236 | Additional | |
237 | options, described above, may be specified on the command line | |
238 | or in the option database | |
239 | to configure aspects of the frame such as its background color | |
240 | and relief. The \fBframe\fR command returns the | |
241 | path name of the new window. | |
242 | .PP | |
243 | A frame is a simple widget. Its primary purpose is to act as a | |
244 | spacer or container for complex window layouts. The only features | |
245 | of a frame are its background color and an optional 3\-D border to make the | |
246 | frame appear raised or sunken. | |
247 | .SH "WIDGET METHODS" | |
248 | .IX Header "WIDGET METHODS" | |
249 | The \fBFrame\fR method creates a widget object. | |
250 | This object supports the \fBconfigure\fR and \fBcget\fR methods | |
251 | described in Tk::options which can be used to enquire and | |
252 | modify the options described above. | |
253 | The widget also inherits all the methods provided by the generic | |
254 | Tk::Widget class. | |
255 | .SH "BINDINGS" | |
256 | .IX Header "BINDINGS" | |
257 | When a new frame is created, it has no default event bindings: | |
258 | frames are not intended to be interactive. | |
259 | .SH "KEYWORDS" | |
260 | .IX Header "KEYWORDS" | |
261 | frame, widget |