Permalink
Switch branches/tags
Nothing to show
Find file
Fetching contributors…
Cannot retrieve contributors at this time
45 lines (41 sloc) 1.5 KB
.TH xcb_ungrab_key 3 2011-12-18 "XCB" "XCB Requests"
.ad l
.SH NAME
xcb_ungrab_key \- release a key combination
.SH SYNOPSIS
.hy 0
.B #include <xcb/xproto.h>
.SS Request function
.HP
xcb_void_cookie_t \fBxcb_ungrab_key\fP(xcb_connection_t\ *\fIconn\fP, xcb_keycode_t\ \fIkey\fP, xcb_window_t\ \fIgrab_window\fP, uint16_t\ \fImodifiers\fP);
.br
.hy 1
.SH REQUEST ARGUMENTS
.IP \fIconn\fP 1i
The XCB connection to X11.
.IP \fIkey\fP 1i
The keycode of the specified key combination.
Using the special value \fIXCB_GRAB_ANY\fP means releasing all possible key codes.
.IP \fIgrab_window\fP 1i
The window on which the grabbed key combination will be released.
.IP \fImodifiers\fP 1i
The modifiers of the specified key combination.
Using the special value \fIXCB_MOD_MASK_ANY\fP means releasing the key combination
with every possible modifier combination.
.SH DESCRIPTION
Releases the key combination on \fIgrab_window\fP if you grabbed it using
\fIxcb_grab_key\fP before.
.SH RETURN VALUE
Returns an \fIxcb_void_cookie_t\fP. Errors (if any) have to be handled in the event loop.
If you want to handle errors directly with \fIxcb_request_check\fP instead, use \fIxcb_ungrab_key_checked\fP. See \fBxcb-requests(3)\fP for details.
.SH ERRORS
.IP \fIxcb_window_error_t\fP 1i
The specified \fIgrab_window\fP does not exist.
.IP \fIxcb_value_error_t\fP 1i
TODO: reasons?
.SH SEE ALSO
.BR xcb-requests (3),
.BR xev (1),
.BR xcb_grab_key (3)
.SH AUTHOR
Generated from xproto.xml. Contact xcb@lists.freedesktop.org for corrections and improvements.