Current File : //usr/share/man/man3xcb/xcb_circulate_window.3xcb

'\" t
.TH xcb_circulate_window 3xcb  2012-03-26 "XCB" "XCB Requests"
.ad l
.SH NAME
xcb_circulate_window \- Change window stacking order
.SH SYNOPSIS
.nf
\fBcc\fR [ \fIflag\fR\&.\&.\&. ] \fIfile\fR\&.\&.\&. \fB\-lxcb\fR [ \fIlibrary\fR\&.\&.\&. ]
.fi
.sp
.nf
\fBcc\fR [ \fIflag\fR\&.\&.\&. ] `pkg-config --cflags *` \fIfile\fR\&.\&.\&. `pkg-config --libs *` 
.fi
.hy 0
.B #include <xcb/xproto.h>
.SS Request function
.HP
xcb_void_cookie_t \fBxcb_circulate_window\fP(xcb_connection_t\ *\fIconn\fP, uint8_t\ \fIdirection\fP, xcb_window_t\ \fIwindow\fP);
.br
.hy 1
.SH REQUEST ARGUMENTS
.IP \fIconn\fP 1i
The XCB connection to X11.
.IP \fIdirection\fP 1i
One of the following values:
.RS 1i
.IP \fIXCB_CIRCULATE_RAISE_LOWEST\fP 1i
TODO: NOT YET DOCUMENTED.
.IP \fIXCB_CIRCULATE_LOWER_HIGHEST\fP 1i
TODO: NOT YET DOCUMENTED.
.RE
.RS 1i


.RE
.IP \fIwindow\fP 1i
The window to raise/lower (depending on \fIdirection\fP).
.SH DESCRIPTION
If \fIdirection\fP is \fIXCB_CIRCULATE_RAISE_LOWEST\fP, the lowest mapped child (if
any) will be raised to the top of the stack.

If \fIdirection\fP is \fIXCB_CIRCULATE_LOWER_HIGHEST\fP, the highest mapped child will
be lowered to the bottom of the stack.
.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_circulate_window_checked\fP. See \fBxcb-requests(3)\fP for details.
.SH ERRORS
.IP \fIxcb_window_error_t\fP 1i
The specified \fIwindow\fP does not exist.
.IP \fIxcb_value_error_t\fP 1i
The specified \fIdirection\fP is invalid.
.SH SEE ALSO
.BR xcb-requests (3)
.SH AUTHOR
Generated from xproto.xml. Contact xcb@lists.freedesktop.org for corrections and improvements.

.\" Begin Oracle Solaris update
.SH "ATTRIBUTES"
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp
.TS
allbox;
cw(2.750000i)| cw(2.750000i)
lw(2.750000i)| lw(2.750000i).
ATTRIBUTE TYPE	ATTRIBUTE VALUE
Availability	x11/library/libxcb
Interface Stability	Volatile
MT-Level	Safe
.TE
.sp
.\" End Oracle Solaris update