NAME

XNextEvent, XPeekEvent, XWindowEvent, XCheckWindowEvent, XMaskEvent, XCheckMaskEvent, XCheckTypedEvent, XCheckTypedWindowEvent - select events by type

SYNTAX

int XNextEvent(Display *_d_i_s_p_l_a_y, XEvent *_e_v_e_n_t___r_e_t_u_r_n); int XPeekEvent(Display *_d_i_s_p_l_a_y, XEvent *_e_v_e_n_t___r_e_t_u_r_n); int XWindowEvent(Display *_d_i_s_p_l_a_y, Window _w, long _e_v_e_n_t___m_a_s_k, XEvent *_e_v_e_n_t___r_e_t_u_r_n); Bool XCheckWindowEvent(Display *_d_i_s_p_l_a_y, Window _w, long _e_v_e_n_t___m_a_s_k, XEvent *_e_v_e_n_t___r_e_t_u_r_n); int XMaskEvent(Display *_d_i_s_p_l_a_y, long _e_v_e_n_t___m_a_s_k, XEvent *_e_v_e_n_t___r_e_t_u_r_n); Bool XCheckMaskEvent(Display *_d_i_s_p_l_a_y, long _e_v_e_n_t___m_a_s_k, XEvent *_e_v_e_n_t___r_e_t_u_r_n); Bool XCheckTypedEvent(Display *_d_i_s_p_l_a_y, int _e_v_e_n_t___t_y_p_e, XEvent *_e_v_e_n_t___r_e_t_u_r_n); Bool XCheckTypedWindowEvent(Display *_d_i_s_p_l_a_y, Window _w, int _e_v_e_n_t___t_y_p_e, XEvent *_e_v_e_n_t___r_e_t_u_r_n);

ARGUMENTS

_d_i_s_p_l_a_y Specifies the connection to the X server.
_e_v_e_n_t___m_a_s_k Specifies the event mask.
_e_v_e_n_t___r_e_t_u_r_n Returns the matched event's associated structure.
_e_v_e_n_t___r_e_t_u_r_n Returns the next event in the queue.
_e_v_e_n_t___r_e_t_u_r_n Returns a copy of the matched event's associated structure.
_e_v_e_n_t___t_y_p_e Specifies the event type to be compared.

_w Specifies the window whose event uou are interested in.

DESCRIPTION

The _X_N_e_x_t_E_v_e_n_t function copies the first event from the event queue into the specified _X_E_v_e_n_t structure and then removes it from the queue. If the event queue is empty, _X_N_e_x_t_E_v_e_n_t flushes the output buffer and blocks until an event is received.

The _X_P_e_e_k_E_v_e_n_t function returns the first event from the event queue, but it does not remove the event from the queue. If the queue is empty, _X_P_e_e_k_E_v_e_n_t flushes the output buffer and blocks until an event is received. It then copies the event into the client-supplied _X_E_v_e_n_t structure without removing it from the event queue.

The _X_W_i_n_d_o_w_E_v_e_n_t function searches the event queue for an event that matches both the specified window and event mask. When it finds a match, _X_W_i_n_d_o_w_E_v_e_n_t removes that event from the queue and copies it into the specified _X_E_v_e_n_t structure. The other events stored in the queue are not discarded. If a matching event is not in the queue, _X_W_i_n_d_o_w_E_v_e_n_t flushes the output buffer and blocks until one is received.

The _X_C_h_e_c_k_W_i_n_d_o_w_E_v_e_n_t function searches the event queue and then the events available on the server connection for the first event that matches the specified window and event mask. If it finds a match, _X_C_h_e_c_k_W_i_n_d_o_w_E_v_e_n_t removes that event, copies it into the specified _X_E_v_e_n_t structure, and returns _T_r_u_e. The other events stored in the queue are not discarded. If the event you requested is not available, _X_C_h_e_c_k_W_i_n_d_o_w_E_v_e_n_t returns _F_a_l_s_e, and the output buffer will have been flushed.

The _X_M_a_s_k_E_v_e_n_t function searches the event queue for the events associated with the specified mask. When it finds a match, _X_M_a_s_k_E_v_e_n_t removes that event and copies it into the specified _X_E_v_e_n_t structure. The other events stored in the queue are not discarded. If the event you requested is not in the queue, _X_M_a_s_k_E_v_e_n_t flushes the output buffer and blocks until one is received.

The _X_C_h_e_c_k_M_a_s_k_E_v_e_n_t function searches the event queue and then any events available on the server connection for the first event that matches the specified mask. If it finds a match, _X_C_h_e_c_k_M_a_s_k_E_v_e_n_t removes that event, copies it into the specified _X_E_v_e_n_t structure, and returns _T_r_u_e. The other events stored in the queue are not discarded. If the event you requested is not available, _X_C_h_e_c_k_M_a_s_k_E_v_e_n_t returns _F_a_l_s_e, and the output buffer will have been flushed.

The _X_C_h_e_c_k_T_y_p_e_d_E_v_e_n_t function searches the event queue and then any events available on the server connection for the first event that matches the specified type. If it finds a match, _X_C_h_e_c_k_T_y_p_e_d_E_v_e_n_t removes that event, copies it into the specified _X_E_v_e_n_t structure, and returns _T_r_u_e. The other events in the queue are not discarded. If the event is not available, _X_C_h_e_c_k_T_y_p_e_d_E_v_e_n_t returns _F_a_l_s_e, and the output buffer will have been flushed.

The _X_C_h_e_c_k_T_y_p_e_d_W_i_n_d_o_w_E_v_e_n_t function searches the event queue and then any events available on the server connection for the first event that matches the specified type and window. If it finds a match, _X_C_h_e_c_k_T_y_p_e_d_W_i_n_d_o_w_E_v_e_n_t removes the event from the queue, copies it into the specified _X_E_v_e_n_t structure, and returns _T_r_u_e. The other events in the queue are not discarded. If the event is not available, _X_C_h_e_c_k_T_y_p_e_d_W_i_n_d_o_w_E_v_e_n_t returns _F_a_l_s_e, and the output buffer will have been flushed.

SEE ALSO

XAnyEvent(3X11), XIfEvent(3X11), XPutBackEvent(3X11), XSendEvent(3X11)
_X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e