man/XISetClientPointer.man

   1 '\" t
   2 .\"     Title: xisetclientpointer
   3 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
   4 .\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
   5 .\"      Date: 09/23/2011
   6 .\"    Manual: [FIXME: manual]
   7 .\"    Source: [FIXME: source]
   8 .\"  Language: English
   9 .\"
  10 .TH "XISETCLIENTPOINTER" "libmansuffix" "09/23/2011" "[FIXME: source]" "[FIXME: manual]"
  11 .\" -----------------------------------------------------------------
  12 .\" * Define some portability stuff
  13 .\" -----------------------------------------------------------------
  14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  15 .\" http://bugs.debian.org/507673
  16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
  17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18 .ie \n(.g .ds Aq \(aq
  19 .el       .ds Aq '
  20 .\" -----------------------------------------------------------------
  21 .\" * set default formatting
  22 .\" -----------------------------------------------------------------
  23 .\" disable hyphenation
  24 .nh
  25 .\" disable justification (adjust text to left margin only)
  26 .ad l
  27 .\" -----------------------------------------------------------------
  28 .\" * MAIN CONTENT STARTS HERE *
  29 .\" -----------------------------------------------------------------
  30 .SH "NAME"
  31 XISetClientPointer, XIGetClientPointer \- set or get the ClientPointer device\&.
  32 .SH "SYNOPSIS"
  33 .sp
  34 .nf
  35 #include <X11/extensions/XInput2\&.h>
  36 .fi
  37 .sp
  38 .nf
  39 XISetClientPointer( Display *display,
  40                     Window win,
  41                     int deviceid);
  42 .fi
  43 .sp
  44 .nf
  45 Bool XIGetClientPointer( Display *display,
  46                          Window win,
  47                          int *device);
  48 .fi
  49 .sp
  50 .nf
  51 display
  52        Specifies the connection to the X server\&.
  53 .fi
  54 .sp
  55 .nf
  56 win
  57        Specifies a window belonging to the client\&. May be None\&.
  58 .fi
  59 .sp
  60 .nf
  61 deviceid
  62        Specifies the ClientPointer device\&.
  63 .fi
  64 .SH "DESCRIPTION"
  65 .sp
  66 .if n \{\
  67 .RS 4
  68 .\}
  69 .nf
  70 The ClientPointer is the device that is percieved to be the
  71 core pointer for non\-XI protocol requests and replies\&. Each
  72 time a protocol message needs device\-dependent data and the
  73 device is not explicitly given, the ClientPointer device is
  74 used to obtain the data\&. For example, a XQueryPointer request
  75 will return the coordinates of the ClientPointer\&.
  76 .fi
  77 .if n \{\
  78 .RE
  79 .\}
  80 .sp
  81 .if n \{\
  82 .RS 4
  83 .\}
  84 .nf
  85 XISetClientPointer request sets the ClientPointer device for
  86 the client that owns the given window\&. If win is None, the
  87 requesting client\*(Aqs ClientPointer is set to the device
  88 specified with deviceid\&. Only master pointer devices can be set
  89 as ClientPointer\&.
  90 .fi
  91 .if n \{\
  92 .RE
  93 .\}
  94 .sp
  95 .if n \{\
  96 .RS 4
  97 .\}
  98 .nf
  99 XISetClientPointer and can generate a BadDevice and a BadWindow
 100 error\&.
 101 .fi
 102 .if n \{\
 103 .RE
 104 .\}
 105 .sp
 106 .if n \{\
 107 .RS 4
 108 .\}
 109 .nf
 110 The XIGetClientPointer request returns the ClientPointer\*(Aqs
 111 device ID for the client that owns the given window\&. If win is
 112 None, the requesting client\*(Aqs ClientPointer is returned\&.
 113 .fi
 114 .if n \{\
 115 .RE
 116 .\}
 117 .sp
 118 .if n \{\
 119 .RS 4
 120 .\}
 121 .nf
 122 win may be a client ID instead of a window\&.
 123 .fi
 124 .if n \{\
 125 .RE
 126 .\}
 127 .sp
 128 .if n \{\
 129 .RS 4
 130 .\}
 131 .nf
 132 XIGetClientPointer can generate a BadWindow error\&.
 133 .fi
 134 .if n \{\
 135 .RE
 136 .\}
 137 .SH "DIAGNOSTICS"
 138 .sp
 139 .if n \{\
 140 .RS 4
 141 .\}
 142 .nf
 143 BadDevice
 144        An invalid device was specified\&. The device does not
 145        exist or is not a master pointer device\&.
 146 .fi
 147 .if n \{\
 148 .RE
 149 .\}
 150 .sp
 151 .if n \{\
 152 .RS 4
 153 .\}
 154 .nf
 155 BadWindow
 156        A value for a Window argument does not name a defined
 157        window\&.
 158 .fi
 159 .if n \{\
 160 .RE
 161 .\}