XISetClientPointer.txt revision c27c18e8
1de2362d3SmrgXISETCLIENTPOINTER(libmansuffix) 2de2362d3Smrg================================ 3de2362d3Smrg 4de2362d3SmrgNAME 5de2362d3Smrg---- 6de2362d3Smrg 7de2362d3Smrg XISetClientPointer, XIGetClientPointer - set or get the 8de2362d3Smrg ClientPointer device. 9de2362d3Smrg 10de2362d3SmrgSYNOPSIS 11de2362d3Smrg-------- 12de2362d3Smrg 13de2362d3Smrg #include <X11/extensions/XInput2.h> 14de2362d3Smrg 15de2362d3Smrg XISetClientPointer( Display *display, 16de2362d3Smrg Window win, 17de2362d3Smrg int deviceid); 18de2362d3Smrg 19de2362d3Smrg Bool XIGetClientPointer( Display *display, 20de2362d3Smrg Window win, 21de2362d3Smrg int *device); 22de2362d3Smrg 23de2362d3Smrg display 24de2362d3Smrg Specifies the connection to the X server. 25de2362d3Smrg 26de2362d3Smrg win 27de2362d3Smrg Specifies a window belonging to the client. May be None. 28de2362d3Smrg 2918781e08Smrg deviceid 300d16fef4Smrg Specifies the ClientPointer device. 31de2362d3Smrg 3218781e08SmrgDESCRIPTION 3318781e08Smrg----------- 3418781e08Smrg 35de2362d3Smrg The ClientPointer is the device that is percieved to be the 36de2362d3Smrg core pointer for non-XI protocol requests and replies. Each 37de2362d3Smrg time a protocol message needs device-dependent data and the 38de2362d3Smrg device is not explicitly given, the ClientPointer device is 39de2362d3Smrg used to obtain the data. For example, a XQueryPointer request 40de2362d3Smrg will return the coordinates of the ClientPointer. 41de2362d3Smrg 4218781e08Smrg XISetClientPointer request sets the ClientPointer device for 43de2362d3Smrg the client that owns the given window. If win is None, the 44de2362d3Smrg requesting client's ClientPointer is set to the device 45de2362d3Smrg specified with deviceid. Only master pointer devices can be set 46de2362d3Smrg as ClientPointer. 47de2362d3Smrg 48de2362d3Smrg XISetClientPointer and can generate a BadDevice and a BadWindow 49de2362d3Smrg error. 50de2362d3Smrg 51de2362d3Smrg The XIGetClientPointer request returns the ClientPointer's 52de2362d3Smrg device ID for the client that owns the given window. If win is 53de2362d3Smrg None, the requesting client's ClientPointer is returned. 54de2362d3Smrg 55de2362d3Smrg win may be a client ID instead of a window. 56de2362d3Smrg 57de2362d3Smrg XIGetClientPointer can generate a BadWindow error. 5818781e08Smrg 5918781e08SmrgDIAGNOSTICS 6018781e08Smrg----------- 6118781e08Smrg 62de2362d3Smrg BadDevice 63de2362d3Smrg An invalid device was specified. The device does not 6418781e08Smrg exist or is not a master pointer device. 6539413783Smrg 6639413783Smrg BadWindow 6718781e08Smrg A value for a Window argument does not name a defined 6818781e08Smrg window. 6918781e08Smrg 7018781e08Smrg