bind.n
上传用户:rrhhcc
上传日期:2015-12-11
资源大小:54129k
文件大小:30k
源码类别:

通讯编程

开发平台:

Visual C++

  1. '"
  2. '" Copyright (c) 1990 The Regents of the University of California.
  3. '" Copyright (c) 1994-1996 Sun Microsystems, Inc.
  4. '" Copyright (c) 1998 by Scriptics Corporation.
  5. '"
  6. '" See the file "license.terms" for information on usage and redistribution
  7. '" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
  8. '" 
  9. '" RCS: @(#) $Id: bind.n,v 1.7.2.2 2004/10/28 10:19:29 dkf Exp $
  10. '" 
  11. .so man.macros
  12. .TH bind n 8.0 Tk "Tk Built-In Commands"
  13. .BS
  14. '" Note:  do not modify the .SH NAME line immediately below!
  15. .SH NAME
  16. bind - Arrange for X events to invoke Tcl scripts
  17. .SH SYNOPSIS
  18. fBbindfI tagfR ?fIsequencefR? ?fB+fR??fIscriptfR?
  19. .BE
  20. .SH "INTRODUCTION"
  21. .PP
  22. The fBbindfR command associates Tcl scripts with X events.
  23. If all three arguments are specified, fBbindfR will
  24. arrange for fIscriptfR (a Tcl script) to be evaluated whenever
  25. the event(s) given by fIsequencefR occur in the window(s)
  26. identified by fItagfR.
  27. If fIscriptfR is prefixed with a ``+'', then it is appended to
  28. any existing binding for fIsequencefR;  otherwise fIscriptfR replaces
  29. any existing binding.
  30. If fIscriptfR is an empty string then the current binding for
  31. fIsequencefR is destroyed, leaving fIsequencefR unbound.
  32. In all of the cases where a fIscriptfR argument is provided,
  33. fBbindfR returns an empty string.
  34. .PP
  35. If fIsequencefR is specified without a fIscriptfR, then the
  36. script currently bound to fIsequencefR is returned, or
  37. an empty string is returned if there is no binding for fIsequencefR.
  38. If neither fIsequencefR nor fIscriptfR is specified, then the
  39. return value is a list whose elements are all the sequences
  40. for which there exist bindings for fItagfR.
  41. .PP
  42. The fItagfR argument determines which window(s) the binding applies to.
  43. If fItagfR begins with a dot, as in fB.a.b.cfR, then it must
  44. be the path name for a window; otherwise it may be an arbitrary
  45. string.
  46. Each window has an associated list of tags, and a binding applies
  47. to a particular window if its tag is among those specified for
  48. the window.
  49. Although the fBbindtagsfR command may be used to assign an
  50. arbitrary set of binding tags to a window, the default binding
  51. tags provide the following behavior:
  52. .IP (bu 3
  53. If a tag is the name of an internal window the binding applies
  54. to that window.
  55. .IP (bu 3
  56. If the tag is the name of a toplevel window the binding applies
  57. to the toplevel window and all its internal windows.
  58. .IP (bu 3
  59. If the tag is the name of a class of widgets, such as fBButtonfR,
  60. the binding applies to all widgets in that class;
  61. .IP (bu 3
  62. If fItagfR has the value fBallfR,
  63. the binding applies to all windows in the application.
  64. .SH "EVENT PATTERNS"
  65. .PP
  66. The fIsequencefR argument specifies a sequence of one or more
  67. event patterns, with optional white space between the patterns.  Each
  68. .VS
  69. event pattern may
  70. take one of three forms.  In the simplest case it is a single
  71. .VE
  72. printing ASCII character, such as fBafR or fB[fR.  The character
  73. may not be a space character or the character fB<fR.  This form of
  74. pattern matches a fBKeyPressfR event for the particular
  75. character.  The second form of pattern is longer but more general.
  76. It has the following syntax:
  77. .CS
  78. fB<fImodifier-modifier-type-detailfB>fR
  79. .CE
  80. The entire event pattern is surrounded by angle brackets.
  81. Inside the angle brackets are zero or more modifiers, an event
  82. type, and an extra piece of information (fIdetailfR) identifying
  83. a particular button or keysym.  Any of the fields may be omitted,
  84. as long as at least one of fItypefR and fIdetailfR is present.
  85. The fields must be separated by white space or dashes.
  86. .VS
  87. .PP
  88. The third form of pattern is used to specify a user-defined, named virtual
  89. event.  It has the following syntax:
  90. .CS
  91. fB<<fInamefB>>fR
  92. .CE
  93. The entire virtual event pattern is surrounded by double angle brackets.
  94. Inside the angle brackets is the user-defined name of the virtual event.
  95. Modifiers, such as fBShiftfR or fBControlfR, may not be combined with a
  96. virtual event to modify it.  Bindings on a virtual event may be created
  97. before the virtual event is defined, and if the definition of a virtual
  98. event changes dynamically, all windows bound to that virtual event will
  99. respond immediately to the new definition.  
  100. .PP
  101. Some widgets (e.g. fBmenufR and fBtextfR) issue virtual events
  102. when their internal state is updated in some ways.  Please see the
  103. manual page for each widget for details.
  104. .VE
  105. .SH "MODIFIERS"
  106. .PP
  107. Modifiers consist of any of the following values:
  108. .DS
  109. .ta 6c
  110. fBControlfR fBMod2, M2fR
  111. fBShiftfR fBMod3, M3fR
  112. fBLockfR fBMod4, M4fR
  113. fBButton1, B1fR fBMod5, M5fR
  114. fBButton2, B2fR fBMeta, MfR
  115. fBButton3, B3fR fBAltfR
  116. fBButton4, B4fR fBDoublefR
  117. fBButton5, B5fR fBTriplefR
  118. fBMod1, M1fR fBQuadruplefR
  119. .DE
  120. Where more than one value is listed, separated by commas, the values
  121. are equivalent.
  122. Most of the modifiers have the obvious X meanings.
  123. For example, fBButton1fR requires that
  124. button 1 be depressed when the event occurs.
  125. For a binding to match a given event, the modifiers in the event
  126. must include all of those specified in the event pattern.
  127. An event may also contain additional modifiers not specified in
  128. the binding.
  129. For example, if button 1 is pressed while the shift and control keys
  130. are down, the pattern fB<Control-Button-1>fR will match
  131. the event, but fB<Mod1-Button-1>fR will not.
  132. If no modifiers are specified, then any combination of modifiers may
  133. be present in the event.
  134. .PP
  135. fBMetafR and fBMfR refer to whichever of the
  136. fBM1fR through fBM5fR modifiers is associated with the Meta
  137. key(s) on the keyboard (keysyms fBMeta_RfR and fBMeta_LfR).
  138. If there are no Meta keys, or if they are not associated with any
  139. modifiers, then fBMetafR and fBMfR will not match any events.
  140. Similarly, the fBAltfR modifier refers to whichever modifier
  141. is associated with the alt key(s) on the keyboard (keysyms
  142. fBAlt_LfR and fBAlt_RfR).
  143. .PP
  144. The fBDoublefR, fBTriplefR and fBQuadruplefR modifiers are a
  145. convenience for specifying double mouse clicks and other repeated
  146. events. They cause a particular event pattern to be repeated 2, 3 or 4
  147. times, and also place a time and space requirement on the sequence: for a
  148. sequence of events to match a fBDoublefR, fBTriplefR or fBQuadruplefR
  149. pattern, all of the events must occur close together in time and without
  150. substantial mouse motion in between.  For example, fB<Double-Button-1>fR
  151. is equivalent to fB<Button-1><Button-1>fR with the extra time and space
  152. requirement.
  153. .SH "EVENT TYPES"
  154. .PP
  155. The fItypefR field may be any of the standard X event types, with a
  156. few extra abbreviations.  The fItypefR field will also accept a
  157. couple non-standard X event types that were added to better support
  158. the Macintosh and Windows platforms.  Below is a list of all the valid
  159. types; where two names appear together, they are synonyms.
  160. .DS
  161. .ta w'ButtonPress, Button'u +w'KeyPress, Key'u
  162. fBActivate Destroy Map
  163. ButtonPress, Button Enter MapRequest
  164. ButtonRelease Expose Motion
  165. Circulate FocusIn MouseWheel
  166. CirculateRequest FocusOut Property
  167. Colormap Gravity Reparent
  168. Configure KeyPress, Key ResizeRequest
  169. ConfigureRequest KeyRelease Unmap
  170. Create Leave Visibility
  171. DeactivatefR
  172. .DE
  173. .VS
  174. Most of the above events have the same fields and behaviors as events
  175. in the X Windowing system.  You can find more detailed descriptions of
  176. these events in any X window programming book.  A couple of the events
  177. are extensions to the X event system to support features unique to the
  178. Macintosh and Windows platforms.  We provide a little more detail on
  179. these events here.  These include:
  180. .IP "fBActivatefR, fBDeactivatefR" 5
  181. These two events are sent to every sub-window of a toplevel when they
  182. change state.  In addition to the focus Window, the Macintosh platform
  183. and Windows platforms have a notion of an active window (which often
  184. has but is not required to have the focus).  On the Macintosh, widgets
  185. in the active window have a different appearance than widgets in
  186. deactive windows.  The fBActivatefR event is sent to all the
  187. sub-windows in a toplevel when it changes from being deactive to
  188. active.  Likewise, the fBDeactivefR event is sent when the window's
  189. state changes from active to deactive.  There are no useful percent
  190. substitutions you would make when binding to these events.
  191. .IP fBMouseWheelfR 5
  192. Some mice on the Windows platform support a mouse wheel which is used
  193. for scrolling documents without using the scrollbars.  By rolling the
  194. wheel, the system will generate fBMouseWheelfR events that the
  195. application can use to scroll.  On Windows, the event is
  196. always routed to the window that currently has focus (like fBKeyfR
  197. events.) On Mac OS X,
  198. the event is routed to the window under the pointer.  When the event
  199. is received you can use the fB%DfR substitution to get the
  200. fIdeltafR field for the event, which is a integer value describing how
  201. the mouse wheel has moved.  The smallest value for which the
  202. system will report is defined by the OS.  On Windows 95 & 98 machines
  203. this value is at least 120 before it is reported.  However, higher
  204. resolution devices may be available in the future.  On Mac OS X, the value is
  205. not scaled by 120, but a value of 1 corresponds to roughly one text line.
  206. The sign of the value determines which direction your widget should scroll.  
  207. Positive values should scroll up and negative values should scroll down.
  208. .VE
  209. .IP "fBKeyPressfP, fBKeyReleasefP" 5
  210. The fBKeyPressfP and fBKeyReleasefP events are generated
  211. whenever a key is pressed or released.  fBKeyPressfP and fBKeyReleasefP
  212. events are sent to the window which currently has the keyboard focus.
  213. .IP "fBButtonPressfP, fBButtonReleasefP, fBMotionfP" 5
  214. The fBButtonPressfP and fBButtonReleasefP events
  215. are generated when the user presses or releases a mouse button.
  216. fBMotionfP events are generated whenever the pointer is moved.
  217. fBButtonPressfP, fBButtonReleasefP, and fBMotionfP events are 
  218. normally sent to the window containing the pointer.
  219. .RS
  220. .PP
  221. When a mouse button is pressed, the window containing the pointer
  222. automatically obtains a temporary pointer grab.
  223. Subsequent fBButtonPressfP, fBButtonReleasefP, and fBMotionfP 
  224. events will be sent to that window,
  225. regardless of which window contains the pointer,
  226. until all buttons have been released.
  227. .RE
  228. .IP fBConfigurefP 5
  229. A fBConfigurefP event is sent to a window whenever its
  230. size, position, or border width changes, and sometimes
  231. when it has changed position in the stacking order.
  232. .IP "fBMapfP, fBUnmapfP" 5
  233. The fBMapfP and fBUnmapfP events are generated whenever the mapping
  234. state of a window changes.
  235. .RS
  236. .PP
  237. Windows are created in the unmapped state.
  238. Top-level windows become mapped when they transition to the
  239. fBnormalfP state, and are unmapped in the fBwithdrawnfP
  240. and fBiconicfP states.
  241. Other windows become mapped when they are placed under control
  242. of a geometry manager (for example fBpackfP or fBgridfP).
  243. .PP
  244. A window is fIviewablefP only if it and all of its ancestors are mapped.
  245. Note that geometry managers typically do not map their children until 
  246. they have been mapped themselves, and unmap all children
  247. when they become unmapped; hence in Tk fBMapfP and fBUnmapfP
  248. events indicate whether or not a window is viewable.
  249. .RE
  250. .IP fBVisibilityfP 5
  251. A window is said to be fIobscuredfP when another window
  252. above it in the stacking order fully or partially overlaps it.
  253. fBVisibilityfP events are generated whenever a window's
  254. obscurity state changes; the fIstatefP field (fB%sfP)
  255. specifies the new state.
  256. .IP fBExposefP 5
  257. An fBExposefP event is generated whenever all or part of a
  258. window should be redrawn (for example, when a window is
  259. first mapped or if it becomes unobscured).
  260. It is normally not necessary for client applications to 
  261. handle fBExposefP events, since Tk handles them internally.
  262. .IP fBDestroyfP 5
  263. A fBDestroyfP event is delivered to a window when 
  264. it is destroyed.
  265. .RS
  266. .PP
  267. When the fBDestroyfP event is delivered
  268. to a widget, it is in a ``half-dead'' state: the widget still exists,
  269. but most operations on it will fail.
  270. .RE
  271. .IP "fBFocusInfP, fBFocusOutfP" 5
  272. The fBFocusInfP and fBFocusOutfP events are generated
  273. whenever the keyboard focus changes.
  274. A fBFocusOutfP event is sent to the old focus window,
  275. and a fBFocusInfP event is sent to the new one.
  276. .RS
  277. .PP
  278. In addition,
  279. if the old and new focus windows do not share a common parent,
  280. ``virtual crossing'' focus events are sent to the intermediate
  281. windows in the hierarchy.
  282. Thus a fBFocusInfP event indicates
  283. that the target window or one of its descendants has acquired the focus,
  284. and a fBFocusOutfP event indicates that the focus 
  285. has been changed to a window outside the target window's hierarchy.
  286. .PP
  287. The keyboard focus may be changed explicitly by a call to fBfocusfP,
  288. or implicitly by the window manager.  
  289. .RE
  290. .IP "fBEnterfP, fBLeavefP" 5
  291. An fBEnterfP event is sent to a window when the pointer
  292. enters that window, and a fBLeavefP event is sent when
  293. the pointer leaves it.  
  294. .RS
  295. .PP
  296. If there is a pointer grab in effect, fBEnterfP and fBLeavefP
  297. events are only delivered to the window owning the grab.
  298. .PP
  299. In addition, when the pointer moves
  300. between two windows, fBEnterfP and fBLeavefP
  301. ``virtual crossing'' events are sent to intermediate windows
  302. in the hierarchy in the same manner as for fBFocusInfP and
  303. fBFocusOutfP events.
  304. .RE
  305. .IP fBPropertyfP
  306. A fBPropertyfP event is sent to a window whenever an X property
  307. belonging to that window is changed or deleted.
  308. fBPropertyfP events are not normally delivered to Tk applications as
  309. they are handled by the Tk core.
  310. .IP fBColormapfP
  311. A fBColormapfP event is generated whenever the colormap
  312. associated with a window has been changed, installed, or uninstalled.
  313. .RS
  314. .PP
  315. Widgets may be assigned a private colormap by
  316. specifying a fB-colormapfP option; the window manager
  317. is responsible for installing and uninstalling colormaps
  318. as necessary.
  319. .PP
  320. Note that Tk provides no useful details for this event type.
  321. .RE
  322. '" The following events were added in TIP#47
  323. .IP "fBMapRequestfP, fBCirculateRequestfP, fBResizeRequestfP, fBConfigureRequestfP, fBCreatefP" 5
  324. These events are not normally delivered to Tk applications.
  325. They are included for completeness, to make it possible to
  326. write X11 window managers in Tk.
  327. (These events are only delivered when a client has
  328. selected fBSubstructureRedirectMaskfP on a window;
  329. the Tk core does not use this mask.)
  330. .IP "fBGravityfP, fBReparentfP, fBCirculatefP" 5
  331. The events fBGravityfP and fBReparentfP
  332. are not normally delivered to Tk applications.
  333. They are included for completeness.
  334. .RS
  335. .PP
  336. A fBCirculatefP event indicates that the window has moved
  337. to the top or to the bottom of the stacking order as
  338. a result of an fBXCirculateSubwindowsfP protocol request.
  339. Note that the stacking order may be changed for other reasons
  340. which do not generate a fBCirculatefP event, and that
  341. Tk does not use fBXCirculateSubwindows()fP internally.
  342. This event type is included only for completeness;
  343. there is no reliable way to track changes to a window's
  344. position in the stacking order.
  345. .RE
  346. .SH "EVENT DETAILS"
  347. .PP
  348. The last part of a long event specification is fIdetailfR.  In the
  349. case of a fBButtonPressfR or fBButtonReleasefR event, it is the
  350. number of a button (1-5).  If a button number is given, then only an
  351. event on that particular button will match;  if no button number is
  352. given, then an event on any button will match.  Note:  giving a
  353. specific button number is different than specifying a button modifier;
  354. in the first case, it refers to a button being pressed or released,
  355. while in the second it refers to some other button that is already
  356. depressed when the matching event occurs.  If a button
  357. number is given then fItypefR may be omitted:  if will default
  358. to fBButtonPressfR.  For example, the specifier fB<1>fR
  359. is equivalent to fB<ButtonPress-1>fR.
  360. .PP
  361. If the event type is fBKeyPressfR or fBKeyReleasefR, then
  362. fIdetailfR may be specified in the form of an X keysym.  Keysyms
  363. are textual specifications for particular keys on the keyboard;
  364. they include all the alphanumeric ASCII characters (e.g. ``a'' is
  365. the keysym for the ASCII character ``a''), plus descriptions for
  366. non-alphanumeric characters (``comma'' is the keysym for the comma
  367. character), plus descriptions for all the non-ASCII keys on the
  368. keyboard (``Shift_L'' is the keysym for the left shift key, and
  369. ``F1'' is the keysym for the F1 function key, if it exists).  The
  370. complete list of keysyms is not presented here;  it is
  371. available in other X documentation and may vary from system to
  372. system.
  373. If necessary, you can use the fB%KfR notation described below
  374. to print out the keysym name for a particular key.
  375. If a keysym fIdetailfR is given, then the
  376. fItypefR field may be omitted;  it will default to fBKeyPressfR.
  377. For example, fB<Control-comma>fR is equivalent to
  378. fB<Control-KeyPress-comma>fR.
  379. .SH "BINDING SCRIPTS AND SUBSTITUTIONS"
  380. .PP
  381. The fIscriptfR argument to fBbindfR is a Tcl script,
  382. which will be executed whenever the given event sequence occurs.
  383. fICommandfR will be executed in the same interpreter that the
  384. fBbindfR command was executed in, and it will run at global
  385. level (only global variables will be accessible).
  386. If fIscriptfR contains
  387. any fB%fR characters, then the script will not be
  388. executed directly.  Instead, a new script will be
  389. generated by replacing each fB%fR, and the character following
  390. it, with information from the current event.  The replacement
  391. depends on the character following the fB%fR, as defined in the
  392. list below.  Unless otherwise indicated, the
  393. replacement string is the decimal value of the given field from
  394. the current event.
  395. Some of the substitutions are only valid for
  396. certain types of events;  if they are used for other types of events
  397. the value substituted is undefined.
  398. .IP fB%%fR 5
  399. Replaced with a single percent.
  400. .IP fB%#fR 5
  401. The number of the last client request processed by the server
  402. (the fIserialfR field from the event).  Valid for all event
  403. types.
  404. .IP fB%afR 5
  405. The fIabovefR field from the event,
  406. formatted as a hexadecimal number.
  407. Valid only for fBConfigurefR events.
  408. Indicates the sibling window immediately below the receiving window
  409. in the stacking order, or fB0fP if the receiving window is at the
  410. bottom.
  411. .IP fB%bfR 5
  412. The number of the button that was pressed or released.  Valid only
  413. for fBButtonPressfR and fBButtonReleasefR events.
  414. .IP fB%cfR 5
  415. The fIcountfR field from the event.  Valid only for fBExposefR events.
  416. Indicates that there are fIcountfP pending fBExposefP events which have not
  417. yet been delivered to the window.
  418. .IP fB%dfR 5
  419. The fIdetailfR field from the event.  The fB%dfR is replaced by
  420. a string identifying the detail.  For fBEnterfR,
  421. fBLeavefR, fBFocusInfR, and fBFocusOutfR events,
  422. the string will be one of the following:
  423. .RS
  424. .DS
  425. .ta 6c
  426. fBNotifyAncestor NotifyNonlinearVirtual
  427. NotifyDetailNone NotifyPointer
  428. NotifyInferior NotifyPointerRoot
  429. NotifyNonlinear NotifyVirtualfR
  430. .DE
  431. For fBConfigureRequestfR events, the string will be one of:
  432. .DS
  433. .ta 6c
  434. fBAbove Opposite
  435. Below None
  436. BottomIf TopIffR
  437. .DE
  438. For events other than these, the substituted string is undefined.
  439. .RE
  440. .IP fB%ffR 5
  441. The fIfocusfR field from the event (fB0fR or fB1fR).  Valid only
  442. for fBEnterfR and fBLeavefR events.  fB1fP if the receiving 
  443. window is the focus window or a descendant of the focus window, 
  444. fB0fP otherwise.
  445. .IP fB%hfR 5
  446. .VS
  447. The fIheightfR field from the event.  Valid for the fBConfigurefR,
  448. fBConfigureRequestfR, fBCreatefR, fBResizeRequestfR, and
  449. fBExposefR events.
  450. Indicates the new or requested height of the window.
  451. .VE
  452. .IP fB%ifR 5
  453. The fIwindowfR field from the event, represented as a hexadecimal
  454. integer.  Valid for all event types.
  455. .IP fB%kfR 5
  456. The fIkeycodefR field from the event.  Valid only for fBKeyPressfR
  457. and fBKeyReleasefR events.
  458. .IP fB%mfR 5
  459. The fImodefR field from the event.  The substituted string is one of
  460. fBNotifyNormalfR, fBNotifyGrabfR, fBNotifyUngrabfR, or
  461. .VS
  462. fBNotifyWhileGrabbedfR.  Valid only for fBEnterfR,
  463. fBFocusInfR, fBFocusOutfR, and fBLeavefR events.
  464. .VE
  465. .IP fB%ofR 5
  466. The fIoverride_redirectfR field from the event.  Valid only for
  467. fBMapfR, fBReparentfR, and fBConfigurefR events.
  468. .IP fB%pfR 5
  469. The fIplacefR field from the event, substituted as one of the
  470. strings fBPlaceOnTopfR or fBPlaceOnBottomfR.  Valid only
  471. for fBCirculatefR and fBCirculateRequestfR events.
  472. .IP fB%sfR 5
  473. The fIstatefR field from the event.  For fBButtonPressfR,
  474. fBButtonReleasefR, fBEnterfR, fBKeyPressfR, fBKeyReleasefR,
  475. fBLeavefR, and fBMotionfR events, a decimal string
  476. is substituted.  For fBVisibilityfR, one of the strings
  477. fBVisibilityUnobscuredfR, fBVisibilityPartiallyObscuredfR,
  478. and fBVisibilityFullyObscuredfR is substituted.
  479. For fBPropertyfP events, substituted with
  480. either the string fBNewValuefP (indicating that the property
  481. has been created or modified) or fBDeletefP (indicating that
  482. the property has been removed).
  483. .IP fB%tfR 5
  484. The fItimefR field from the event.
  485. This is the X server timestamp (typically the time since
  486. the last server reset) in milliseconds, when the event occurred.
  487. Valid for most events.  
  488. .IP fB%wfR 5
  489. The fIwidthfR field from the event.
  490. Indicates the new or requested width of the window.
  491. Valid only for
  492. .VS
  493. fBConfigurefR, fBConfigureRequestfR, fBCreatefR,
  494. fBResizeRequestfR, and fBExposefR events.
  495. .VE
  496. .IP "fB%xfR, fB%yfR" 5
  497. The fIxfR and fIyfR fields from the event.
  498. For fBButtonPressfP, fBButtonReleasefP, fBMotionfP, 
  499. fBKeyPressfP, fBKeyReleasefP, and fBMouseWheelfP events,
  500. fB%xfP and fB%yfP indicate the position of the mouse pointer
  501. relative to the receiving window.
  502. For fBEnterfP and fBLeavefP events, the position where the 
  503. mouse pointer crossed the window, relative to the receiving window.
  504. For fBConfigurefP and fBCreatefP requests, the fIxfP and fIyfP
  505. coordinates of the window relative to its parent window.
  506. .IP fB%AfR 5
  507. Substitutes the UNICODE character corresponding to the event, or
  508. the empty string if the event doesn't correspond to a UNICODE character
  509. (e.g. the shift key was pressed). fBXmbLookupStringfR (or
  510. fBXLookupStringfR when input method support is turned off) does all
  511. the work of translating from the event to a UNICODE character.
  512. Valid only for fBKeyPressfR and fBKeyReleasefR events.
  513. .IP fB%BfR 5
  514. The fIborder_widthfR field from the event.  Valid only for
  515. fBConfigurefR, fBConfigureRequestfR, and fBCreatefR events.
  516. .IP fB%DfR 5
  517. .VS
  518. This reports the fIdeltafR value of a fBMouseWheelfR event.  The
  519. fIdeltafR value represents the rotation units the mouse wheel has
  520. been moved.  On Windows 95 & 98 systems the smallest value for the
  521. delta is 120.  Future systems may support higher resolution values for
  522. the delta.  The sign of the value represents the direction the mouse
  523. wheel was scrolled.
  524. .VE
  525. .IP fB%EfR 5
  526. The fIsend_eventfR field from the event.  Valid for all event types.
  527. fB0fP indicates that this is a ``normal'' event, fB1fP indicates
  528. that it is a ``synthetic'' event generated by fBSendEventfP.
  529. .IP fB%KfR 5
  530. The keysym corresponding to the event, substituted as a textual
  531. string.  Valid only for fBKeyPressfR and fBKeyReleasefR events.
  532. .IP fB%NfR 5
  533. The keysym corresponding to the event, substituted as a decimal
  534. number.  Valid only for fBKeyPressfR and fBKeyReleasefR events.
  535. .IP fB%PfR 5
  536. The name of the property being updated or deleted (which
  537. may be converted to an XAtom using fBwinfo atomfR.) Valid
  538. only for fBPropertyfP events.
  539. .IP fB%RfR 5
  540. The fIrootfR window identifier from the event.  Valid only for
  541. events containing a fIrootfR field.
  542. .IP fB%SfR 5
  543. The fIsubwindowfR window identifier from the event,
  544. formatted as a hexadecimal number.
  545. Valid only for events containing a fIsubwindowfR field.
  546. .IP fB%TfR 5
  547. The fItypefR field from the event.  Valid for all event types.
  548. .IP fB%WfR 5
  549. The path name of the window to which the event was reported (the
  550. fIwindowfR field from the event).  Valid for all event types.
  551. .IP fB%XfR 5
  552. The fIx_rootfR field from the event.
  553. If a virtual-root window manager is being used then the substituted
  554. value is the corresponding x-coordinate in the virtual root.
  555. Valid only for
  556. fBButtonPressfR, fBButtonReleasefR, fBKeyPressfR, fBKeyReleasefR,
  557. and fBMotionfR events.
  558. Same meaning as fB%xfP, except relative to the (virtual) root window.
  559. .IP fB%YfR 5
  560. The fIy_rootfR field from the event.
  561. If a virtual-root window manager is being used then the substituted
  562. value is the corresponding y-coordinate in the virtual root.
  563. Valid only for
  564. fBButtonPressfR, fBButtonReleasefR, fBKeyPressfR, fBKeyReleasefR,
  565. and fBMotionfR events.
  566. Same meaning as fB%yfP, except relative to the (virtual) root window.
  567. .LP
  568. The replacement string for a %-replacement is formatted as a proper
  569. Tcl list element.
  570. This means that it will be surrounded with braces
  571. if it contains spaces, or special characters such as fB$fR and
  572. fB{fR may be preceded by backslashes.
  573. This guarantees that the string will be passed through the Tcl
  574. parser when the binding script is evaluated.
  575. Most replacements are numbers or well-defined strings such
  576. as fBAbovefR;  for these replacements no special formatting
  577. is ever necessary.
  578. The most common case where reformatting occurs is for the fB%AfR
  579. substitution.  For example, if fIscriptfR is
  580. .CS
  581. fBinsert%AfR
  582. .CE
  583. and the character typed is an open square bracket, then the script
  584. actually executed will be
  585. .CS
  586. fBinserte[fR
  587. .CE
  588. This will cause the fBinsertfR to receive the original replacement
  589. string (open square bracket) as its first argument.
  590. If the extra backslash hadn't been added, Tcl would not have been
  591. able to parse the script correctly.
  592. .SH "MULTIPLE MATCHES"
  593. .PP
  594. It is possible for several bindings to match a given X event.
  595. If the bindings are associated with different fItagfR's,
  596. then each of the bindings will be executed, in order.
  597. By default, a binding for the widget will be executed first, followed
  598. by a class binding, a binding for its toplevel, and
  599. an fBallfR binding.
  600. The fBbindtagsfR command may be used to change this order for
  601. a particular window or to associate additional binding tags with
  602. the window.
  603. .PP
  604. The fBcontinuefR and fBbreakfR commands may be used inside a
  605. binding script to control the processing of matching scripts.
  606. If fBcontinuefR is invoked, then the current binding script
  607. is terminated but Tk will continue processing binding scripts
  608. associated with other fItagfR's.
  609. If the fBbreakfR command is invoked within a binding script,
  610. then that script terminates and no other scripts will be invoked
  611. for the event.
  612. .PP
  613. If more than one binding matches a particular event and they
  614. have the same fItagfR, then the most specific binding
  615. is chosen and its script is evaluated.
  616. The following tests are applied, in order, to determine which of
  617. several matching sequences is more specific:
  618. (a) an event pattern that specifies a specific button or key is more specific
  619. than one that doesn't;
  620. (b) a longer sequence (in terms of number
  621. of events matched) is more specific than a shorter sequence;
  622. (c) if the modifiers specified in one pattern are a subset of the
  623. modifiers in another pattern, then the pattern with more modifiers
  624. is more specific.
  625. (d) a virtual event whose physical pattern matches the sequence is less
  626. specific than the same physical pattern that is not associated with a 
  627. virtual event.
  628. (e) given a sequence that matches two or more virtual events, one 
  629. of the virtual events will be chosen, but the order is undefined.
  630. .PP
  631. If the matching sequences contain more than one event, then tests
  632. (c)-(e) are applied in order from the most recent event to the least recent
  633. event in the sequences.  If these tests fail to determine a winner, then the
  634. most recently registered sequence is the winner.
  635. .PP
  636. If there are two (or more) virtual events that are both triggered by the
  637. same sequence, and both of those virtual events are bound to the same window
  638. tag, then only one of the virtual events will be triggered, and it will
  639. be picked at random:  
  640. .CS
  641. event add <<Paste>> <Control-y>
  642. event add <<Paste>> <Button-2>
  643. event add <<Scroll>> <Button-2>
  644. fBbindfR Entry <<Paste>> {puts Paste}
  645. fBbindfR Entry <<Scroll>> {puts Scroll}
  646. .CE
  647. If the user types Control-y, the fB<<Paste>>fR binding
  648. will be invoked, but if the user presses button 2 then one of
  649. either the fB<<Paste>>fR or the fB<<Scroll>>fR bindings will
  650. be invoked, but exactly which one gets invoked is undefined.
  651. .PP
  652. If an X event does not match any of the existing bindings, then the
  653. event is ignored.
  654. An unbound event is not considered to be an error.
  655. .SH "MULTI-EVENT SEQUENCES AND IGNORED EVENTS"
  656. .PP
  657. When a fIsequencefR specified in a fBbindfR command contains
  658. more than one event pattern, then its script is executed whenever
  659. the recent events (leading up to and including the current event)
  660. match the given sequence.  This means, for example, that if button 1 is
  661. clicked repeatedly the sequence fB<Double-ButtonPress-1>fR will match
  662. each button press but the first.
  663. If extraneous events that would prevent a match occur in the middle
  664. of an event sequence then the extraneous events are
  665. ignored unless they are fBKeyPressfR or fBButtonPressfR events.
  666. For example, fB<Double-ButtonPress-1>fR will match a sequence of
  667. presses of button 1, even though there will be fBButtonReleasefR
  668. events (and possibly fBMotionfR events) between the
  669. fBButtonPressfR events.
  670. Furthermore, a fBKeyPressfR event may be preceded by any number
  671. of other fBKeyPressfR events for modifier keys without the
  672. modifier keys preventing a match.
  673. For example, the event sequence fBaBfR will match a press of the
  674. fBafR key, a release of the fBafR key, a press of the fBShiftfR
  675. key, and a press of the fBbfR key:  the press of fBShiftfR is
  676. ignored because it is a modifier key.
  677. Finally, if several fBMotionfR events occur in a row, only
  678. the last one is used for purposes of matching binding sequences.
  679. .SH "ERRORS"
  680. .PP
  681. If an error occurs in executing the script for a binding then the
  682. fBbgerrorfR mechanism is used to report the error.
  683. The fBbgerrorfR command will be executed at global level
  684. (outside the context of any Tcl procedure).
  685. .SH "EXAMPLES"
  686. Arrange for a string describing the motion of the mouse to be printed
  687. out when the mouse is double-clicked:
  688. .CS
  689. fBbindfR . <Double-1> {
  690.     puts "hi from (%x,%y)"
  691. }
  692. .CE
  693. .PP
  694. A little GUI that displays what the keysym name of the last key
  695. pressed is:
  696. .CS
  697. set keysym "Press any key"
  698. pack [label .l -textvariable keysym -padx 2m -pady 1m]
  699. fBbindfR . <Key> {
  700.     set keysym "You pressed %K"
  701. }
  702. .CE
  703. .SH "SEE ALSO"
  704. bgerror(n), bindtags(n), event(n), focus(n), grab(n), keysyms(n)
  705. .SH KEYWORDS
  706. binding, event