XGetWMHints man page on Ultrix

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

XAllocWMHints(3X11)		     X11R5		   XAllocWMHints(3X11)

NAME
       XAllocWMHints, XSetWMHints, XGetWMHints, XWMHints - allocate window
       manager hints structure and set or read a window's WM_HINTS property

SYNTAX
       XWMHints *XAllocWMHints()

       XSetWMHints(display, w, wmhints)
	     Display *display;
	     Window w;
	     XWMHints *wmhints;

       XWMHints *XGetWMHints(display, w)
	     Display *display;
	     Window w;

ARGUMENTS
       display	 Specifies the connection to the X server.

       w	 Specifies the window.

       wmhints	 Specifies the structure to be used.

DESCRIPTION
       The function allocates and returns a pointer to a structure.  Note that
       all fields in the structure are initially set to zero.  If insufficient
       memory is available, returns NULL.  To free the memory allocated to
       this structure, use

       The function sets the window manager hints that include icon informa‐
       tion and location, the initial state of the window, and whether the
       application relies on the window manager to get keyboard input.

       can generate and errors.

       The function reads the window manager hints and returns NULL if no
       WM_HINTS property was set on the window or returns a pointer to a
       structure if it succeeds.  When finished with the data, free the space
       used for it by calling

       can generate a error.

PROPERTIES
       WM_HINTS	 Additional hints set by the client for use by the window man‐
		 ager.	The C type of this property is

STRUCTURES
       The structure contains:

       /* Window manager hints mask bits */

       #define	     (1L << 0)
       #define	     (1L << 1)
       #define	     (1L << 2)
       #define	     (1L << 3)
       #define	     (1L << 4)
       #define	     (1L << 5)
       #define	     (1L << 6)

       #define	     (InputHint|State‐
		     Hint|Icon‐
		     PixmapHint|
		     IconWin‐
		     dowHint|IconPosi‐
		     tionHint|
		     IconMaskHint|Win‐
		     dowGroupHint)

       /* Values */

       typedef struct {
	       long flags;     /* marks which fields in this structure are defined */
	       Bool input;     /* does this application rely on the window manager to
			       get keyboard input? */
	       int initial_state;      /* see below */
	       Pixmap icon_pixmap;     /* pixmap to be used as icon */
	       Window icon_window;     /* window to be used as icon */
	       int icon_x, icon_y;     /* initial position of icon */
	       Pixmap icon_mask;       /* pixmap to be used as mask for icon_pixmap */
	       XID window_group;       /* id of related window group */
	       /* this structure may be extended in the future */
       } XWMHints;

       The input member is used to communicate to the window manager the input
       focus model used by the application.  Applications that expect input
       but never explicitly set focus to any of their subwindows (that is, use
       the push model of focus management), such as X Version 10 style appli‐
       cations that use real-estate driven focus, should set this member to
       Similarly, applications that set input focus to their subwindows only
       when it is given to their top-level window by a window manager should
       also set this member to Applications that manage their own input focus
       by explicitly setting focus to one of their subwindows whenever they
       want keyboard input (that is, use the pull model of focus management)
       should set this member to Applications that never expect any keyboard
       input also should set this member to

       Pull model window managers should make it possible for push model
       applications to get input by setting input focus to the top-level win‐
       dows of applications whose input member is Push model window managers
       should make sure that pull model applications do not break them by
       resetting input focus to when it is appropriate (for example, whenever
       an application whose input member is sets input focus to one of its
       subwindows).

       The definitions for the initial_state flag are:

       #define	     0
       #define	     1	 /* most applica‐
			 tions start this
			 way */
       #define	     3	 /* application
			 wants to start
			 as an icon */
       The icon_mask specifies which pixels of the icon_pixmap should be used
       as the icon.  This allows for nonrectangular icons.  Both icon_pixmap
       and icon_mask must be bitmaps.  The icon_window lets an application
       provide a window for use as an icon for window managers that support
       such use.  The window_group lets you specify that this window belongs
       to a group of other windows.  For example, if a single application
       manipulates multiple top-level windows, this allows you to provide
       enough information that a window manager can iconify all of the windows
       rather than just the one window.

DIAGNOSTICS
       The server failed to allocate the requested resource or server memory.

       A value for a Window argument does not name a defined Window.

SEE ALSO
       XAllocClassHint(3X11), XAllocIconSize(3X11), XAllocSizeHints(3X11),
       XFree(3X11), XSetCommand(3X11), XSetTransientForHint(3X11), XSet‐
       TextProperty(3X11), XSetWMClientMachine(3X11), XSetWMColormapWin‐
       dows(3X11), XSetWMIconName(3X11), XSetWMName(3X11), XSetWMProper‐
       ties(3X11), XSetWMProtocols(3X11), XStringListToTextProperty(3X11)
       Xlib - C Language X Interface

							   XAllocWMHints(3X11)
[top]

List of man pages available for Ultrix

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