Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
xcb_warp_pointer(3)		 XCB Requests		   xcb_warp_pointer(3)

NAME
       xcb_warp_pointer	- move mouse pointer

SYNOPSIS
       #include	<xcb/xproto.h>

   Request function
       xcb_void_cookie_t xcb_warp_pointer(xcb_connection_t *conn,
	      xcb_window_t src_window, xcb_window_t dst_window,	int16_t	src_x,
	      int16_t src_y, uint16_t src_width, uint16_t src_height,
	      int16_t dst_x, int16_t dst_y);

REQUEST	ARGUMENTS
       conn	 The XCB connection to X11.

       src_window
		 If src_window is not XCB_NONE (TODO), the move	will only take
		 place if the pointer is inside	src_window and within the rec-
		 tangle	specified by (src_x, src_y, src_width, src_height).
		 The rectangle coordinates are relative	to src_window.

       dst_window
		 If dst_window is not XCB_NONE (TODO), the pointer will	be
		 moved to the offsets (dst_x, dst_y) relative to dst_window.
		 If dst_window is XCB_NONE (TODO), the pointer will be moved
		 by the	offsets	(dst_x,	dst_y) relative	to the current posi-
		 tion of the pointer.

       src_x	 TODO: NOT YET DOCUMENTED.

       src_y	 TODO: NOT YET DOCUMENTED.

       src_width TODO: NOT YET DOCUMENTED.

       src_height
		 TODO: NOT YET DOCUMENTED.

       dst_x	 TODO: NOT YET DOCUMENTED.

       dst_y	 TODO: NOT YET DOCUMENTED.

DESCRIPTION
       Moves the mouse pointer to the specified	position.

       If src_window is	not XCB_NONE (TODO), the move will only	take place if
       the pointer is inside src_window	and within the rectangle specified by
       (src_x, src_y, src_width, src_height). The rectangle coordinates	are
       relative	to src_window.

       If dst_window is	not XCB_NONE (TODO), the pointer will be moved to the
       offsets (dst_x, dst_y) relative to dst_window. If dst_window is
       XCB_NONE	(TODO),	the pointer will be moved by the offsets (dst_x,
       dst_y) relative to the current position of the pointer.

RETURN VALUE
       Returns an xcb_void_cookie_t. Errors (if	any) have to be	handled	in the
       event loop.

       If you want to handle errors directly with xcb_request_check instead,
       use xcb_warp_pointer_checked. See xcb-requests(3) for details.

ERRORS
       xcb_window_error_t
		 TODO: reasons?

SEE ALSO
       xcb-requests(3),	xcb_set_input_focus(3)

AUTHOR
       Generated from xproto.xml. Contact xcb@lists.freedesktop.org for	cor-
       rections	and improvements.

X Version 11			  libxcb 1.14		   xcb_warp_pointer(3)

NAME | SYNOPSIS | REQUEST ARGUMENTS | DESCRIPTION | RETURN VALUE | ERRORS | SEE ALSO | AUTHOR

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=xcb_warp_pointer&sektion=3&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help