tk/doc/QWinEvent.3

   1 '\"
   2 '\" Copyright (c) 1995-1996 Sun Microsystems, Inc.
   3 '\"
   4 '\" See the file "license.terms" for information on usage and redistribution
   5 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   6 '\"
   7 '\" RCS: @(#) $Id$
   8 '\"
   9 .so man.macros
  10 .TH Tk_QueueWindowEvent 3 7.5 Tk "Tk Library Procedures"
  11 .BS
  12 .SH NAME
  13 Tk_QueueWindowEvent \- Add a window event to the Tcl event queue
  14 .SH SYNOPSIS
  15 .nf
  16 \fB#include <tk.h>\fR
  17 .sp
  18 \fBTk_QueueWindowEvent\fR(\fIeventPtr, position\fR)
  19 .SH ARGUMENTS
  20 .AS Tcl_QueuePosition position
  21 .AP XEvent *eventPtr  in
  22 An event to add to the event queue.
  23 .AP Tcl_QueuePosition position in
  24 Where to add the new event in the queue:  \fBTCL_QUEUE_TAIL\fR,
  25 \fBTCL_QUEUE_HEAD\fR, or \fBTCL_QUEUE_MARK\fR.
  26 .BE
  27
  28 .SH DESCRIPTION
  29 .PP
  30 This procedure places a window event on Tcl's
  31 internal event queue for eventual servicing.  It creates a
  32 Tcl_Event structure, copies the event into that structure,
  33 and calls \fBTcl_QueueEvent\fR to add the event to the queue.
  34 When the event is eventually removed from the queue it is
  35 processed just like all window events.
  36 .PP
  37 The \fIposition\fR argument to \fBTk_QueueWindowEvent\fR has
  38 the same significance as for \fBTcl_QueueEvent\fR;  see the
  39 documentation for \fBTcl_QueueEvent\fR for details.
  40
  41 .SH KEYWORDS
  42 callback, clock, handler, modal timeout
  43