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 "MENUBUTTON 1" | |
132 | .TH MENUBUTTON 1 "2000-12-30" "perl v5.8.0" "User Contributed Perl Documentation" | |
133 | .SH "NAME" | |
134 | Tk::Menubutton \- Create and manipulate Menubutton widgets | |
135 | .SH "SYNOPSIS" | |
136 | .IX Header "SYNOPSIS" | |
137 | \&\fI$menubutton\fR = \fI$parent\fR\->\fBMenubutton\fR(?\fIoptions\fR?); | |
138 | .SH "STANDARD OPTIONS" | |
139 | .IX Header "STANDARD OPTIONS" | |
140 | \&\fB\-activebackground\fR \fB\-cursor\fR \fB\-highlightthickness\fR \fB\-takefocus\fR | |
141 | \&\fB\-activeforeground\fR \fB\-disabledforeground\fR \fB\-image\fR \fB\-text\fR | |
142 | \&\fB\-anchor\fR \fB\-font\fR \fB\-justify\fR \fB\-textvariable\fR | |
143 | \&\fB\-background\fR \fB\-foreground\fR \fB\-padx\fR \fB\-underline\fR | |
144 | \&\fB\-bitmap\fR \fB\-highlightbackground\fR \fB\-pady\fR \fB\-wraplength\fR | |
145 | \&\fB\-borderwidth\fR \fB\-highlightcolor\fR \fB\-relief\fR | |
146 | .PP | |
147 | See Tk::options for details of the standard options. | |
148 | .SH "WIDGET-SPECIFIC OPTIONS" | |
149 | .IX Header "WIDGET-SPECIFIC OPTIONS" | |
150 | .IP "Name: \fBdirection\fR" 4 | |
151 | .IX Item "Name: direction" | |
152 | .PD 0 | |
153 | .IP "Class: \fBHeight\fR" 4 | |
154 | .IX Item "Class: Height" | |
155 | .IP "Switch: \fB\-direction\fR" 4 | |
156 | .IX Item "Switch: -direction" | |
157 | .PD | |
158 | Specifies where the menu is going to be popup up. \fBabove\fR tries to | |
159 | pop the menu above the menubutton. \fBbelow\fR tries to pop the menu | |
160 | below the menubutton. \fBleft\fR tries to pop the menu to the left of | |
161 | the menubutton. \fBright\fR tries to pop the menu to the right of the | |
162 | menu button. \fBflush\fR pops the menu directly over the menubutton. | |
163 | .IP "Name: \fBheight\fR" 4 | |
164 | .IX Item "Name: height" | |
165 | .PD 0 | |
166 | .IP "Class: \fBHeight\fR" 4 | |
167 | .IX Item "Class: Height" | |
168 | .IP "Switch: \fB\-height\fR" 4 | |
169 | .IX Item "Switch: -height" | |
170 | .PD | |
171 | Specifies a desired height for the menubutton. | |
172 | If an image or bitmap is being displayed in the menubutton then the value is in | |
173 | screen units (i.e. any of the forms acceptable to \fBTk_GetPixels\fR); | |
174 | for text it is in lines of text. | |
175 | If this option isn't specified, the menubutton's desired height is computed | |
176 | from the size of the image or bitmap or text being displayed in it. | |
177 | .IP "Name: \fBindicatorOn\fR" 4 | |
178 | .IX Item "Name: indicatorOn" | |
179 | .PD 0 | |
180 | .IP "Class: \fBIndicatorOn\fR" 4 | |
181 | .IX Item "Class: IndicatorOn" | |
182 | .IP "Switch: \fB\-indicatoron\fR" 4 | |
183 | .IX Item "Switch: -indicatoron" | |
184 | .PD | |
185 | The value must be a proper boolean value. If it is true then | |
186 | a small indicator rectangle will be displayed on the right side | |
187 | of the menubutton and the default menu bindings will treat this | |
188 | as an option menubutton. If false then no indicator will be | |
189 | displayed. | |
190 | .IP "Name: \fBmenu\fR" 4 | |
191 | .IX Item "Name: menu" | |
192 | .PD 0 | |
193 | .IP "Class: \fBMenuName\fR" 4 | |
194 | .IX Item "Class: MenuName" | |
195 | .IP "Switch: \fB\-menu\fR" 4 | |
196 | .IX Item "Switch: -menu" | |
197 | .PD | |
198 | Specifies the path name of the menu associated with this menubutton. | |
199 | The menu must be a child of the menubutton. | |
200 | .IP "Name: \fBstate\fR" 4 | |
201 | .IX Item "Name: state" | |
202 | .PD 0 | |
203 | .IP "Class: \fBState\fR" 4 | |
204 | .IX Item "Class: State" | |
205 | .IP "Switch: \fB\-state\fR" 4 | |
206 | .IX Item "Switch: -state" | |
207 | .PD | |
208 | Specifies one of three states for the menubutton: \fBnormal\fR, \fBactive\fR, | |
209 | or \fBdisabled\fR. In normal state the menubutton is displayed using the | |
210 | \&\fBforeground\fR and \fBbackground\fR options. The active state is | |
211 | typically used when the pointer is over the menubutton. In active state | |
212 | the menubutton is displayed using the \fBactiveForeground\fR and | |
213 | \&\fBactiveBackground\fR options. Disabled state means that the menubutton | |
214 | should be insensitive: the default bindings will refuse to activate | |
215 | the widget and will ignore mouse button presses. | |
216 | In this state the \fBdisabledForeground\fR and | |
217 | \&\fBbackground\fR options determine how the button is displayed. | |
218 | .IP "Name: \fBwidth\fR" 4 | |
219 | .IX Item "Name: width" | |
220 | .PD 0 | |
221 | .IP "Class: \fBWidth\fR" 4 | |
222 | .IX Item "Class: Width" | |
223 | .IP "Switch: \fB\-width\fR" 4 | |
224 | .IX Item "Switch: -width" | |
225 | .PD | |
226 | Specifies a desired width for the menubutton. | |
227 | If an image or bitmap is being displayed in the menubutton then the value is in | |
228 | screen units (i.e. any of the forms acceptable to \fBTk_GetPixels\fR); | |
229 | for text it is in characters. | |
230 | If this option isn't specified, the menubutton's desired width is computed | |
231 | from the size of the image or bitmap or text being displayed in it. | |
232 | .SH "DESCRIPTION" | |
233 | .IX Header "DESCRIPTION" | |
234 | The \fBMenubutton\fR method creates a new window (given by the | |
235 | \&\f(CW$widget\fR argument) and makes it into a menubutton 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 menubutton such as its colors, font, | |
240 | text, and initial relief. The \fBmenubutton\fR command returns its | |
241 | \&\f(CW$widget\fR argument. At the time this command is invoked, | |
242 | there must not exist a window named \f(CW$widget\fR, but | |
243 | \&\f(CW$widget\fR's parent must exist. | |
244 | .PP | |
245 | A menubutton is a widget that displays a textual string, bitmap, or image | |
246 | and is associated with a menu widget. | |
247 | If text is displayed, it must all be in a single font, but it | |
248 | can occupy multiple lines on the screen (if it contains newlines | |
249 | or if wrapping occurs because of the \fBwrapLength\fR option) and | |
250 | one of the characters may optionally be underlined using the | |
251 | \&\fBunderline\fR option. In normal usage, pressing | |
252 | mouse button 1 over the menubutton causes the associated menu to | |
253 | be posted just underneath the menubutton. If the mouse is moved over | |
254 | the menu before releasing the mouse button, the button release | |
255 | causes the underlying menu entry to be invoked. When the button | |
256 | is released, the menu is unposted. | |
257 | .PP | |
258 | Menubuttons are typically organized into groups called menu bars | |
259 | that allow scanning: | |
260 | if the mouse button is pressed over one menubutton (causing it | |
261 | to post its menu) and the mouse is moved over another menubutton | |
262 | in the same menu bar without releasing the mouse button, then the | |
263 | menu of the first menubutton is unposted and the menu of the | |
264 | new menubutton is posted instead. | |
265 | .PP | |
266 | There are several interactions between menubuttons and menus; see | |
267 | the \fBmenu\fR manual entry for information on various menu configurations, | |
268 | such as pulldown menus and option menus. | |
269 | .SH "WIDGET METHODS" | |
270 | .IX Header "WIDGET METHODS" | |
271 | The \fBMenubutton\fR method creates a widget object. | |
272 | This object supports the \fBconfigure\fR and \fBcget\fR methods | |
273 | described in Tk::options which can be used to enquire and | |
274 | modify the options described above. | |
275 | The \fBmenu\fR method returns the menu associated with the widget. | |
276 | The widget also inherits all the methods provided by the generic | |
277 | Tk::Widget class. | |
278 | .SH "DEFAULT BINDINGS" | |
279 | .IX Header "DEFAULT BINDINGS" | |
280 | Tk automatically creates class bindings for menubuttons that give them | |
281 | the following default behavior: | |
282 | .IP "[1]" 4 | |
283 | .IX Item "[1]" | |
284 | A menubutton activates whenever the mouse passes over it and deactivates | |
285 | whenever the mouse leaves it. | |
286 | .IP "[2]" 4 | |
287 | .IX Item "[2]" | |
288 | Pressing mouse button 1 over a menubutton posts the menubutton: | |
289 | its relief changes to raised and its associated menu is posted | |
290 | under the menubutton. If the mouse is dragged down into the menu | |
291 | with the button still down, and if the mouse button is then | |
292 | released over an entry in the menu, the menubutton is unposted | |
293 | and the menu entry is invoked. | |
294 | .IP "[3]" 4 | |
295 | .IX Item "[3]" | |
296 | If button 1 is pressed over a menubutton and then released over that | |
297 | menubutton, the menubutton stays posted: you can still move the mouse | |
298 | over the menu and click button 1 on an entry to invoke it. | |
299 | Once a menu entry has been invoked, the menubutton unposts itself. | |
300 | .IP "[4]" 4 | |
301 | .IX Item "[4]" | |
302 | If button 1 is pressed over a menubutton and then dragged over some | |
303 | other menubutton, the original menubutton unposts itself and the | |
304 | new menubutton posts. | |
305 | .IP "[5]" 4 | |
306 | .IX Item "[5]" | |
307 | If button 1 is pressed over a menubutton and released outside | |
308 | any menubutton or menu, the menubutton unposts without invoking | |
309 | any menu entry. | |
310 | .IP "[6]" 4 | |
311 | .IX Item "[6]" | |
312 | When a menubutton is posted, its associated menu claims the input | |
313 | focus to allow keyboard traversal of the menu and its submenus. | |
314 | See the \fBmenu\fR documentation for details on these bindings. | |
315 | .IP "[7]" 4 | |
316 | .IX Item "[7]" | |
317 | If the \fBunderline\fR option has been specified for a menubutton | |
318 | then keyboard traversal may be used to post the menubutton: | |
319 | Alt+\fIx\fR, where \fIx\fR is the underlined character (or its | |
320 | lower-case or upper-case equivalent), may be typed in any window | |
321 | under the menubutton's toplevel to post the menubutton. | |
322 | .IP "[8]" 4 | |
323 | .IX Item "[8]" | |
324 | The F10 key may be typed in any window to post the first menubutton | |
325 | under its toplevel window that isn't disabled. | |
326 | .IP "[9]" 4 | |
327 | .IX Item "[9]" | |
328 | If a menubutton has the input focus, the space and return keys | |
329 | post the menubutton. | |
330 | .Sp | |
331 | If the menubutton's state is \fBdisabled\fR then none of the above | |
332 | actions occur: the menubutton is completely non\-responsive. | |
333 | .Sp | |
334 | The behavior of menubuttons can be changed by defining new bindings for | |
335 | individual widgets or by redefining the class bindings. | |
336 | .SH "KEYWORDS" | |
337 | .IX Header "KEYWORDS" | |
338 | menubutton, widget |