xcb_create_window_checked man page on DragonFly

Man page or keyword search:  
man Server   44335 pages
apropos Keyword Search (all sections)
Output format
DragonFly logo
[printable version]

xcb_create_window(3)		 XCB Requests		  xcb_create_window(3)

NAME
       xcb_create_window - Creates a window

SYNOPSIS
       #include <xcb/xproto.h>

   Request function
       xcb_void_cookie_t xcb_create_window(xcb_connection_t *conn,
	      uint8_t depth, xcb_window_t wid, xcb_window_t parent, int16_t x,
	      int16_t y, uint16_t width, uint16_t height,
	      uint16_t border_width, uint16_t _class, xcb_visualid_t visual,
	      uint32_t value_mask, const uint32_t *value_list);

REQUEST ARGUMENTS
       conn	 The XCB connection to X11.

       depth	 Specifies the new window's depth (TODO: what unit?).

		 The special value XCB_COPY_FROM_PARENT means the depth is
		 taken from the parent window.

       wid	 The ID with which you will refer to the new window, created
		 by xcb_generate_id.

       parent	 The parent window of the new window.

       x	 The X coordinate of the new window.

       y	 The Y coordinate of the new window.

       width	 The width of the new window.

       height	 The height of the new window.

       border_width
		 TODO:

		 Must be zero if the class is InputOnly or a xcb_match_error_t
		 occurs.

       _class	 One of the following values:

		 XCB_WINDOW_CLASS_COPY_FROM_PARENT
			   TODO: NOT YET DOCUMENTED.

		 XCB_WINDOW_CLASS_INPUT_OUTPUT
			   TODO: NOT YET DOCUMENTED.

		 XCB_WINDOW_CLASS_INPUT_ONLY
			   TODO: NOT YET DOCUMENTED.

       visual	 Specifies the id for the new window's visual.

		 The special value XCB_COPY_FROM_PARENT means the visual is
		 taken from the parent window.

       value_mask
		 One of the following values:

		 XCB_CW_BACK_PIXMAP
			   Overrides the default background-pixmap. The back‐
			   ground pixmap and window must have the same root
			   and same depth. Any size pixmap can be used, al‐
			   though some sizes may be faster than others.

			   If XCB_BACK_PIXMAP_NONE is specified, the window
			   has no defined background.  The server may fill the
			   contents with the previous screen contents or with
			   contents of its own choosing.

			   If XCB_BACK_PIXMAP_PARENT_RELATIVE is specified,
			   the parent's background is used, but the window
			   must have the same depth as the parent (or a Match
			   error results).   The parent's background is
			   tracked, and the current version is used each time
			   the window background is required.

		 XCB_CW_BACK_PIXEL
			   Overrides BackPixmap. A pixmap of undefined size
			   filled with the specified background pixel is used
			   for the background. Range-checking is not per‐
			   formed, the background pixel is truncated to the
			   appropriate number of bits.

		 XCB_CW_BORDER_PIXMAP
			   Overrides the default border-pixmap. The border
			   pixmap and window must have the same root and the
			   same depth. Any size pixmap can be used, although
			   some sizes may be faster than others.

			   The special value XCB_COPY_FROM_PARENT means the
			   parent's border pixmap is copied (subsequent
			   changes to the parent's border attribute do not af‐
			   fect the child), but the window must have the same
			   depth as the parent.

		 XCB_CW_BORDER_PIXEL
			   Overrides BorderPixmap. A pixmap of undefined size
			   filled with the specified border pixel is used for
			   the border. Range checking is not performed on the
			   border-pixel value, it is truncated to the appro‐
			   priate number of bits.

		 XCB_CW_BIT_GRAVITY
			   Defines which region of the window should be re‐
			   tained if the window is resized.

		 XCB_CW_WIN_GRAVITY
			   Defines how the window should be repositioned if
			   the parent is resized (see ConfigureWindow).

		 XCB_CW_BACKING_STORE
			   A backing-store of WhenMapped advises the server
			   that maintaining contents of obscured regions when
			   the window is mapped would be beneficial. A back‐
			   ing-store of Always advises the server that main‐
			   taining contents even when the window is unmapped
			   would be beneficial. In this case, the server may
			   generate an exposure event when the window is cre‐
			   ated. A value of NotUseful advises the server that
			   maintaining contents is unnecessary, although a
			   server may still choose to maintain contents while
			   the window is mapped. Note that if the server main‐
			   tains contents, then the server should maintain
			   complete contents not just the region within the
			   parent boundaries, even if the window is larger
			   than its parent. While the server maintains con‐
			   tents, exposure events will not normally be gener‐
			   ated, but the server may stop maintaining contents
			   at any time.

		 XCB_CW_BACKING_PLANES
			   The backing-planes indicates (with bits set to 1)
			   which bit planes of the window hold dynamic data
			   that must be preserved in backing-stores and during
			   save-unders.

		 XCB_CW_BACKING_PIXEL
			   The backing-pixel specifies what value to use in
			   planes not covered by backing-planes. The server is
			   free to save only the specified bit planes in the
			   backing-store or save-under and regenerate the re‐
			   maining planes with the specified pixel value. Any
			   bits beyond the specified depth of the window in
			   these values are simply ignored.

		 XCB_CW_OVERRIDE_REDIRECT
			   The override-redirect specifies whether map and
			   configure requests on this window should override a
			   SubstructureRedirect on the parent, typically to
			   inform a window manager not to tamper with the win‐
			   dow.

		 XCB_CW_SAVE_UNDER
			   If 1, the server is advised that when this window
			   is mapped, saving the contents of windows it ob‐
			   scures would be beneficial.

		 XCB_CW_EVENT_MASK
			   The event-mask defines which events the client is
			   interested in for this window (or for some event
			   types, inferiors of the window).

		 XCB_CW_DONT_PROPAGATE
			   The do-not-propagate-mask defines which events
			   should not be propagated to ancestor windows when
			   no client has the event type selected in this win‐
			   dow.

		 XCB_CW_COLORMAP
			   The colormap specifies the colormap that best re‐
			   flects the true colors of the window. Servers capa‐
			   ble of supporting multiple hardware colormaps may
			   use this information, and window man- agers may use
			   it for InstallColormap requests. The colormap must
			   have the same visual type and root as the window
			   (or a Match error results). If CopyFromParent is
			   specified, the parent's colormap is copied (subse‐
			   quent changes to the parent's colormap attribute do
			   not affect the child).  However, the window must
			   have the same visual type as the parent (or a Match
			   error results), and the parent must not have a col‐
			   ormap of None (or a Match error results). For an
			   explanation of None, see FreeColormap request. The
			   colormap is copied by sharing the colormap object
			   between the child and the parent, not by making a
			   complete copy of the colormap contents.

		 XCB_CW_CURSOR
			   If a cursor is specified, it will be used whenever
			   the pointer is in the window. If None is speci-
			   fied, the parent's cursor will be used when the
			   pointer is in the window, and any change in the
			   parent's cursor will cause an immediate change in
			   the displayed cursor.
		 TODO: NOT YET DOCUMENTED.

       value_list
		 TODO: NOT YET DOCUMENTED.

DESCRIPTION
       Creates an unmapped window as child of the specified parent window. A
       CreateNotify event will be generated. The new window is placed on top
       in the stacking order with respect to siblings.

       The coordinate system has the X axis horizontal and the Y axis vertical
       with the origin [0, 0] at the upper-left corner. Coordinates are inte‐
       gral, in terms of pixels, and coincide with pixel centers. Each window
       and pixmap has its own coordinate system. For a window, the origin is
       inside the border at the inside, upper-left corner.

       The created window is not yet displayed (mapped), call xcb_map_window
       to display it.

       The created window will initially use the same cursor as its parent.

RETURN VALUE
       Returns an xcb_void_cookie_t. Errors (if any) have to be handled in the
       event loop.

       If you want to handle errors directly with xcb_request_check instead,
       use xcb_create_window_checked. See xcb-requests(3) for details.

ERRORS
       xcb_alloc_error_t
		 The X server could not allocate the requested resources (no
		 memory?).

       xcb_colormap_error_t
		 TODO: reasons?

       xcb_cursor_error_t
		 TODO: reasons?

       xcb_match_error_t
		 TODO: reasons?

       xcb_pixmap_error_t
		 TODO: reasons?

       xcb_value_error_t
		 TODO: reasons?

       xcb_window_error_t
		 TODO: reasons?

SEE ALSO
       xcb-requests(3), xcb_create_notify_event_t(3), xcb_map_window(3),
       xcb_generate_id(3)

AUTHOR
       Generated from xproto.xml. Contact xcb@lists.freedesktop.org for cor‐
       rections and improvements.

X Version 11			 libxcb 1.11.1		  xcb_create_window(3)
[top]

List of man pages available for DragonFly

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Tweet
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
....................................................................
Vote for polarhome
Free Shell Accounts :: the biggest list on the net