2 '\" Copyright (c) 1990 The Regents of the University of California.
3 '\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
5 '\" See the file "license.terms" for information on usage and redistribution
6 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
8 .TH bindtags n 4.0 Tk "Tk Built-In Commands"
9 .\" The -*- nroff -*- definitions below are for supplemental macros used
10 .\" in Tcl/Tk manual entries.
12 .\" .AP type name in/out ?indent?
13 .\" Start paragraph describing an argument to a library procedure.
14 .\" type is type of argument (int, etc.), in/out is either "in", "out",
15 .\" or "in/out" to describe whether procedure reads or modifies arg,
16 .\" and indent is equivalent to second arg of .IP (shouldn't ever be
17 .\" needed; use .AS below instead)
20 .\" Give maximum sizes of arguments for setting tab stops. Type and
21 .\" name are examples of largest possible arguments that will be passed
22 .\" to .AP later. If args are omitted, default tab stops are used.
25 .\" Start box enclosure. From here until next .BE, everything will be
26 .\" enclosed in one large box.
29 .\" End of box enclosure.
32 .\" Begin code excerpt.
37 .\" .VS ?version? ?br?
38 .\" Begin vertical sidebar, for use in marking newly-changed parts
39 .\" of man pages. The first argument is ignored and used for recording
40 .\" the version when the .VS was added, so that the sidebars can be
41 .\" found and removed when they reach a certain age. If another argument
42 .\" is present, then a line break is forced before starting the sidebar.
45 .\" End of vertical sidebar.
48 .\" Begin an indented unfilled display.
51 .\" End of indented unfilled display.
54 .\" Start of list of standard options for a Tk widget. The manpage
55 .\" argument defines where to look up the standard options; if
56 .\" omitted, defaults to "options". The options follow on successive
57 .\" lines, in three columns separated by tabs.
60 .\" End of list of standard options for a Tk widget.
62 .\" .OP cmdName dbName dbClass
63 .\" Start of description of a specific option. cmdName gives the
64 .\" option's name as specified in the class command, dbName gives
65 .\" the option's name in the option database, and dbClass gives
66 .\" the option's class in the option database.
69 .\" Print arg1 underlined, then print arg2 normally.
72 .\" Print arg1 in quotes, then arg2 normally (for trailing punctuation).
75 .\" Print an open parenthesis, arg1 in quotes, then arg2 normally
76 .\" (for trailing punctuation) and then a closing parenthesis.
78 .\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
82 .\" # Start an argument description
86 . ie !"\\$2"" .TP \\n()Cu
91 \&\\$1 \\fI\\$2\\fP (\\$3)
104 .\" # define tabbing values for .AP
107 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
110 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
111 .nr )C \\n()Bu+\\w'(in/out)'u+2n
113 .AS Tcl_Interp Tcl_CreateInterp in/out
114 .\" # BS - start boxed text
115 .\" # ^y = starting y location
123 .if n \l'\\n(.lu\(ul'
126 .\" # BE - end boxed text (draw box now)
131 .ie n \l'\\n(^lu\(ul'
133 .\" Draw four-sided box normally, but don't draw top of
134 .\" box if the box started on an earlier page.
136 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
139 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
146 .\" # VS - start vertical sidebar
147 .\" # ^Y = starting y location
148 .\" # ^v = 1 (for troff; for nroff this doesn't matter)
152 .ie n 'mc \s12\(br\s0
155 .\" # VE - end of vertical sidebar
163 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
170 .\" # Special macro to handle page bottom: finish off current
171 .\" # box/sidebar if in box/sidebar mode, then invoked standard
172 .\" # page bottom macro.
179 .\" Draw three-sided box if this is the box's first page,
180 .\" draw two sides but no top otherwise.
181 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
182 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
185 .nr ^x \\n(^tu+1v-\\n(^Yu
186 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
199 .\" # DS - begin display
205 .\" # DE - end display
211 .\" # SO - start of list of standard options
213 'ie '\\$1'' .ds So \\fBoptions\\fR
214 'el .ds So \\fB\\$1\\fR
215 .SH "STANDARD OPTIONS"
221 .\" # SE - end of list of standard options
226 See the \\*(So manual entry for details on the standard options.
228 .\" # OP - start of full description for a single option
233 Command-Line Name: \\fB\\$1\\fR
234 Database Name: \\fB\\$2\\fR
235 Database Class: \\fB\\$3\\fR
239 .\" # CS - begin code excerpt
245 .\" # CE - end code excerpt
250 .\" # UL - underline word
254 .\" # QW - apply quotation marks to word
256 .ie '\\*(lq'"' ``\\$1''\\$2
257 .\"" fix emacs highlighting
258 .el \\*(lq\\$1\\*(rq\\$2
260 .\" # PQ - apply parens and quotation marks to word
262 .ie '\\*(lq'"' (``\\$1''\\$2)\\$3
263 .\"" fix emacs highlighting
264 .el (\\*(lq\\$1\\*(rq\\$2)\\$3
266 .\" # QR - quoted range
268 .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
269 .\"" fix emacs highlighting
270 .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
272 .\" # MT - "empty" string
277 '\" Note: do not modify the .SH NAME line immediately below!
279 bindtags \- Determine which bindings apply to a window, and order of evaluation
281 \fBbindtags \fIwindow \fR?\fItagList\fR?
285 When a binding is created with the \fBbind\fR command, it is
286 associated either with a particular window such as \fB.a.b.c\fR,
287 a class name such as \fBButton\fR, the keyword \fBall\fR, or any
289 All of these forms are called \fIbinding tags\fR.
290 Each window contains a list of binding tags that determine how
291 events are processed for the window.
292 When an event occurs in a window, it is applied to each of the
293 window's tags in order: for each tag, the most specific binding
294 that matches the given tag and event is executed.
295 See the \fBbind\fR command for more information on the matching
298 By default, each window has four binding tags consisting of the
299 name of the window, the window's class name, the name of the window's
300 nearest toplevel ancestor, and \fBall\fR, in that order.
301 Toplevel windows have only three tags by default, since the toplevel
302 name is the same as that of the window.
303 The \fBbindtags\fR command allows the binding tags for a window to be
306 If \fBbindtags\fR is invoked with only one argument, then the
307 current set of binding tags for \fIwindow\fR is returned as a list.
308 If the \fItagList\fR argument is specified to \fBbindtags\fR,
309 then it must be a proper list; the tags for \fIwindow\fR are changed
310 to the elements of the list.
311 The elements of \fItagList\fR may be arbitrary strings; however,
312 any tag starting with a dot is treated as the name of a window; if
313 no window by that name exists at the time an event is processed,
314 then the tag is ignored for that event.
315 The order of the elements in \fItagList\fR determines the order in
316 which binding scripts are executed in response to events.
317 For example, the command
319 \fBbindtags .b {all . Button .b}\fR
321 reverses the order in which binding scripts will be evaluated for
322 a button named \fB.b\fR so that \fBall\fR bindings are invoked
323 first, following by bindings for \fB.b\fR's toplevel
325 followed by class bindings, followed by bindings for \fB.b\fR.
326 If \fItagList\fR is an empty list then the binding tags for \fIwindow\fR
327 are returned to the default state described above.
329 The \fBbindtags\fR command may be used to introduce arbitrary
330 additional binding tags for a window, or to remove standard tags.
331 For example, the command
333 \fBbindtags .b {.b TrickyButton . all}\fR
335 replaces the \fBButton\fR tag for \fB.b\fR with \fBTrickyButton\fR.
336 This means that the default widget bindings for buttons, which are
337 associated with the \fBButton\fR tag, will no longer apply to \fB.b\fR,
338 but any bindings associated with \fBTrickyButton\fR (perhaps some
339 new button behavior) will apply.
342 If you have a set of nested \fBframe\fR widgets and you want events
343 sent to a \fBbutton\fR widget to also be delivered to all the widgets
344 up to the current \fBtoplevel\fR (in contrast to Tk's default
345 behavior, where events are not delivered to those intermediate
346 windows) to make it easier to have accelerators that are only active
347 for part of a window, you could use a helper procedure like this to
350 proc setupBindtagsForTreeDelivery {widget} {
351 set tags [list $widget [winfo class $widget]]
353 set t [winfo toplevel $w]
355 set w [winfo parent $w]
359 \fBbindtags\fR $widget $tags