summaryrefslogtreecommitdiffstats
path: root/doc/event.n
diff options
context:
space:
mode:
authorhobbs <hobbs>1999-12-14 06:51:43 (GMT)
committerhobbs <hobbs>1999-12-14 06:51:43 (GMT)
commit9b37fa05b11850066aed28ed447109e55708bce0 (patch)
treec4d876b773ea4b9b6675a0e9a9c380a6bfac9542 /doc/event.n
parentea12a22c853959d87130dbc26197c27f47d00e41 (diff)
downloadtk-9b37fa05b11850066aed28ed447109e55708bce0.zip
tk-9b37fa05b11850066aed28ed447109e55708bce0.tar.gz
tk-9b37fa05b11850066aed28ed447109e55708bce0.tar.bz2
* doc/canvas.n: added docs for items added by dash patch (-*dash*,
-state, -active*, -disabled*, -offset, essentially rewrote the man patch for completely updated 8.3 canvas widget. * doc/entry.n: added docs for entry widget validation * doc/event.n: added docs for -warp * doc/text.n: doc'ed new -state value 'hidden' * doc/GetDash.3: (new file) man page explaining Tk_GetDash
Diffstat (limited to 'doc/event.n')
-rw-r--r--doc/event.n22
1 files changed, 17 insertions, 5 deletions
diff --git a/doc/event.n b/doc/event.n
index b6e4854..90493cd 100644
--- a/doc/event.n
+++ b/doc/event.n
@@ -5,10 +5,10 @@
'\" 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.3 1998/10/10 00:30:35 rjohnson Exp $
+'\" RCS: @(#) $Id: event.n,v 1.4 1999/12/14 06:51:44 hobbs Exp $
'\"
.so man.macros
-.TH event n 8.0 Tk "Tk Built-In Commands"
+.TH event n 8.3 Tk "Tk Built-In Commands"
.BS
'\" Note: do not modify the .SH NAME line immediately below!
.SH NAME
@@ -51,12 +51,14 @@ trigger anymore.
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
+.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.
@@ -107,7 +109,6 @@ for the event. Valid for \fBExpose\fR events.
Corresponds to the \fB%c\fR substitution for binding scripts.
.TP
\fB\-delta\fI number\fR
-.VS
\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
@@ -117,7 +118,6 @@ 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.
-.VE
.TP
\fB\-detail\fI detail\fR
\fIDetail\fR specifies the \fIdetail\fR field for the event
@@ -239,6 +239,12 @@ Valid for \fBKeyPress\fR, \fBKeyRelease\fR, \fBButtonPress\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.
+.TP
\fB\-width\fI size\fR
\fISize\fR must be a screen distance; it specifies the \fIwidth\fR field
for the event.
@@ -273,6 +279,9 @@ Valid for \fBKeyPress\fR, \fBKeyRelease\fR, \fBButtonPress\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
@@ -282,6 +291,9 @@ Valid for \fBKeyPress\fR, \fBKeyRelease\fR, \fBButtonPress\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