head	1.9;
access;
symbols
	core-8-5-9:1.7
	core-8-5-8:1.7
	macosx-cocoa-merge:1.8
	macosx-cocoa-premerge:1.8
	macosx-carbon-freeze:1.8
	core-8-5-7:1.7
	core-8-5-6:1.7
	core-8-6-b1:1.8
	core-8-6-a3:1.8
	core-8-5-5:1.7
	core-8-6-a2:1.8
	core-8-5-4:1.7
	core-8-5-3:1.7
	core-8-6-a1:1.7
	core-8-4-19:1.2
	core-8-5-branch:1.7.0.2
	core-8-5-2:1.7
	core-8-4-18:1.2
	core-8-5-1:1.7
	core-8-4-17:1.2
	core-8-5-0:1.7
	core-8-5-b3:1.6
	core-8-5-b2:1.5
	core-8-4-16:1.2
	core-8-5-b1:1.3
	core-stablilizer-merge:1.3
	core-stabilizer-branch:1.3.0.2
	core-stabilizer-merge:1.7
	core-8-4-15:1.2
	core-8-5-a6:1.3
	core-8-5-a5:1.3
	core-8-4-14:1.2
	core-8-5-a4:1.3
	core-8-4-13:1.2
	core-8-4-12:1.2
	core-8-4-11:1.2
	core-8-5-a3:1.3
	core-8-4-10:1.2
	core-8-4-9-branch:1.2.0.30
	core-8-5-a2:1.3
	core-8-4-9:1.2
	core-8-4-8:1.2
	core-8-4-7:1.2
	core-8-5-a1:1.2
	core-8-4-6:1.2
	core-8-4-5:1.2
	mistachkin-dev-branch:1.2.0.28
	core-8-4-4:1.2
	core-8-4-3:1.2
	core-8-4-branch:1.2.0.26
	core-8-4-2:1.2
	core-8-4-1:1.2
	core-8-3-5:1.2
	core-8-4-0:1.2
	macosx-8-4-merge-2002-08-31-trunk:1.2
	macosx-8-4-premerge-2002-08-31-branch:1.2
	macosx-8-4-premerge-2002-08-31-trunk:1.2
	macosx-8-4-merge-2002-08-30-branch:1.2
	macosx-8-4-merge-2002-08-30-trunk:1.2
	macosx-8-4-merge-2002-08-20-branch:1.2
	macosx-8-4-merge-2002-08-20-trunk:1.2
	core-8-4-b2:1.2
	core-8-4-b1:1.2
	macosx-premerge-6-9-02:1.2
	core-8-4-a4:1.2
	core-8-3-4:1.2
	macosx-8-4-branch:1.2.0.24
	macosx-8-4-branchpoint:1.2
	core-8-4-a3:1.2
	core-8-3-3:1.2
	dgp-privates-into-namespace:1.2.0.22
	tclpro-1-5-0:1.2
	core-8-4-win-speedup:1.2.0.20
	core-8-4-a2:1.2
	tclpro-1-4-1:1.2
	tclpro-1-4-0:1.2
	core-8-3-2:1.2
	ajuba-ajuba2-2-1-base:1.2
	ajuba-ajuba2-2-0:1.2
	core-8-4-a1:1.2
	core-8-3-1-branch:1.2.0.18
	core-8-3-1:1.2
	scriptics-sc-2-0-b5:1.2
	scriptics-sc-2-0-fixed:1.2
	scriptics-sc-2-0-b2:1.2
	scriptics-sc-2-0-b1:1.2
	core-8-3-0:1.2
	core-8-3-b2:1.2
	core-8-3-b1:1.2
	scriptics-sc-1-1:1.2
	scriptics-sc-1-1-b1:1.2
	core-8-2-3:1.2
	scriptics-sc-1-1-branch:1.2.0.16
	scriptics-sc-1-1-base:1.2
	scriptics-sc-1-0:1.2
	scriptics-sc-1-0-branch:1.2.0.14
	scriptics-sc-1-0-base:1.2
	core-8-2-2:1.2
	core-8-2-1:1.2
	scriptics-bc-1-0-b1:1.2
	core-8-2-1-branch:1.2.0.12
	scriptics-tclpro-1-3-0:1.2
	core-8-2-0:1.2
	core-8-2-b3-branch:1.2.0.10
	core-8-2-b3-base:1.2
	scriptics-tclpro-1-3-b4:1.2
	core-8-2-b2:1.2
	scriptics-tclpro-1-3-b3:1.2
	core-8-2-b1:1.2
	scriptics-tclpro-1-3-b2:1.2
	merge-to-mainline-5/21/99:1.2
	scriptics-tclpro-1-3-b2-branch:1.2.0.8
	core-8-1-1:1.2
	scriptics-tclpro-1-3-b1:1.2
	core-8-1-1-base:1.2
	core-8-1-0:1.2
	merge-to-mainline-4-29-99:1.2
	merge-to-mainline-4-23-99:1.2
	core-8-1-branch-old:1.1.0.4
	core-8-0-6-branch:1.2.0.6
	core-8-0-6-base:1.2
	core-8-0-5:1.2
	core-8-1-b3:1.1.4.1
	core-8-1-b2:1.1.4.1
	dev-8-1-stubs-branch:1.1.4.1.0.2
	dev-stubs-branch:1.2.0.4
	scriptics-tclpro-1-2:1.2
	scriptics-tclpro-1-2-b2:1.2
	core-8-1-merge-2/10/99:1.2
	core-8-0-5-branch:1.2.0.2
	core-8-0-5-base:1.2
	scriptics-tclpro-1-2-b1:1.2
	scriptics-tclpro-1-2-a1:1.2
	core-8-1-b1:1.1.4.1
	core-8-0-4:1.2
	core-8-1-a2:1.1
	core-8-0-2:1.1
	core-8-0-3:1.2;
locks; strict;
comment	@# @;


1.9
date	2010.05.11.12.12.50;	author nijtmans;	state Exp;
branches;
next	1.8;

1.8
date	2008.06.30.22.57.02;	author dkf;	state Exp;
branches;
next	1.7;

1.7
date	2007.12.13.15.23.43;	author dgp;	state Exp;
branches;
next	1.6;

1.6
date	2007.10.29.16.04.13;	author dkf;	state Exp;
branches;
next	1.5;

1.5
date	2007.10.26.20.13.23;	author dgp;	state Exp;
branches;
next	1.4;

1.4
date	2007.10.24.14.32.57;	author dkf;	state Exp;
branches;
next	1.3;

1.3
date	2004.09.19.16.05.36;	author dkf;	state Exp;
branches
	1.3.2.1;
next	1.2;

1.2
date	98.09.14.18.22.53;	author stanton;	state Exp;
branches;
next	1.1;

1.1
date	98.04.01.09.40.11;	author rjohnson;	state Exp;
branches
	1.1.4.1;
next	;

1.1.4.1
date	98.09.30.02.16.06;	author stanton;	state Exp;
branches;
next	;

1.3.2.1
date	2007.11.01.16.37.13;	author dgp;	state Exp;
branches;
next	;


desc
@@


1.9
log
@Consistent use of variable names in RestrictEvent
API documentation and implementation: Use 'prev'
in stead of 'old', and 'arg' in stead of
'clientData' everywhere, just as in tkEvent.c.
@
text
@'\"
'\" Copyright (c) 1990 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: RestrictEv.3,v 1.8 2008/06/30 22:57:02 dkf Exp $
'\" 
.so man.macros
.TH Tk_RestrictEvents 3 "" Tk "Tk Library Procedures"
.BS
.SH NAME
Tk_RestrictEvents \- filter and selectively delay X events
.SH SYNOPSIS
.nf
\fB#include <tk.h>\fR
.sp
Tk_RestrictProc *
\fBTk_RestrictEvents\fR(\fIproc, arg, prevArgPtr\fR)
.SH ARGUMENTS
.AS Tk_RestrictProc **prevArgPtr
.AP Tk_RestrictProc *proc in
Predicate procedure to call to filter incoming X events.
NULL means do not restrict events at all.
.AP ClientData arg in
Arbitrary argument to pass to \fIproc\fR.
.AP ClientData *prevArgPtr out
Pointer to place to save argument to previous restrict procedure.
.BE
.SH DESCRIPTION
.PP
This procedure is useful in certain situations where applications
are only prepared to receive certain X events.  After
\fBTk_RestrictEvents\fR is called, \fBTk_DoOneEvent\fR (and
hence \fBTk_MainLoop\fR) will filter X input events through
\fIproc\fR.  \fIProc\fR indicates whether a
given event is to be processed immediately, deferred until some
later time (e.g. when the event restriction is lifted), or discarded.
\fIProc\fR
is a procedure with arguments and result that match
the type \fBTk_RestrictProc\fR:
.CS
typedef Tk_RestrictAction \fBTk_RestrictProc\fR(
        ClientData \fIarg\fR,
        XEvent *\fIeventPtr\fR);
.CE
The \fIarg\fR argument is a copy of the \fIarg\fR passed
to \fBTk_RestrictEvents\fR; it may be used to provide \fIproc\fR with
information it needs to filter events.  The \fIeventPtr\fR points to
an event under consideration.  \fIProc\fR returns a restrict action
(enumerated type \fBTk_RestrictAction\fR) that indicates what
\fBTk_DoOneEvent\fR should do with the event.  If the return value is
\fBTK_PROCESS_EVENT\fR, then the event will be handled immediately.
If the return value is \fBTK_DEFER_EVENT\fR, then the event will be
left on the event queue for later processing.  If the return value is
\fBTK_DISCARD_EVENT\fR, then the event will be removed from the event
queue and discarded without being processed.
.PP
\fBTk_RestrictEvents\fR uses its return value and \fIprevArgPtr\fR
to return information about the current event restriction procedure
(a NULL return value means there are currently no restrictions).
These values may be used to restore the previous restriction state
when there is no longer any need for the current restriction.
.PP
There are very few places where \fBTk_RestrictEvents\fR is needed.
In most cases, the best way to restrict events is by changing the
bindings with the \fBbind\fR Tcl command or by calling
\fBTk_CreateEventHandler\fR and \fBTk_DeleteEventHandler\fR from C.
The main place where \fBTk_RestrictEvents\fR must be used is when
performing synchronous actions (for example, if you need to wait
for a particular event to occur on a particular window but you do not
want to invoke any handlers for any other events).  The
.QW obvious
solution in these situations is to call \fBXNextEvent\fR or
\fBXWindowEvent\fR, but these procedures cannot be used because
Tk keeps its own event queue that is separate from the X event
queue.  Instead, call \fBTk_RestrictEvents\fR to set up a filter,
then call \fBTk_DoOneEvent\fR to retrieve the desired event(s).
.SH KEYWORDS
delay, event, filter, restriction
@


1.8
log
@Minor doc updates (removing out of date changebars, improving typedef formatting,
 etc.)
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: RestrictEv.3,v 1.7 2007/12/13 15:23:43 dgp Exp $
d20 1
a20 1
\fBTk_RestrictEvents\fR(\fIproc, clientData, prevClientDataPtr\fR)
d22 1
a22 1
.AS Tk_RestrictProc **prevClientDataPtr
d26 1
a26 1
.AP ClientData clientData in
d28 1
a28 1
.AP ClientData *prevClientDataPtr out
d45 1
a45 1
        ClientData \fIclientData\fR,
d48 1
a48 1
The \fIclientData\fR argument is a copy of the \fIclientData\fR passed
d60 1
a60 1
\fBTk_RestrictEvents\fR uses its return value and \fIprevClientDataPtr\fR
@


1.7
log
@merge stable branch onto HEAD
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: RestrictEv.3,v 1.3.2.1 2007/11/01 16:37:13 dgp Exp $
a30 1

d44 3
a46 3
typedef Tk_RestrictAction Tk_RestrictProc(
    ClientData \fIclientData\fR,
    XEvent *\fIeventPtr\fR);
@


1.6
log
@Lots more GOOBE stuff. Now works with 'make html'!
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: RestrictEv.3,v 1.5 2007/10/26 20:13:23 dgp Exp $
@


1.5
log
@        * doc/*.1:              Revert doc changes that broke
        * doc/*.3:              `make html` so we can get the release
        * doc/*.n:              out the door.
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: RestrictEv.3,v 1.3 2004/09/19 16:05:36 dkf Exp $
d73 3
a75 2
for a particular event to occur on a particular window but you don't
want to invoke any handlers for any other events).  The ``obvious''
@


1.4
log
@Lots of improvements to look and feel of manual pages
@
text
@d74 1
a74 2
want to invoke any handlers for any other events).  The
.QW obvious
@


1.3
log
@Standardize style of section refs & public symbols. Remove displayed tabs
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: RestrictEv.3,v 1.2 1998/09/14 18:22:53 stanton Exp $
d74 2
a75 1
want to invoke any handlers for any other events).  The ``obvious''
@


1.3.2.1
log
@merge updates from HEAD
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: RestrictEv.3,v 1.3 2004/09/19 16:05:36 dkf Exp $
d73 2
a74 3
for a particular event to occur on a particular window but you do not
want to invoke any handlers for any other events).  The
.QW obvious
@


1.2
log
@Replaced SCCS strings, fixed binary files
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id$
d46 2
a47 2
	ClientData \fIclientData\fR,
	XEvent *\fIeventPtr\fR);
@


1.1
log
@Initial revision
@
text
@d8 1
a8 1
'\" SCCS: @@(#) RestrictEv.3 1.13 96/08/27 13:21:55
@


1.1.4.1
log
@Merged 8.0.3 changes into 8.1
@
text
@d8 1
a8 1
'\" RCS: @@(#) $Id: RestrictEv.3,v 1.2 1998/09/14 18:22:53 stanton Exp $
@


