fdo-mirrors/xorg-libx11
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/xorg/lib/libx11.git synced 2026-05-04 21:08:10 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add manual pages for XGetXCBConnection and XSetEventQueueOwner

Browse source
This commit is contained in:
Josh Triplett 2006-10-06 15:53:27 -07:00
parent 688224cea9
commit e4c7cfdee4
3 changed files with 104 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
man/Makefile.am
View file

@ -76,6 +76,7 @@ libman_PRE = \
XGetVisualInfo.man \
XGetWindowAttributes.man \
XGetWindowProperty.man \
XGetXCBConnection.man \
XGrabButton.man \
XGrabKey.man \
XGrabKeyboard.man \
@ -132,6 +133,7 @@ libman_PRE = \
XSetCloseDownMode.man \
XSetCommand.man \
XSetErrorHandler.man \
XSetEventQueueOwner.man \
XSendEvent.man \
XSetFillStyle.man \
XSetFont.man \

44
man/XGetXCBConnection.man Normal file
View file

@ -0,0 +1,44 @@
.\" Copyright \(co 2006 Josh Triplett
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining
.\" a copy of this software and associated documentation files (the
.\" "Software"), to deal in the Software without restriction, including
.\" without limitation the rights to use, copy, modify, merge, publish,
.\" distribute, sublicense, and/or sell copies of the Software, and to
.\" permit persons to whom the Software is furnished to do so, subject to
.\" the following conditions:
.\"
.\" The above copyright notice and this permission notice shall be included
.\" in all copies or substantial portions of the Software.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
.\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
.\" OTHER DEALINGS IN THE SOFTWARE.
.\"
.TH XGetXCBConnection 3X11 __xorgversion__ "XLIB FUNCTIONS"
.SH NAME
XGetXCBConnection \- get the XCB connection for an Xlib Display
.SH SYNTAX
.HP
#include <X11/Xlib-xcb.h>
.HP
xcb_connection_t *XGetXCBConnection(Display *\fIdpy\fP);
.SH ARGUMENTS
.IP \fIdpy\fP 1i
Specifies the connection to the X server.
.IN "Environment" "DISPLAY"
.SH DESCRIPTION
The \fIXGetXCBConnection\fP function returns the XCB connection associated with
an Xlib Display. Clients can use this XCB connection with functions from the
XCB library, just as they would with an XCB connection created with XCB.
Callers of this function must link to libX11-xcb and a version of Xlib built
with XCB support.
.SH "SEE ALSO"
XOpenDisplay(3X11),
XSetEventQueueOwner(3X11),
.br
\fIXlib \- C Language X Interface\fP

58
man/XSetEventQueueOwner.man Normal file
View file

@ -0,0 +1,58 @@
.\" Copyright \(co 2006 Josh Triplett
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining
.\" a copy of this software and associated documentation files (the
.\" "Software"), to deal in the Software without restriction, including
.\" without limitation the rights to use, copy, modify, merge, publish,
.\" distribute, sublicense, and/or sell copies of the Software, and to
.\" permit persons to whom the Software is furnished to do so, subject to
.\" the following conditions:
.\"
.\" The above copyright notice and this permission notice shall be included
.\" in all copies or substantial portions of the Software.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
.\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
.\" OTHER DEALINGS IN THE SOFTWARE.
.\"
.TH XSetEventQueueOwner 3X11 __xorgversion__ "XLIB FUNCTIONS"
.SH NAME
XSetEventQueueOwner \- set event queue owner on a shared Xlib/XCB connection
.SH SYNTAX
.HP
#include <X11/Xlib-xcb.h>
.HP
void XSetEventQueueOwner(Display *\fIdpy\fP, enum XEventQueueOwner \fIowner\fP);
.SH ARGUMENTS
.IP \fIdpy\fP 1i
Specifies the connection to the X server.
.IP \fIowner\fP 1i
Specifies the event queue ownership:
.RS
.TP
\fIXlibOwnsEventQueue\fP (default)
Xlib owns the event queue. Use the Xlib event-handling functions. Do not
call the XCB event-handling functions.
.TP
\fIXCBOwnsEventQueue\fP
XCB owns the event queue. Use the XCB event-handling functions. Do not call
the Xlib event-handling functions.
.RE
.IN "Environment" "DISPLAY"
.SH DESCRIPTION
While a client using Xlib/XCB can issue requests and handle their replies or
errors with either Xlib or XCB, only one can own and handle the event queue.
By default, Xlib must own the event queue, for compatibility with legacy Xlib
clients. Clients can call \fIXSetEventQueueOwner\fP immediately after
\fIXOpenDisplay\fP to let XCB own the event queue instead. Clients may not
call \fIXSetEventQueueOwner\fP at any other time, as this will potentially
lose responses.
.SH "SEE ALSO"
XOpenDisplay(3X11),
XGetXCBConnection(3X11),
.br
\fIXlib \- C Language X Interface\fP