man/XSetEventQueueOwner.man

   1 .\" Copyright \(co 2006 Josh Triplett
   2 .\"
   3 .\" Permission is hereby granted, free of charge, to any person obtaining
   4 .\" a copy of this software and associated documentation files (the
   5 .\" "Software"), to deal in the Software without restriction, including
   6 .\" without limitation the rights to use, copy, modify, merge, publish,
   7 .\" distribute, sublicense, and/or sell copies of the Software, and to
   8 .\" permit persons to whom the Software is furnished to do so, subject to
   9 .\" the following conditions:
  10 .\"
  11 .\" The above copyright notice and this permission notice shall be included
  12 .\" in all copies or substantial portions of the Software.
  13 .\"
  14 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  15 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  16 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  17 .\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
  18 .\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  19 .\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  20 .\" OTHER DEALINGS IN THE SOFTWARE.
  21 .\"
  22 .TH XSetEventQueueOwner __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
  23 .SH NAME
  24 XSetEventQueueOwner \- set event queue owner on a shared Xlib/XCB connection
  25 .SH SYNTAX
  26 .HP
  27  #include <X11/Xlib-xcb.h>
  28 .HP
  29 void XSetEventQueueOwner(Display *\fIdpy\fP, enum XEventQueueOwner \fIowner\fP);
  30 .SH ARGUMENTS
  31 .IP \fIdpy\fP 1i
  32 Specifies the connection to the X server.
  33 .IP \fIowner\fP 1i
  34 Specifies the event queue ownership:
  35 .RS
  36 .TP
  37 \fIXlibOwnsEventQueue\fP (default)
  38 Xlib owns the event queue.  Use the Xlib event-handling functions.  Do not
  39 call the XCB event-handling functions.
  40 .TP
  41 \fIXCBOwnsEventQueue\fP
  42 XCB owns the event queue.  Use the XCB event-handling functions.  Do not call
  43 the Xlib event-handling functions.
  44 .RE
  45 .IN "Environment" "DISPLAY"
  46 .SH DESCRIPTION
  47 While a client using Xlib/XCB can issue requests and handle their replies or
  48 errors with either Xlib or XCB, only one can own and handle the event queue.
  49 By default, Xlib must own the event queue, for compatibility with legacy Xlib
  50 clients.  Clients can call \fIXSetEventQueueOwner\fP immediately after
  51 \fIXOpenDisplay\fP to let XCB own the event queue instead.  Clients may not
  52 call \fIXSetEventQueueOwner\fP at any other time, as this will potentially
  53 lose responses.
  54 .SH "SEE ALSO"
  55 XOpenDisplay(__libmansuffix__),
  56 XGetXCBConnection(__libmansuffix__),
  57 .br
  58 \fIXlib \- C Language X Interface\fP