| '\" |
| '\" Copyright (c) 1996 Sun Microsystems, Inc. |
| '\" Copyright (c) 1998-2000 Ajuba Solutions. |
| '\" |
| '\" See the file "license.terms" for information on usage and redistribution |
| '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. |
| '\" |
| '\" RCS: @(#) $Id: event.n,v 1.6 2000/11/03 01:13:51 hobbs Exp $ |
| '\" |
| '\" The definitions below are for supplemental macros used in Tcl/Tk |
| '\" manual entries. |
| '\" |
| '\" .AP type name in/out ?indent? |
| '\" Start paragraph describing an argument to a library procedure. |
| '\" type is type of argument (int, etc.), in/out is either "in", "out", |
| '\" or "in/out" to describe whether procedure reads or modifies arg, |
| '\" and indent is equivalent to second arg of .IP (shouldn't ever be |
| '\" needed; use .AS below instead) |
| '\" |
| '\" .AS ?type? ?name? |
| '\" Give maximum sizes of arguments for setting tab stops. Type and |
| '\" name are examples of largest possible arguments that will be passed |
| '\" to .AP later. If args are omitted, default tab stops are used. |
| '\" |
| '\" .BS |
| '\" Start box enclosure. From here until next .BE, everything will be |
| '\" enclosed in one large box. |
| '\" |
| '\" .BE |
| '\" End of box enclosure. |
| '\" |
| '\" .CS |
| '\" Begin code excerpt. |
| '\" |
| '\" .CE |
| '\" End code excerpt. |
| '\" |
| '\" .VS ?version? ?br? |
| '\" Begin vertical sidebar, for use in marking newly-changed parts |
| '\" of man pages. The first argument is ignored and used for recording |
| '\" the version when the .VS was added, so that the sidebars can be |
| '\" found and removed when they reach a certain age. If another argument |
| '\" is present, then a line break is forced before starting the sidebar. |
| '\" |
| '\" .VE |
| '\" End of vertical sidebar. |
| '\" |
| '\" .DS |
| '\" Begin an indented unfilled display. |
| '\" |
| '\" .DE |
| '\" End of indented unfilled display. |
| '\" |
| '\" .SO |
| '\" Start of list of standard options for a Tk widget. The |
| '\" options follow on successive lines, in four columns separated |
| '\" by tabs. |
| '\" |
| '\" .SE |
| '\" End of list of standard options for a Tk widget. |
| '\" |
| '\" .OP cmdName dbName dbClass |
| '\" Start of description of a specific option. cmdName gives the |
| '\" option's name as specified in the class command, dbName gives |
| '\" the option's name in the option database, and dbClass gives |
| '\" the option's class in the option database. |
| '\" |
| '\" .UL arg1 arg2 |
| '\" Print arg1 underlined, then print arg2 normally. |
| '\" |
| '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $ |
| '\" |
| '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. |
| .if t .wh -1.3i ^B |
| .nr ^l \n(.l |
| .ad b |
| '\" # Start an argument description |
| .de AP |
| .ie !"\\$4"" .TP \\$4 |
| .el \{\ |
| . ie !"\\$2"" .TP \\n()Cu |
| . el .TP 15 |
| .\} |
| .ta \\n()Au \\n()Bu |
| .ie !"\\$3"" \{\ |
| \&\\$1 \\fI\\$2\\fP (\\$3) |
| .\".b |
| .\} |
| .el \{\ |
| .br |
| .ie !"\\$2"" \{\ |
| \&\\$1 \\fI\\$2\\fP |
| .\} |
| .el \{\ |
| \&\\fI\\$1\\fP |
| .\} |
| .\} |
| .. |
| '\" # define tabbing values for .AP |
| .de AS |
| .nr )A 10n |
| .if !"\\$1"" .nr )A \\w'\\$1'u+3n |
| .nr )B \\n()Au+15n |
| .\" |
| .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n |
| .nr )C \\n()Bu+\\w'(in/out)'u+2n |
| .. |
| .AS Tcl_Interp Tcl_CreateInterp in/out |
| '\" # BS - start boxed text |
| '\" # ^y = starting y location |
| '\" # ^b = 1 |
| .de BS |
| .br |
| .mk ^y |
| .nr ^b 1u |
| .if n .nf |
| .if n .ti 0 |
| .if n \l'\\n(.lu\(ul' |
| .if n .fi |
| .. |
| '\" # BE - end boxed text (draw box now) |
| .de BE |
| .nf |
| .ti 0 |
| .mk ^t |
| .ie n \l'\\n(^lu\(ul' |
| .el \{\ |
| .\" Draw four-sided box normally, but don't draw top of |
| .\" box if the box started on an earlier page. |
| .ie !\\n(^b-1 \{\ |
| \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' |
| .\} |
| .el \}\ |
| \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' |
| .\} |
| .\} |
| .fi |
| .br |
| .nr ^b 0 |
| .. |
| '\" # VS - start vertical sidebar |
| '\" # ^Y = starting y location |
| '\" # ^v = 1 (for troff; for nroff this doesn't matter) |
| .de VS |
| .if !"\\$2"" .br |
| .mk ^Y |
| .ie n 'mc \s12\(br\s0 |
| .el .nr ^v 1u |
| .. |
| '\" # VE - end of vertical sidebar |
| .de VE |
| .ie n 'mc |
| .el \{\ |
| .ev 2 |
| .nf |
| .ti 0 |
| .mk ^t |
| \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' |
| .sp -1 |
| .fi |
| .ev |
| .\} |
| .nr ^v 0 |
| .. |
| '\" # Special macro to handle page bottom: finish off current |
| '\" # box/sidebar if in box/sidebar mode, then invoked standard |
| '\" # page bottom macro. |
| .de ^B |
| .ev 2 |
| 'ti 0 |
| 'nf |
| .mk ^t |
| .if \\n(^b \{\ |
| .\" Draw three-sided box if this is the box's first page, |
| .\" draw two sides but no top otherwise. |
| .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 |
| .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c |
| .\} |
| .if \\n(^v \{\ |
| .nr ^x \\n(^tu+1v-\\n(^Yu |
| \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c |
| .\} |
| .bp |
| 'fi |
| .ev |
| .if \\n(^b \{\ |
| .mk ^y |
| .nr ^b 2 |
| .\} |
| .if \\n(^v \{\ |
| .mk ^Y |
| .\} |
| .. |
| '\" # DS - begin display |
| .de DS |
| .RS |
| .nf |
| .sp |
| .. |
| '\" # DE - end display |
| .de DE |
| .fi |
| .RE |
| .sp |
| .. |
| '\" # SO - start of list of standard options |
| .de SO |
| .SH "STANDARD OPTIONS" |
| .LP |
| .nf |
| .ta 5.5c 11c |
| .ft B |
| .. |
| '\" # SE - end of list of standard options |
| .de SE |
| .fi |
| .ft R |
| .LP |
| See the \\fBoptions\\fR manual entry for details on the standard options. |
| .. |
| '\" # OP - start of full description for a single option |
| .de OP |
| .LP |
| .nf |
| .ta 4c |
| Command-Line Name: \\fB\\$1\\fR |
| Database Name: \\fB\\$2\\fR |
| Database Class: \\fB\\$3\\fR |
| .fi |
| .IP |
| .. |
| '\" # CS - begin code excerpt |
| .de CS |
| .RS |
| .nf |
| .ta .25i .5i .75i 1i |
| .. |
| '\" # CE - end code excerpt |
| .de CE |
| .fi |
| .RE |
| .. |
| .de UL |
| \\$1\l'|0\(ul'\\$2 |
| .. |
| .TH event n 8.3 Tk "Tk Built-In Commands" |
| .BS |
| '\" Note: do not modify the .SH NAME line immediately below! |
| .SH NAME |
| event \- Miscellaneous event facilities: define virtual events and generate events |
| .SH SYNOPSIS |
| \fBevent\fI option \fR?\fIarg arg ...\fR? |
| .BE |
| |
| .SH DESCRIPTION |
| .PP |
| The \fBevent\fR command provides several facilities for dealing with |
| window system events, such as defining virtual events and synthesizing |
| events. The command has several different forms, determined by the |
| first argument. The following forms are currently supported: |
| .TP |
| \fBevent add <<\fIvirtual\fB>>\fI sequence \fR?\fIsequence ...\fR? |
| Associates the virtual event \fIvirtual\fR with the physical |
| event sequence(s) given by the \fIsequence\fR arguments, so that |
| the virtual event will trigger whenever any one of the \fIsequence\fRs |
| occurs. |
| \fIVirtual\fR may be any string value and \fIsequence\fR may have |
| any of the values allowed for the \fIsequence\fR argument to the |
| \fBbind\fR command. |
| If \fIvirtual\fR is already defined, the new physical event sequences |
| add to the existing sequences for the event. |
| .TP |
| \fBevent delete <<\fIvirtual\fB>> \fR?\fIsequence\fR \fIsequence ...\fR? |
| Deletes each of the \fIsequence\fRs from those associated with |
| the virtual event given by \fIvirtual\fR. |
| \fIVirtual\fR may be any string value and \fIsequence\fR may have |
| any of the values allowed for the \fIsequence\fR argument to the |
| \fBbind\fR command. |
| Any \fIsequence\fRs not currently associated with \fIvirtual\fR |
| are ignored. |
| If no \fIsequence\fR argument is provided, all physical event sequences |
| are removed for \fIvirtual\fR, so that the virtual event will not |
| trigger anymore. |
| .TP |
| \fBevent generate \fIwindow event \fR?\fIoption value option value ...\fR? |
| Generates a window event and arranges for it to be processed just as if |
| it had come from the window system. |
| \fIWindow\fR gives the path name of the window for which the event |
| .VS 8.3 |
| will be generated; it may also be an identifier (such as returned by |
| \fBwinfo id\fR) as long as it is for a window in the current application. |
| .VE |
| \fIEvent\fR provides a basic description of |
| the event, such as \fB<Shift-Button-2>\fR or \fB<<Paste>>\fR. |
| If \fIWindow\fR is empty the whole screen is meant, and coordinates |
| are relative to the screen. |
| \fIEvent\fR may have any of the forms allowed for the \fIsequence\fR |
| argument of the \fBbind\fR command except that it must consist |
| of a single event pattern, not a sequence. |
| \fIOption-value\fR pairs may be used to specify additional |
| attributes of the event, such as the x and y mouse position; see |
| EVENT FIELDS below. If the \fB\-when\fR option is not specified, the |
| event is processed immediately: all of the handlers for the event |
| will complete before the \fBevent generate\fR command returns. |
| If the \fB\-when\fR option is specified then it determines when the |
| event is processed. Certain events, such as key events, require |
| that the window has focus to receive the event properly. |
| .TP |
| \fBevent info \fR?<<\fIvirtual\fB>>\fR? |
| Returns information about virtual events. |
| If the \fB<<\fIvirtual\fB>>\fR argument is omitted, the return value |
| is a list of all the virtual events that are currently defined. |
| If \fB<<\fIvirtual\fB>>\fR is specified then the return value is |
| a list whose elements are the physical event sequences currently |
| defined for the given virtual event; if the virtual event is |
| not defined then an empty string is returned. |
| |
| .SH "EVENT FIELDS" |
| .PP |
| The following options are supported for the \fBevent generate\fR |
| command. These correspond to the ``%'' expansions |
| allowed in binding scripts for the \fBbind\fR command. |
| .TP |
| \fB\-above\fI window\fR |
| \fIWindow\fR specifies the \fIabove\fR field for the event, |
| either as a window path name or as an integer window id. |
| Valid for \fBConfigure\fR events. |
| Corresponds to the \fB%a\fR substitution for binding scripts. |
| .TP |
| \fB\-borderwidth\fI size\fR |
| \fISize\fR must be a screen distance; it specifies the |
| \fIborder_width\fR field for the event. |
| Valid for \fBConfigure\fR events. |
| Corresponds to the \fB%B\fR substitution for binding scripts. |
| .TP |
| \fB\-button\fI number\fR |
| \fINumber\fR must be an integer; it specifies the \fIdetail\fR field |
| for a \fBButtonPress\fR or \fBButtonRelease\fR event, overriding |
| any button number provided in the base \fIevent\fR argument. |
| Corresponds to the \fB%b\fR substitution for binding scripts. |
| .TP |
| \fB\-count\fI number\fR |
| \fINumber\fR must be an integer; it specifies the \fIcount\fR field |
| for the event. Valid for \fBExpose\fR events. |
| Corresponds to the \fB%c\fR substitution for binding scripts. |
| .TP |
| \fB\-delta\fI number\fR |
| \fINumber\fR must be an integer; it specifies the \fIdelta\fR field |
| for the \fBMouseWheel\fR event. The \fIdelta\fR refers to the |
| direction and magnitude the mouse wheel was rotated. Note the value |
| is not a screen distance but are units of motion in the mouse wheel. |
| Typically these values are multiples of 120. For example, 120 should |
| scroll the text widget up 4 lines and -240 would scroll the text |
| widget down 8 lines. Of course, other widgets may define different |
| behaviors for mouse wheel motion. This field corresponds to the |
| \fB%D\fR substitution for binding scripts. |
| .TP |
| \fB\-detail\fI detail\fR |
| \fIDetail\fR specifies the \fIdetail\fR field for the event |
| and must be one of the following: |
| .RS |
| .DS |
| .ta 6c |
| \fBNotifyAncestor NotifyNonlinearVirtual |
| NotifyDetailNone NotifyPointer |
| NotifyInferior NotifyPointerRoot |
| NotifyNonlinear NotifyVirtual\fR |
| .DE |
| Valid for \fBEnter\fR, \fBLeave\fR, \fBFocusIn\fR and |
| \fBFocusOut\fR events. |
| Corresponds to the \fB%d\fR substitution for binding scripts. |
| .RE |
| .TP |
| \fB\-focus\fI boolean\fR |
| \fIBoolean\fR must be a boolean value; it specifies the \fIfocus\fR |
| field for the event. |
| Valid for \fBEnter\fR and \fBLeave\fR events. |
| Corresponds to the \fB%f\fR substitution for binding scripts. |
| .TP |
| \fB\-height\fI size\fR |
| \fISize\fR must be a screen distance; it specifies the \fIheight\fR |
| field for the event. Valid for \fBConfigure\fR events. |
| Corresponds to the \fB%h\fR substitution for binding scripts. |
| .TP |
| \fB\-keycode\fI number\fR |
| \fINumber\fR must be an integer; it specifies the \fIkeycode\fR |
| field for the event. |
| Valid for \fBKeyPress\fR and \fBKeyRelease\fR events. |
| Corresponds to the \fB%k\fR substitution for binding scripts. |
| .TP |
| \fB\-keysym\fI name\fR |
| \fIName\fR must be the name of a valid keysym, such as \fBg\fR, |
| \fBspace\fR, or \fBReturn\fR; its corresponding |
| keycode value is used as the \fIkeycode\fR field for event, overriding |
| any detail specified in the base \fIevent\fR argument. |
| Valid for \fBKeyPress\fR and \fBKeyRelease\fR events. |
| Corresponds to the \fB%K\fR substitution for binding scripts. |
| .TP |
| \fB\-mode\fI notify\fR |
| \fINotify\fR specifies the \fImode\fR field for the event and must be |
| one of \fBNotifyNormal\fR, \fBNotifyGrab\fR, \fBNotifyUngrab\fR, or |
| \fBNotifyWhileGrabbed\fR. |
| Valid for \fBEnter\fR, \fBLeave\fR, \fBFocusIn\fR, and |
| \fBFocusOut\fR events. |
| Corresponds to the \fB%m\fR substitution for binding scripts. |
| .TP |
| \fB\-override\fI boolean\fR |
| \fIBoolean\fR must be a boolean value; it specifies the |
| \fIoverride_redirect\fR field for the event. |
| Valid for \fBMap\fR, \fBReparent\fR, and \fBConfigure\fR events. |
| Corresponds to the \fB%o\fR substitution for binding scripts. |
| .TP |
| \fB\-place\fI where\fR |
| \fIWhere\fR specifies the \fIplace\fR field for the event; it must be |
| either \fBPlaceOnTop\fR or \fBPlaceOnBottom\fR. |
| Valid for \fBCirculate\fR events. |
| Corresponds to the \fB%p\fR substitution for binding scripts. |
| .TP |
| \fB\-root\fI window\fR |
| \fIWindow\fR must be either a window path name or an integer window |
| identifier; it specifies the \fIroot\fR field for the event. |
| Valid for \fBKeyPress\fR, \fBKeyRelease\fR, \fBButtonPress\fR, |
| \fBButtonRelease\fR, \fBEnter\fR, \fBLeave\fR, and \fBMotion\fR |
| events. |
| Corresponds to the \fB%R\fR substitution for binding scripts. |
| .TP |
| \fB\-rootx\fI coord\fR |
| \fICoord\fR must be a screen distance; it specifies the \fIx_root\fR |
| field for the event. |
| Valid for \fBKeyPress\fR, \fBKeyRelease\fR, \fBButtonPress\fR, |
| \fBButtonRelease\fR, \fBEnter\fR, \fBLeave\fR, and \fBMotion\fR |
| events. Corresponds to the \fB%X\fR substitution for binding scripts. |
| .TP |
| \fB\-rooty\fI coord\fR |
| \fICoord\fR must be a screen distance; it specifies th \fIy_root\fR |
| field for the event. |
| Valid for \fBKeyPress\fR, \fBKeyRelease\fR, \fBButtonPress\fR, |
| \fBButtonRelease\fR, \fBEnter\fR, \fBLeave\fR, and \fBMotion\fR |
| events. |
| Corresponds to the \fB%Y\fR substitution for binding scripts. |
| .TP |
| \fB\-sendevent\fI boolean\fR |
| \fBBoolean\fR must be a boolean value; it specifies the \fIsend_event\fR |
| field for the event. Valid for all events. Corresponds to the |
| \fB%E\fR substitution for binding scripts. |
| .TP |
| \fB\-serial\fI number\fR |
| \fINumber\fR must be an integer; it specifies the \fIserial\fR field |
| for the event. Valid for all events. |
| Corresponds to the \fB%#\fR substitution for binding scripts. |
| .TP |
| \fB\-state\fI state\fR |
| \fIState\fR specifies the \fIstate\fR field for the event. |
| For \fBKeyPress\fR, \fBKeyRelease\fR, \fBButtonPress\fR, |
| \fBButtonRelease\fR, \fBEnter\fR, \fBLeave\fR, and \fBMotion\fR events |
| it must be an integer value. |
| For \fBVisibility\fR events it must be one of \fBVisibilityUnobscured\fR, |
| \fBVisibilityPartiallyObscured\fR, or \fBVisibilityFullyObscured\fR. |
| This option overrides any modifiers such as \fBMeta\fR or \fBControl\fR |
| specified in the base \fIevent\fR. |
| Corresponds to the \fB%s\fR substitution for binding scripts. |
| .TP |
| \fB\-subwindow\fI window\fR |
| \fIWindow\fR specifies the \fIsubwindow\fR field for the event, either |
| as a path name for a Tk widget or as an integer window identifier. |
| Valid for \fBKeyPress\fR, \fBKeyRelease\fR, \fBButtonPress\fR, |
| \fBButtonRelease\fR, \fBEnter\fR, \fBLeave\fR, and \fBMotion\fR events. |
| Similar to \fB%S\fR substitution for binding scripts. |
| .TP |
| \fB\-time\fI integer\fR |
| \fIInteger\fR must be an integer value; it specifies the \fItime\fR field |
| for the event. |
| Valid for \fBKeyPress\fR, \fBKeyRelease\fR, \fBButtonPress\fR, |
| \fBButtonRelease\fR, \fBEnter\fR, \fBLeave\fR, \fBMotion\fR, |
| and \fBProperty\fR events. |
| Corresponds to the \fB%t\fR substitution for binding scripts. |
| .TP |
| \fB\-warp\fI boolean\fR |
| \fIboolean\fR must be a boolean value; it specifies whether |
| the screen pointer should be warped as well. |
| Valid for \fBKeyPress\fR, \fBKeyRelease\fR, \fBButtonPress\fR, |
| \fBButtonRelease\fR, and \fBMotion\fR events. The pointer will |
| only warp to a window if it is mapped. |
| .TP |
| \fB\-width\fI size\fR |
| \fISize\fR must be a screen distance; it specifies the \fIwidth\fR field |
| for the event. |
| Valid for \fBConfigure\fR events. |
| Corresponds to the \fB%w\fR substitution for binding scripts. |
| .TP |
| \fB\-when\fI when\fR |
| \fIWhen\fR determines when the event will be processed; it must have one |
| of the following values: |
| .RS |
| .IP \fBnow\fR 10 |
| Process the event immediately, before the command returns. |
| This also happens if the \fB\-when\fR option is omitted. |
| .IP \fBtail\fR 10 |
| Place the event on Tcl's event queue behind any events already |
| queued for this application. |
| .IP \fBhead\fR 10 |
| Place the event at the front of Tcl's event queue, so that it |
| will be handled before any other events already queued. |
| .IP \fBmark\fR 10 |
| Place the event at the front of Tcl's event queue but behind any |
| other events already queued with \fB\-when mark\fR. |
| This option is useful when generating a series of events that should |
| be processed in order but at the front of the queue. |
| .RE |
| .TP |
| \fB\-x\fI coord\fR |
| \fICoord\fR must be a screen distance; it specifies the \fIx\fR field |
| for the event. |
| Valid for \fBKeyPress\fR, \fBKeyRelease\fR, \fBButtonPress\fR, |
| \fBButtonRelease\fR, \fBMotion\fR, \fBEnter\fR, \fBLeave\fR, |
| \fBExpose\fR, \fBConfigure\fR, \fBGravity\fR, and \fBReparent\fR |
| events. |
| Corresponds to the the \fB%x\fR substitution for binding scripts. |
| If \fIWindow\fR is empty the coordinate is relative to the |
| screen, and this option corresponds to the \fB%X\fR substitution |
| for binding scripts. |
| .TP |
| \fB\-y\fI coord\fR |
| \fICoord\fR must be a screen distance; it specifies the \fIy\fR |
| field for the event. |
| Valid for \fBKeyPress\fR, \fBKeyRelease\fR, \fBButtonPress\fR, |
| \fBButtonRelease\fR, \fBMotion\fR, \fBEnter\fR, \fBLeave\fR, |
| \fBExpose\fR, \fBConfigure\fR, \fBGravity\fR, and \fBReparent\fR |
| events. |
| Corresponds to the the \fB%y\fR substitution for binding scripts. |
| If \fIWindow\fR is empty the coordinate is relative to the |
| screen, and this option corresponds to the \fB%Y\fR substitution |
| for binding scripts. |
| .PP |
| Any options that are not specified when generating an event are filled |
| with the value 0, except for \fIserial\fR, which is filled with the |
| next X event serial number. |
| |
| .SH "VIRTUAL EVENT EXAMPLES" |
| .PP |
| In order for a virtual event binding to trigger, two things must |
| happen. First, the virtual event must be defined with the |
| \fBevent add\fR command. Second, a binding must be created for |
| the virtual event with the \fBbind\fR command. |
| Consider the following virtual event definitions: |
| .CS |
| event add <<Paste>> <Control-y> |
| event add <<Paste>> <Button-2> |
| event add <<Save>> <Control-X><Control-S> |
| event add <<Save>> <Shift-F12> |
| .CE |
| In the \fBbind\fR command, a virtual event can be bound like any other |
| builtin event type as follows: |
| .CS |
| bind Entry <<Paste>> {%W insert [selection get]} |
| .CE |
| The double angle brackets are used to specify that a virtual event is being |
| bound. If the user types Control-y or presses button 2, or if |
| a \fB<<Paste>>\fR virtual event is synthesized with \fBevent generate\fR, |
| then the \fB<<Paste>>\fR binding will be invoked. |
| .PP |
| If a virtual binding has the exact same sequence as a separate |
| physical binding, then the physical binding will take precedence. |
| Consider the following example: |
| .CS |
| event add <<Paste>> <Control-y> <Meta-Control-y> |
| bind Entry <Control-y> {puts Control-y} |
| bind Entry <<Paste>> {puts Paste} |
| .CE |
| When the user types Control-y the \fB<Control-y>\fR binding |
| will be invoked, because a physical event is considered |
| more specific than a virtual event, all other things being equal. |
| However, when the user types Meta-Control-y the |
| \fB<<Paste>>\fR binding will be invoked, because the |
| \fBMeta\fR modifier in the physical pattern associated with the |
| virtual binding is more specific than the \fB<Control-y\fR> sequence for |
| the physical event. |
| .PP |
| Bindings on a virtual event may be created before the virtual event exists. |
| Indeed, the virtual event never actually needs to be defined, for instance, |
| on platforms where the specific virtual event would meaningless or |
| ungeneratable. |
| .PP |
| When a definition of a virtual event changes at run time, all windows |
| will respond immediately to the new definition. |
| Starting from the preceding example, if the following code is executed: |
| .CS |
| bind <Entry> <Control-y> {} |
| event add <<Paste>> <Key-F6> |
| .CE |
| the behavior will change such in two ways. First, the shadowed |
| \fB<<Paste>>\fR binding will emerge. |
| Typing Control-y will no longer invoke the \fB<Control-y>\fR binding, |
| but instead invoke the virtual event \fB<<Paste>>\fR. Second, |
| pressing the F6 key will now also invoke the \fB<<Paste>>\fR binding. |
| |
| .SH "SEE ALSO" |
| bind |
| |
| .SH KEYWORDS |
| event, binding, define, handle, virtual event |