summaryrefslogtreecommitdiffstats
path: root/doc/QWinEvent.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/QWinEvent.3')
-rw-r--r--doc/QWinEvent.342
1 files changed, 42 insertions, 0 deletions
diff --git a/doc/QWinEvent.3 b/doc/QWinEvent.3
new file mode 100644
index 0000000..5bbb4f4
--- /dev/null
+++ b/doc/QWinEvent.3
@@ -0,0 +1,42 @@
+'\"
+'\" Copyright (c) 1995-1996 Sun Microsystems, Inc.
+'\"
+'\" See the file "license.terms" for information on usage and redistribution
+'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
+'\"
+'\" SCCS: @(#) QWinEvent.3 1.4 96/03/26 18:17:16
+'\"
+.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
+.SH SYNOPSIS
+.nf
+\fB#include <tk.h>\fR
+.sp
+\fBTk_QueueWindowEvent\fR(\fIeventPtr, position\fR)
+.SH ARGUMENTS
+.AS Tcl_QueuePosition position
+.AP XEvent *eventPtr in
+An event to add to the event queue.
+.AP Tcl_QueuePosition position in
+Where to add the new event in the queue: \fBTCL_QUEUE_TAIL\fR,
+\fBTCL_QUEUE_HEAD\fR, or \fBTCL_QUEUE_MARK\fR.
+.BE
+
+.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
+processed just like all window events.
+.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