NAME
XWarpPointer - move pointer
SYNTAX
int XWarpPointer(Display *_d_i_s_p_l_a_y, Window _s_r_c___w, Window
_d_e_s_t___w, int _s_r_c___x, int _s_r_c___y, unsigned int
_s_r_c___w_i_d_t_h, unsigned int _s_r_c___h_e_i_g_h_t, int _d_e_s_t___x, int
_d_e_s_t___y);
ARGUMENTS
-
_d_e_s_t___w
Specifies the destination window or
-
_N_o_n_e.
-
_d_e_s_t___x
-
-
_d_e_s_t___y
Specify the x and y coordinates within the destination window.
-
-
_d_i_s_p_l_a_y
Specifies the connection to the X server.
-
-
_s_r_c___x
-
-
_s_r_c___y
-
-
_s_r_c___w_i_d_t_h
-
-
_s_r_c___h_e_i_g_h_t
Specify a rectangle in the source window.
-
-
_s_r_c___w
Specifies the source window or
-
_N_o_n_e.
DESCRIPTION
If dest_w is
_N_o_n_e,
_X_W_a_r_p_P_o_i_n_t_e_r
moves the pointer by the offsets (dest_x, dest_y) relative to the current
position of the pointer.
If dest_w is a window,
_X_W_a_r_p_P_o_i_n_t_e_r
moves the pointer to the offsets (dest_x, dest_y) relative to the origin of
dest_w.
However, if src_w is a window,
the move only takes place if the window src_w contains the pointer
and if the specified rectangle of src_w contains the pointer.
The src_x and src_y coordinates are relative to the origin of src_w.
If src_height is zero,
it is replaced with the current height of src_w minus src_y.
If src_width is zero,
it is replaced with the current width of src_w minus src_x.
There is seldom any reason for calling this function.
The pointer should normally be left to the user.
If you do use this function, however, it generates events just as if the user
had instantaneously moved the pointer from one position to another.
Note that you cannot use
_X_W_a_r_p_P_o_i_n_t_e_r
to move the pointer outside the confine_to window of an active pointer grab.
An attempt to do so will only move the pointer as far as the closest edge of the
confine_to window.
_X_W_a_r_p_P_o_i_n_t_e_r
can generate a
_B_a_d_W_i_n_d_o_w
error.
DIAGNOSTICS
-
_B_a_d_W_i_n_d_o_w
-
A value for a Window argument does not name a defined Window.
SEE ALSO
XSetInputFocus(3X11)
_X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e