summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorhobbs <hobbs>2002-06-15 00:21:41 (GMT)
committerhobbs <hobbs>2002-06-15 00:21:41 (GMT)
commit5c1e5bf298b329ec7a45cd601f6b4b208b24411b (patch)
tree25e00fe02d0a56b2865927347847b8561353fd94 /doc
parent36d7ac0a1dfb49f2c05b66ff69dfc5cfabf3ebb6 (diff)
downloadtk-5c1e5bf298b329ec7a45cd601f6b4b208b24411b.zip
tk-5c1e5bf298b329ec7a45cd601f6b4b208b24411b.tar.gz
tk-5c1e5bf298b329ec7a45cd601f6b4b208b24411b.tar.bz2
* generic/tk.decls: added TIP #84 implementation that adds a
* generic/tkDecls.h: Tk_CollapseMotionEvents API which controls * generic/tkEvent.c: Tk's collapsing of incoming motion events * generic/tkInt.h: on its windows. The default remains to do * generic/tkStubInit.c: collapsing. Added a flags parameter to the * generic/tkWindow.c: internal display structure to support this * doc/QWinEvent.3: and be used in the future for other bits.
Diffstat (limited to 'doc')
-rw-r--r--doc/QWinEvent.327
1 files changed, 19 insertions, 8 deletions
diff --git a/doc/QWinEvent.3 b/doc/QWinEvent.3
index cd80f71..15492dc 100644
--- a/doc/QWinEvent.3
+++ b/doc/QWinEvent.3
@@ -4,20 +4,27 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: QWinEvent.3,v 1.2 1998/09/14 18:22:53 stanton Exp $
+'\" RCS: @(#) $Id: QWinEvent.3,v 1.3 2002/06/15 00:21:42 hobbs Exp $
'\"
.so man.macros
.TH Tk_QueueWindowEvent 3 7.5 Tk "Tk Library Procedures"
.BS
.SH NAME
-Tk_QueueWindowEvent \- Add a window event to the Tcl event queue
+Tk_CollapseMotionEvents, Tk_QueueWindowEvent \- Add a window event to the Tcl event queue
.SH SYNOPSIS
.nf
\fB#include <tk.h>\fR
.sp
+int
+\fBTk_CollapseMotionEvents\fR(\fIdisplay, collapse\fR)
+.sp
\fBTk_QueueWindowEvent\fR(\fIeventPtr, position\fR)
.SH ARGUMENTS
.AS Tcl_QueuePosition position
+.AP Display *display in
+Display for which to control motion event collapsing.
+.AP int collapse in
+Indicates whether motion events should be collapsed or not.
.AP XEvent *eventPtr in
An event to add to the event queue.
.AP Tcl_QueuePosition position in
@@ -27,16 +34,20 @@ Where to add the new event in the queue: \fBTCL_QUEUE_TAIL\fR,
.SH DESCRIPTION
.PP
-This procedure places a window event on Tcl's
-internal event queue for eventual servicing. It creates a
-Tcl_Event structure, copies the event into that structure,
-and calls \fBTcl_QueueEvent\fR to add the event to the queue.
-When the event is eventually removed from the queue it is
+\fBTk_QueueWindowEvent\fR places a window event on Tcl's internal event
+queue for eventual servicing. It creates a Tcl_Event structure, copies the
+event into that structure, and calls \fBTcl_QueueEvent\fR to add the event
+to the queue. When the event is eventually removed from the queue it is
processed just like all window events.
.PP
+When multiple motion events are received for the same window in rapid
+succession, they are collapsed by default. This behavior can be controlled
+with \fBTk_CollapseMotionEvents\fR. \fBTk_CollapseMotionEvents\fR always
+returns the previous value for collapse behavior on the \fIdisplay\fR.
+.PP
The \fIposition\fR argument to \fBTk_QueueWindowEvent\fR has
the same significance as for \fBTcl_QueueEvent\fR; see the
documentation for \fBTcl_QueueEvent\fR for details.
.SH KEYWORDS
-callback, clock, handler, modal timeout
+callback, clock, handler, modal timeout, events