XFilterEvent (3)

Leading comments

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 foll...

(The comments found at the beginning of the groff file "man3/XFilterEvent.3".)

NAME

XFilterEvent - filter X events for an input method

SYNTAX

Bool XFilterEvent(XEvent *event, Window w);

ARGUMENTS

event

Specifies the event to filter.

w

Specifies the window for which the filter is to be applied.

DESCRIPTION

If the window argument is None, XFilterEvent applies the filter to the window specified in the 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.

If XFilterEvent returns True, then some input method has filtered the event, and the client should discard the event. If XFilterEvent returns False, then the client should continue processing the event.

If a grab has occurred in the client and XFilterEvent returns True, the client should ungrab the keyboard.

SEE ALSO

XNextEvent(3)
Xlib - C Language X Interface