NAME
XSendEvent, XDisplayMotionBufferSize, XGetMotionEvents, XTimeCoord - send events and pointer motion history structure
SYNTAX
Status XSendEvent(Display *_d_i_s_p_l_a_y, Window _w, Bool
_p_r_o_p_a_g_a_t_e, long _e_v_e_n_t___m_a_s_k, XEvent *_e_v_e_n_t___s_e_n_d);
unsigned long XDisplayMotionBufferSize(Display *_d_i_s_p_l_a_y);
XTimeCoord *XGetMotionEvents(Display *_d_i_s_p_l_a_y, Window _w,
Time _s_t_a_r_t, Time _s_t_o_p, int *_n_e_v_e_n_t_s___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___s_e_n_d
Specifies the event that is to be sent.
-
-
_n_e_v_e_n_t_s___r_e_t_u_r_n
Returns the number of events from the motion history buffer.
-
-
_p_r_o_p_a_g_a_t_e
Specifies a Boolean value.
-
-
_s_t_a_r_t
-
-
_s_t_o_p
Specify the time interval in which the events are returned from the motion
-
history buffer.
You can pass a timestamp or
_C_u_r_r_e_n_t_T_i_m_e.
_P_o_i_n_t_e_r_W_i_n_d_o_w,
or
_I_n_p_u_t_F_o_c_u_s.
-
_w
Specifies the window the window the event is to be sent to,.
-
DESCRIPTION
The
_X_S_e_n_d_E_v_e_n_t
function identifies the destination window,
determines which clients should receive the specified events,
and ignores any active grabs.
This function requires you to pass an event mask.
For a discussion of the valid event mask names,
see section 10.3.
This function uses the w argument to identify the destination window as follows:
-
·
If w is
-
_P_o_i_n_t_e_r_W_i_n_d_o_w,
the destination window is the window that contains the pointer.
-
·
If w is
-
_I_n_p_u_t_F_o_c_u_s
and if the focus window contains the pointer,
the destination window is the window that contains the pointer;
otherwise, the destination window is the focus window.
To determine which clients should receive the specified events,
_X_S_e_n_d_E_v_e_n_t
uses the propagate argument as follows:
-
·
If event_mask is the empty set,
-
the event is sent to the client that created the destination window.
If that client no longer exists,
no event is sent.
-
·
If propagate is
-
_F_a_l_s_e,
the event is sent to every client selecting on destination any of the event
types in the event_mask argument.
-
·
If propagate is
-
_T_r_u_e
and no clients have selected on destination any of
the event types in event-mask, the destination is replaced with the
closest ancestor of destination for which some client has selected a
type in event-mask and for which no intervening window has that type in its
do-not-propagate-mask.
If no such window exists or if the window is
an ancestor of the focus window and
_I_n_p_u_t_F_o_c_u_s
was originally specified
as the destination, the event is not sent to any clients.
Otherwise, the event is reported to every client selecting on the final
destination any of the types specified in event_mask.
The event in the
_X_E_v_e_n_t
structure must be one of the core events or one of the events
defined by an extension (or a
_B_a_d_V_a_l_u_e
error results) so that the X server can correctly byte-swap
the contents as necessary.
The contents of the event are
otherwise unaltered and unchecked by the X server except to force send_event to
_T_r_u_e
in the forwarded event and to set the serial number in the event correctly;
therefore these fields
and the display field are ignored by
_X_S_e_n_d_E_v_e_n_t.
_X_S_e_n_d_E_v_e_n_t
returns zero if the conversion to wire protocol format failed
and returns nonzero otherwise.
_X_S_e_n_d_E_v_e_n_t
can generate
_B_a_d_V_a_l_u_e
and
_B_a_d_W_i_n_d_o_w
errors.
The server may retain the recent history of the pointer motion
and do so to a finer granularity than is reported by
_M_o_t_i_o_n_N_o_t_i_f_y
events.
The
_X_G_e_t_M_o_t_i_o_n_E_v_e_n_t_s
function makes this history available.
The
_X_G_e_t_M_o_t_i_o_n_E_v_e_n_t_s
function returns all events in the motion history buffer that fall between the
specified start and stop times, inclusive, and that have coordinates
that lie within the specified window (including its borders) at its present
placement.
If the server does not support motion history,
if the start time is later than the stop time,
or if the start time is in the future,
no events are returned;
_X_G_e_t_M_o_t_i_o_n_E_v_e_n_t_s
returns NULL.
If the stop time is in the future, it is equivalent to specifying
_C_u_r_r_e_n_t_T_i_m_e.
_X_G_e_t_M_o_t_i_o_n_E_v_e_n_t_s
can generate a
_B_a_d_W_i_n_d_o_w
error.
STRUCTURES
The
_X_T_i_m_e_C_o_o_r_d
structure contains:
typedef struct {
Time time;
short x, y;
} XTimeCoord;
The time member is set to the time, in milliseconds.
The x and y members are set to the coordinates of the pointer and
are reported relative to the origin
of the specified window.
DIAGNOSTICS
-
_B_a_d_V_a_l_u_e
-
Some numeric value falls outside the range of values accepted by the request.
Unless a specific range is specified for an argument, the full range defined
by the argument's type is accepted. Any argument defined as a set of
alternatives can generate this error.
-
_B_a_d_W_i_n_d_o_w
-
A value for a Window argument does not name a defined Window.
SEE ALSO
XAnyEvent(3X11),
XIfEvent(3X11),
XNextEvent(3X11),
XPutBackEvent(3X11)
_X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e