.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium .\" .\" Permission is hereby granted, free of charge, to any person obtaining .\" a copy of this software and associated documentation files (the .\" "Software"), to deal in the Software without restriction, including .\" without limitation the rights to use, copy, modify, merge, publish, .\" distribute, sublicense, and/or sell copies of the Software, and to .\" permit persons to whom the Software is furnished to do so, subject to .\" the following conditions: .\" .\" The above copyright notice and this permission notice shall be included .\" in all copies or substantial portions of the Software. .\" .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. .\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR .\" OTHER DEALINGS IN THE SOFTWARE. .\" .\" Except as contained in this notice, the name of the X Consortium shall .\" not be used in advertising or otherwise to promote the sale, use or .\" other dealings in this Software without prior written authorization .\" from the X Consortium. .\" .\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by .\" Digital Equipment Corporation .\" .\" Portions Copyright \(co 1990, 1991 by .\" Tektronix, Inc. .\" .\" Permission to use, copy, modify and distribute this documentation for .\" any purpose and without fee is hereby granted, provided that the above .\" copyright notice appears in all copies and that both that copyright notice .\" and this permission notice appear in all copies, and that the names of .\" Digital and Tektronix not be used in in advertising or publicity pertaining .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. .\" It is provided "as is" without express or implied warranty. .\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual .TH XFilterEvent 3 "libX11 1.8.10" "X Version 11" "XLIB FUNCTIONS" .SH NAME XFilterEvent \- filter X events for an input method .SH SYNTAX .HP Bool XFilterEvent\^(\^XEvent *\fIevent\fP\^, Window \fIw\fP\^); .SH ARGUMENTS .IP \fIevent\fP 1i Specifies the event to filter. .IP \fIw\fP 1i Specifies the window for which the filter is to be applied. .SH DESCRIPTION If the window argument is .BR None , .B XFilterEvent applies the filter to the window specified in the .B XEvent structure. The window argument is provided so that layers above Xlib that do event redirection can indicate to which window an event has been redirected. .LP If .B XFilterEvent returns .BR True , then some input method has filtered the event, and the client should discard the event. If .B XFilterEvent returns .BR False , then the client should continue processing the event. .LP If a grab has occurred in the client and .B XFilterEvent returns .BR True , the client should ungrab the keyboard. .SH "SEE ALSO" XNextEvent(3) .br \fI\*(xL\fP