diff options
author | Matthieu Herrb <matthieu@cvs.openbsd.org> | 2020-01-04 17:55:18 +0000 |
---|---|---|
committer | Matthieu Herrb <matthieu@cvs.openbsd.org> | 2020-01-04 17:55:18 +0000 |
commit | 1128148d76d7952d7aacfa2b083f5b5a96b4b4d5 (patch) | |
tree | 9291b9dfdfb4da1828705353be85e340f302e651 /lib/libX11/man/XCreateWindow.man | |
parent | 7b7fd95cb6ee85ebe6d6d08b126b770770e86688 (diff) |
Uppdate to libX11 1.6.9. Tested by krw@ and naddy@
Diffstat (limited to 'lib/libX11/man/XCreateWindow.man')
-rw-r--r-- | lib/libX11/man/XCreateWindow.man | 219 |
1 files changed, 93 insertions, 126 deletions
diff --git a/lib/libX11/man/XCreateWindow.man b/lib/libX11/man/XCreateWindow.man index 16cc7455f..ffdf77b85 100644 --- a/lib/libX11/man/XCreateWindow.man +++ b/lib/libX11/man/XCreateWindow.man @@ -39,55 +39,22 @@ .\" to this documentation without specific, written prior permission. .\" Digital and Tektronix makes no representations about the suitability .\" of this documentation for any purpose. -.\" It is provided ``as is'' without express or implied warranty. -.\" +.\" It is provided "as is" without express or implied warranty. +.\" .\" .ds xT X Toolkit Intrinsics \- C Language Interface .ds xW Athena X Widgets \- C Language X Toolkit Interface .ds xL Xlib \- C Language X Interface .ds xC Inter-Client Communication Conventions Manual -.na -.de Ds -.nf -.\\$1D \\$2 \\$1 -.ft CW -.\".ps \\n(PS -.\".if \\n(VS>=40 .vs \\n(VSu -.\".if \\n(VS<=39 .vs \\n(VSp -.. -.de De -.ce 0 -.if \\n(BD .DF -.nr BD 0 -.in \\n(OIu -.if \\n(TM .ls 2 -.sp \\n(DDu -.fi -.. -.de IN \" send an index entry to the stderr -.. -.de Pn -.ie t \\$1\fB\^\\$2\^\fR\\$3 -.el \\$1\fI\^\\$2\^\fP\\$3 -.. -.de ZN -.ie t \fB\^\\$1\^\fR\\$2 -.el \fI\^\\$1\^\fP\\$2 -.. -.de hN -.ie t <\fB\\$1\fR>\\$2 -.el <\fI\\$1\fP>\\$2 -.. -.ny0 '\" t .TH XCreateWindow __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" .SH NAME XCreateWindow, XCreateSimpleWindow, XSetWindowAttributes \- create windows and window attributes structure .SH SYNTAX .HP -Window XCreateWindow\^(\^Display *\fIdisplay\fP\^, Window \fIparent\fP\^, int \fIx\fP\^, int \fIy\fP\^, unsigned int \fIwidth\fP\^, unsigned int \fIheight\fP\^, unsigned int \fIborder_width\fP\^, int \fIdepth\fP\^, unsigned int \fIclass\fP\^, Visual *\fIvisual\fP\^, unsigned long \fIvaluemask\fP\^, XSetWindowAttributes *\fIattributes\fP\^); +Window XCreateWindow\^(\^Display *\fIdisplay\fP\^, Window \fIparent\fP\^, int \fIx\fP\^, int \fIy\fP\^, unsigned int \fIwidth\fP\^, unsigned int \fIheight\fP\^, unsigned int \fIborder_width\fP\^, int \fIdepth\fP\^, unsigned int \fIclass\fP\^, Visual *\fIvisual\fP\^, unsigned long \fIvaluemask\fP\^, XSetWindowAttributes *\fIattributes\fP\^); .HP -Window XCreateSimpleWindow\^(\^Display *\fIdisplay\fP\^, Window \fIparent\fP\^, int \fIx\fP\^, int \fIy\fP\^, unsigned int \fIwidth\fP\^, unsigned int \fIheight\fP\^, unsigned int \fIborder_width\fP\^, unsigned long \fIborder\fP\^, unsigned long \fIbackground\fP\^); +Window XCreateSimpleWindow\^(\^Display *\fIdisplay\fP\^, Window \fIparent\fP\^, int \fIx\fP\^, int \fIy\fP\^, unsigned int \fIwidth\fP\^, unsigned int \fIheight\fP\^, unsigned int \fIborder_width\fP\^, unsigned long \fIborder\fP\^, unsigned long \fIbackground\fP\^); .SH ARGUMENTS .IP \fIattributes\fP 1i Specifies the structure from which the values (as specified by the value mask) @@ -104,18 +71,18 @@ Specifies the width of the created window's border in pixels. .IP \fIclass\fP 1i Specifies the created window's class. You can pass -.ZN InputOutput , -.ZN InputOnly , -or -.ZN CopyFromParent . -A class of -.ZN CopyFromParent +.BR InputOutput , +.BR InputOnly , +or +.BR CopyFromParent . +A class of +.B CopyFromParent means the class is taken from the parent. .IP \fIdepth\fP 1i Specifies the window's depth. -A depth of -.ZN CopyFromParent +A depth of +.B CopyFromParent means the depth is taken from the parent. .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -129,33 +96,32 @@ If valuemask is zero, the attributes are ignored and are not referenced. .IP \fIvisual\fP 1i Specifies the visual type. -A visual of -.ZN CopyFromParent -means the visual type is taken from the +A visual of +.B CopyFromParent +means the visual type is taken from the parent. -.ds Wh , which are the created window's inside dimensions \ -and do not include the created window's borders .IP \fIwidth\fP 1i .br .ns .IP \fIheight\fP 1i -Specify the width and height\*(Wh. -.ds Xy , which are the top-left outside corner of the window's \ -borders and are relative to the inside of the parent window's borders +Specify the width and height, which are the created window's inside dimensions +and do not include the created window's borders. .IP \fIx\fP 1i .br .ns .IP \fIy\fP 1i -Specify the x and y coordinates\*(Xy. +Specify the x and y coordinates, which are the top-left outside +corner of the window's +borders and are relative to the inside of the parent window's borders. .SH DESCRIPTION The -.ZN XCreateWindow -function creates an unmapped subwindow for a specified parent window, -returns the window ID of the created window, +.B XCreateWindow +function creates an unmapped subwindow for a specified parent window, +returns the window ID of the created window, and causes the X server to generate a -.ZN CreateNotify +.B CreateNotify event. -The created window is placed on top in the stacking order +The created window is placed on top in the stacking order with respect to siblings. .LP The coordinate system has the X axis horizontal and the Y axis vertical @@ -164,95 +130,95 @@ Coordinates are integral, in terms of pixels, and coincide with pixel centers. Each window and pixmap has its own coordinate system. -For a window, +For a window, the origin is inside the border at the inside, upper-left corner. .LP The border_width for an -.ZN InputOnly +.B InputOnly window must be zero, or a -.ZN BadMatch +.B BadMatch error results. For class -.ZN InputOutput , +.BR InputOutput , the visual type and depth must be a combination supported for the screen, or a -.ZN BadMatch +.B BadMatch error results. The depth need not be the same as the parent, -but the parent must not be a window of class -.ZN InputOnly , +but the parent must not be a window of class +.BR InputOnly , or a -.ZN BadMatch +.B BadMatch error results. For an -.ZN InputOnly +.B InputOnly window, the depth must be zero, and the visual must be one supported by the screen. If either condition is not met, a -.ZN BadMatch +.B BadMatch error results. The parent window, however, may have any depth and class. If you specify any invalid window attribute for a window, a -.ZN BadMatch +.B BadMatch error results. .LP The created window is not yet displayed (mapped) on the user's display. To display the window, call -.ZN XMapWindow . +.BR XMapWindow . The new window initially uses the same cursor as -its parent. +its parent. A new cursor can be defined for the new window by calling -.ZN XDefineCursor . +.BR XDefineCursor . .IN "Cursor" "Initial State" -.IN "XDefineCursor" +.IN "XDefineCursor" The window will not be visible on the screen unless it and all of its ancestors are mapped and it is not obscured by any of its ancestors. .LP -.ZN XCreateWindow +.B XCreateWindow can generate -.ZN BadAlloc -.ZN BadColor , -.ZN BadCursor , -.ZN BadMatch , -.ZN BadPixmap , -.ZN BadValue , +.B BadAlloc +.BR BadColor , +.BR BadCursor , +.BR BadMatch , +.BR BadPixmap , +.BR BadValue , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XCreateSimpleWindow +.B XCreateSimpleWindow function creates an unmapped -.ZN InputOutput +.B InputOutput subwindow for a specified parent window, returns the window ID of the created window, and causes the X server to generate a -.ZN CreateNotify +.B CreateNotify event. -The created window is placed on top in the stacking order with respect to +The created window is placed on top in the stacking order with respect to siblings. Any part of the window that extends outside its parent window is clipped. The border_width for an -.ZN InputOnly +.B InputOnly window must be zero, or a -.ZN BadMatch +.B BadMatch error results. -.ZN XCreateSimpleWindow +.B XCreateSimpleWindow inherits its depth, class, and visual from its parent. -All other window attributes, except background and border, +All other window attributes, except background and border, have their default values. .LP -.ZN XCreateSimpleWindow +.B XCreateSimpleWindow can generate -.ZN BadAlloc , -.ZN BadMatch , -.ZN BadValue , +.BR BadAlloc , +.BR BadMatch , +.BR BadValue , and -.ZN BadWindow +.B BadWindow errors. .SH STRUCTURES The -.ZN XSetWindow Attributes +.BR XSetWindow Attributes structure contains: .LP .LP @@ -262,111 +228,111 @@ lw(.5i) lw(2.5i) lw(.8i). T{ \&#define T} T{ -.ZN CWBackPixmap +.B CWBackPixmap T} T{ (1L<<0) T} T{ \&#define T} T{ -.ZN CWBackPixel +.B CWBackPixel T} T{ (1L<<1) T} T{ \&#define T} T{ -.ZN CWBorderPixmap +.B CWBorderPixmap T} T{ (1L<<2) T} T{ \&#define T} T{ -.ZN CWBorderPixel +.B CWBorderPixel T} T{ (1L<<3) T} T{ \&#define T} T{ -.ZN CWBitGravity +.B CWBitGravity T} T{ (1L<<4) T} T{ \&#define T} T{ -.ZN CWWinGravity +.B CWWinGravity T} T{ (1L<<5) T} T{ \&#define T} T{ -.ZN CWBackingStore +.B CWBackingStore T} T{ (1L<<6) T} T{ \&#define T} T{ -.ZN CWBackingPlanes +.B CWBackingPlanes T} T{ (1L<<7) T} T{ \&#define T} T{ -.ZN CWBackingPixel +.B CWBackingPixel T} T{ (1L<<8) T} T{ \&#define T} T{ -.ZN CWOverrideRedirect +.B CWOverrideRedirect T} T{ (1L<<9) T} T{ \&#define T} T{ -.ZN CWSaveUnder +.B CWSaveUnder T} T{ (1L<<10) T} T{ \&#define T} T{ -.ZN CWEventMask +.B CWEventMask T} T{ (1L<<11) T} T{ \&#define T} T{ -.ZN CWDontPropagate +.B CWDontPropagate T} T{ (1L<<12) T} T{ \&#define T} T{ -.ZN CWColormap +.B CWColormap T} T{ (1L<<13) T} T{ \&#define T} T{ -.ZN CWCursor +.B CWCursor T} T{ (1L<<14) T} .TE .IN "XSetWindowAttributes" "" "@DEF@" -.Ds 0 +.EX /\&* Values */ typedef struct { @@ -386,47 +352,48 @@ typedef struct { Colormap colormap; /\&* color map to be associated with window */ Cursor cursor; /\&* cursor to be displayed (or None) */ } XSetWindowAttributes; -.De +.EE .LP For a detailed explanation of the members of this structure, see \fI\*(xL\fP\^. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadColor +.B BadColor A value for a Colormap argument does not name a defined Colormap. .TP 1i -.ZN BadCursor +.B BadCursor A value for a Cursor argument does not name a defined Cursor. .TP 1i -.ZN BadMatch +.B BadMatch The values do not exist for an -.ZN InputOnly +.B InputOnly window. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadPixmap +.B BadPixmap A value for a Pixmap argument does not name a defined Pixmap. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined -by the argument's type is accepted. Any argument defined as a set of +by the argument's type is accepted. +Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XChangeWindowAttributes(__libmansuffix__), -XConfigureWindow(__libmansuffix__), +XConfigureWindow(__libmansuffix__), XDefineCursor(__libmansuffix__), -XDestroyWindow(__libmansuffix__), -XMapWindow(__libmansuffix__), +XDestroyWindow(__libmansuffix__), +XMapWindow(__libmansuffix__), XRaiseWindow(__libmansuffix__), XUnmapWindow(__libmansuffix__) .br |