IABSD.fr/xenocara/lib/libXi/man/XISetClientPointer.man

Branch : - branch - master - tag -

• Show log

  Commit

• Author : matthieu
  Date : 2010-05-18 19:28:54
  Hash : 69110947
  Message : Update to libXi 1.3. Tested on a bulk ports build by naddy@.

• lib/libXi/man/XISetClientPointer.man

• '\" t
  .\"     Title: xisetclientpointer
  .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
  .\" Generator: DocBook XSL Stylesheets v1.74.3 <http://docbook.sf.net/>
  .\"      Date: 10/02/2009
  .\"    Manual: [FIXME: manual]
  .\"    Source: [FIXME: source]
  .\"  Language: English
  .\"
  .TH "XISETCLIENTPOINTER" "libmansuffix" "10/02/2009" "[FIXME: source]" "[FIXME: manual]"
  .\" -----------------------------------------------------------------
  .\" * set default formatting
  .\" -----------------------------------------------------------------
  .\" disable hyphenation
  .nh
  .\" disable justification (adjust text to left margin only)
  .ad l
  .\" -----------------------------------------------------------------
  .\" * MAIN CONTENT STARTS HERE *
  .\" -----------------------------------------------------------------
  .SH "NAME"
  XISetClientPointer, XIGetClientPointer \- set or get the ClientPointer device\&.
  .SH "SYNOPSIS"
  .sp
  .nf
  #include <X11/extensions/XInput2\&.h>
  .fi
  .sp
  .nf
  XISetClientPointer( Display *display,
                      Window win,
                      int deviceid);
  .fi
  .sp
  .nf
  Bool XIGetClientPointer( Display *display,
                           Window win,
                           int *device);
  .fi
  .sp
  .nf
  display
         Specifies the connection to the X server\&.
  .fi
  .sp
  .nf
  win
         Specifies a window belonging to the client\&. May be None\&.
  .fi
  .sp
  .nf
  deviceid
         Specifies the ClientPointer device\&.
  .fi
  .SH "DESCRIPTION"
  .sp
  .if n \{\
  .RS 4
  .\}
  .nf
  The ClientPointer is the device that is percieved to be the
  core pointer for non\-XI protocol requests and replies\&. Each
  time a protocol message needs device\-dependent data and the
  device is not explicitly given, the ClientPointer device is
  used to obtain the data\&. For example, a XQueryPointer request
  will return the coordinates of the ClientPointer\&.
  .fi
  .if n \{\
  .RE
  .\}
  .sp
  .if n \{\
  .RS 4
  .\}
  .nf
  XISetClientPointer request sets the ClientPointer device for
  the client that owns the given window\&. If win is None, the
  requesting client\'s ClientPointer is set to the device
  specified with deviceid\&. Only master pointer devices can be set
  as ClientPointer\&.
  .fi
  .if n \{\
  .RE
  .\}
  .sp
  .if n \{\
  .RS 4
  .\}
  .nf
  XISetClientPointer and can generate a BadDevice and a BadWindow
  error\&.
  .fi
  .if n \{\
  .RE
  .\}
  .sp
  .if n \{\
  .RS 4
  .\}
  .nf
  The XIGetClientPointer request returns the ClientPointer\'s
  device ID for the client that owns the given window\&. If win is
  None, the requesting client\'s ClientPointer is returned\&.
  .fi
  .if n \{\
  .RE
  .\}
  .sp
  .if n \{\
  .RS 4
  .\}
  .nf
  win may be a client ID instead of a window\&.
  .fi
  .if n \{\
  .RE
  .\}
  .sp
  .if n \{\
  .RS 4
  .\}
  .nf
  XIGetClientPointer can generate a BadWindow error\&.
  .fi
  .if n \{\
  .RE
  .\}
  .SH "DIAGNOSTICS"
  .sp
  .if n \{\
  .RS 4
  .\}
  .nf
  BadDevice
         An invalid device was specified\&. The device does not
         exist or is not a master pointer device\&.
  .fi
  .if n \{\
  .RE
  .\}
  .sp
  .if n \{\
  .RS 4
  .\}
  .nf
  BadWindow
         A value for a Window argument does not name a defined
         window\&.
  .fi
  .if n \{\
  .RE
  .\}