XNextEvent(3)

1XNextEvent(3)                   XLIB FUNCTIONS                   XNextEvent(3)
2
3
4

NAME

6       XNextEvent,  XPeekEvent,  XWindowEvent,  XCheckWindowEvent, XMaskEvent,
7       XCheckMaskEvent,  XCheckTypedEvent,  XCheckTypedWindowEvent  -   select
8       events by type
9

SYNTAX

11       int XNextEvent(Display *display, XEvent *event_return);
12
13       int XPeekEvent(Display *display, XEvent *event_return);
14
15       int  XWindowEvent(Display  *display,  Window w, long event_mask, XEvent
16              *event_return);
17
18       Bool XCheckWindowEvent(Display *display,  Window  w,  long  event_mask,
19              XEvent *event_return);
20
21       int    XMaskEvent(Display    *display,    long    event_mask,    XEvent
22              *event_return);
23
24       Bool  XCheckMaskEvent(Display   *display,   long   event_mask,   XEvent
25              *event_return);
26
27       Bool   XCheckTypedEvent(Display   *display,   int   event_type,  XEvent
28              *event_return);
29
30       Bool XCheckTypedWindowEvent(Display *display, Window w, int event_type,
31              XEvent *event_return);
32

ARGUMENTS

34       display   Specifies the connection to the X server.
35
36       event_mask
37                 Specifies the event mask.
38
39       event_return
40                 Returns the matched event's associated structure.
41
42       event_return
43                 Returns the next event in the queue.
44
45       event_return
46                 Returns a copy of the matched event's associated structure.
47
48       event_type
49                 Specifies the event type to be compared.
50
51       w         Specifies the window whose event you are interested in.
52

DESCRIPTION

54       The  XNextEvent  function  copies  the first event from the event queue
55       into the specified XEvent structure and then removes it from the queue.
56       If  the  event queue is empty, XNextEvent flushes the output buffer and
57       blocks until an event is received.
58
59       The XPeekEvent function returns the first event from the  event  queue,
60       but  it  does  not  remove  the  event from the queue.  If the queue is
61       empty, XPeekEvent flushes the output buffer and blocks until  an  event
62       is  received.  It then copies the event into the client-supplied XEvent
63       structure without removing it from the event queue.
64
65       The XWindowEvent function searches the event queue for  an  event  that
66       matches  both  the  specified  window  and event mask.  When it finds a
67       match, XWindowEvent removes that event from the  queue  and  copies  it
68       into  the  specified  XEvent structure.  The other events stored in the
69       queue are not discarded.  If a matching event  is  not  in  the  queue,
70       XWindowEvent  flushes  the  output  buffer  and  blocks  until  one  is
71       received.
72
73       The XCheckWindowEvent function searches the event queue  and  then  the
74       events  available  on  the  server  connection for the first event that
75       matches the specified window and event mask.   If  it  finds  a  match,
76       XCheckWindowEvent  removes  that  event,  copies  it into the specified
77       XEvent structure, and returns True.  The other  events  stored  in  the
78       queue  are not discarded.  If the event you requested is not available,
79       XCheckWindowEvent returns False, and the output buffer will  have  been
80       flushed.
81
82       The XMaskEvent function searches the event queue for the events associ‐
83       ated with the specified  mask.   When  it  finds  a  match,  XMaskEvent
84       removes  that  event and copies it into the specified XEvent structure.
85       The other events stored in the queue are not discarded.  If  the  event
86       you requested is not in the queue, XMaskEvent flushes the output buffer
87       and blocks until one is received.
88
89       The XCheckMaskEvent function searches the  event  queue  and  then  any
90       events  available  on  the  server  connection for the first event that
91       matches the specified mask.   If  it  finds  a  match,  XCheckMaskEvent
92       removes  that event, copies it into the specified XEvent structure, and
93       returns True.  The other events stored in the queue are not  discarded.
94       If  the  event  you requested is not available, XCheckMaskEvent returns
95       False, and the output buffer will have been flushed.
96
97       The XCheckTypedEvent function searches the event  queue  and  then  any
98       events  available  on  the  server  connection for the first event that
99       matches the specified type.  If  it  finds  a  match,  XCheckTypedEvent
100       removes  that event, copies it into the specified XEvent structure, and
101       returns True.  The other events in the queue are not discarded.  If the
102       event  is not available, XCheckTypedEvent returns False, and the output
103       buffer will have been flushed.
104
105       The XCheckTypedWindowEvent function searches the event queue  and  then
106       any  events available on the server connection for the first event that
107       matches the specified type and window.  If it finds  a  match,  XCheck‐
108       TypedWindowEvent  removes  the event from the queue, copies it into the
109       specified XEvent structure, and returns True.  The other events in  the
110       queue  are  not discarded.  If the event is not available, XCheckTyped‐
111       WindowEvent returns  False,  and  the  output  buffer  will  have  been
112       flushed.
113

NAME

SYNTAX

ARGUMENTS

DESCRIPTION

SEE ALSO