summaryrefslogtreecommitdiffstats
path: root/doc/HandleEvent.3
diff options
context:
space:
mode:
authordkf <donal.k.fellows@manchester.ac.uk>2008-06-30 22:57:00 (GMT)
committerdkf <donal.k.fellows@manchester.ac.uk>2008-06-30 22:57:00 (GMT)
commitd6e7f6b3743e98803d7e8c7debc709c072c6e6a5 (patch)
treed6714c53bb2368a4c8befd4c7dc0085d88b31a15 /doc/HandleEvent.3
parent8ab3b0fffbe37701d924b4da873e6f231a843e5f (diff)
downloadtk-d6e7f6b3743e98803d7e8c7debc709c072c6e6a5.zip
tk-d6e7f6b3743e98803d7e8c7debc709c072c6e6a5.tar.gz
tk-d6e7f6b3743e98803d7e8c7debc709c072c6e6a5.tar.bz2
Minor doc updates (removing out of date changebars, improving typedef formatting,
etc.)
Diffstat (limited to 'doc/HandleEvent.3')
-rw-r--r--doc/HandleEvent.396
1 files changed, 47 insertions, 49 deletions
diff --git a/doc/HandleEvent.3 b/doc/HandleEvent.3
index ea461d5..69ed289 100644
--- a/doc/HandleEvent.3
+++ b/doc/HandleEvent.3
@@ -1,49 +1,47 @@
-'\"
-'\" Copyright (c) 1990-1992 The Regents of the University of California.
-'\" Copyright (c) 1994-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.
-'\"
-'\" RCS: @(#) $Id: HandleEvent.3,v 1.4 1999/04/21 21:53:22 rjohnson Exp $
-'\"
-.so man.macros
-.TH Tk_HandleEvent 3 "" Tk "Tk Library Procedures"
-.BS
-.SH NAME
-Tk_HandleEvent \- invoke event handlers for window system events
-.SH SYNOPSIS
-.nf
-\fB#include <tk.h>\fR
-.sp
-\fBTk_HandleEvent\fR(\fIeventPtr\fR)
-.SH ARGUMENTS
-.AS XEvent *eventPtr
-.AP XEvent *eventPtr in
-Pointer to X event to dispatch to relevant handler(s).
-.BE
-
-.SH DESCRIPTION
-.PP
-\fBTk_HandleEvent\fR is a lower-level procedure that deals with window
-events. It is called by \fBTcl_ServiceEvent\fR (and indirectly by
-\fBTk_DoOneEvent\fR), and in a few other cases within Tk.
-It makes callbacks to any window event
-handlers (created by calls to \fBTk_CreateEventHandler\fR)
-that match \fIeventPtr\fR and then returns. In some cases
-it may be useful for an application to bypass the Tk event
-queue and call \fBTk_HandleEvent\fR directly instead of
-calling \fBTcl_QueueEvent\fR followed by
-\fBTcl_ServiceEvent\fR.
-.PP
-This procedure may be invoked recursively. For example,
-it is possible to invoke \fBTk_HandleEvent\fR recursively
-from a handler called by \fBTk_HandleEvent\fR. This sort
-of operation is useful in some modal situations, such
-as when a
-notifier has been popped up and an application wishes to
-wait for the user to click a button in the notifier before
-doing anything else.
-
-.SH KEYWORDS
-callback, event, handler, window
+'\"
+'\" Copyright (c) 1990-1992 The Regents of the University of California.
+'\" Copyright (c) 1994-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.
+'\"
+'\" RCS: @(#) $Id: HandleEvent.3,v 1.5 2008/06/30 22:57:01 dkf Exp $
+'\"
+.so man.macros
+.TH Tk_HandleEvent 3 "" Tk "Tk Library Procedures"
+.BS
+.SH NAME
+Tk_HandleEvent \- invoke event handlers for window system events
+.SH SYNOPSIS
+.nf
+\fB#include <tk.h>\fR
+.sp
+\fBTk_HandleEvent\fR(\fIeventPtr\fR)
+.SH ARGUMENTS
+.AS XEvent *eventPtr
+.AP XEvent *eventPtr in
+Pointer to X event to dispatch to relevant handler(s).
+.BE
+.SH DESCRIPTION
+.PP
+\fBTk_HandleEvent\fR is a lower-level procedure that deals with window
+events. It is called by \fBTcl_ServiceEvent\fR (and indirectly by
+\fBTk_DoOneEvent\fR), and in a few other cases within Tk.
+It makes callbacks to any window event
+handlers (created by calls to \fBTk_CreateEventHandler\fR)
+that match \fIeventPtr\fR and then returns. In some cases
+it may be useful for an application to bypass the Tk event
+queue and call \fBTk_HandleEvent\fR directly instead of
+calling \fBTcl_QueueEvent\fR followed by
+\fBTcl_ServiceEvent\fR.
+.PP
+This procedure may be invoked recursively. For example,
+it is possible to invoke \fBTk_HandleEvent\fR recursively
+from a handler called by \fBTk_HandleEvent\fR. This sort
+of operation is useful in some modal situations, such
+as when a
+notifier has been popped up and an application wishes to
+wait for the user to click a button in the notifier before
+doing anything else.
+.SH KEYWORDS
+callback, event, handler, window