XAllocWMHints, XSetWMHints, XGetWMHints, XWMHints − allocate window manager hints structure and set or read a window’s WM_HINTS property


XWMHints *XAllocWMHints(void);

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

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



Specifies the connection to the X server.


Specifies the window.


Specifies the XWMHints structure to be used.


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

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

XSetWMHints can generate BadAlloc and BadWindow errors.

The XGetWMHints 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 XWMHints structure if it succeeds. When finished with the data, free the space used for it by calling XFree.

XGetWMHints can generate a BadWindow error.



Additional hints set by the client for use by the window manager. The C type of this property is XWMHints.


The XWMHints structure contains:

/* Window manager hints mask bits */

/* 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 applications that use real-estate driven focus, should set this member to True. 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 True. 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 False. Applications that never expect any keyboard input also should set this member to False.

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

The definitions for the initial_state flag are:

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.

The UrgencyHint flag, if set in the flags field, indicates that the client deems the window contents to be urgent, requiring the timely response of the user. The window manager will make some effort to draw the user’s attention to this window while this flag is set. The client must provide some means by which the user can cause the urgency flag to be cleared (either mitigating the condition that made the window urgent or merely shutting off the alarm) or the window to be withdrawn.



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


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


XAllocClassHint(3), XAllocIconSize(3), XAllocSizeHints(3), XFree(3), XSetCommand(3), XSetTransientForHint(3), XSetTextProperty(3), XSetWMClientMachine(3), XSetWMColormapWindows(3), XSetWMIconName(3), XSetWMName(3), XSetWMProperties(3), XSetWMProtocols(3), XStringListToTextProperty(3)
Xlib − C Language X Interface,
O’Reilly and Associates, Sebastopol, 1991.

More Linux Commands

XUngrabDeviceButton(3) - grab/ungrab extension input device
The XGrabDeviceButton request establishes a passive grab. In the future, the device is actively grabbed (as for XGrabDevice, the last-grab time is set to the ti

glutJoystickFunc(3) - sets the joystick callback for the cur
glutJoystickFunc sets the joystick callback for the current window. The joystick callback is called either due to polling of the joystick at the uniform timer i

asinf(3) - arc sine function (Library - Linux man page).....
The asin() function calculates the principal value of the arc sine of x; that is the value whose sine is x. RETURN VALUE On success, these functions return the

glRasterPos2fv(3gl) - specify the raster position for pixel
The GL maintains a 3D position in window coordinates. This position, called the raster position, is used to position pixel and bitmap write operations. It is ma

mvinsch(3ncurses) - insert a character before cursor in a cu
These routines insert the character ch before the character under the cursor. All characters to the right of the cursor are moved one space to the right, with t

BlackPixelOfScreen(3) - screen information functions and mac
The BlackPixelOfScreen macro returns the black pixel value of the specified screen. The WhitePixelOfScreen macro returns the white pixel value of the specified

Date::Language::Hungarian(3pm) - Magyar format for Date::For
my $lang = Date::Language>new('Hungarian'); print $lang>time2str("%a %b %e %T %Y", time); @lt = localtime(time); print $lang>time2str($template, time); print

MB_CUR_MAX(3) - maximum length of a multibyte character in t
The MB_CUR_MAX macro defines an integer expression giving the maximum number of bytes needed to represent a single wide character in the current locale. It is l

format(n) - Format a string in the style of sprintf.........
This command generates a formatted string in a fashion similar to the ANSI C sprintf procedure. FormatString indicates how to format the result, using % convers

ip-mroute(8) multicast routing cache management (Man Page)
mroute objects are multicast routing cache entries created by a user-level mrouting daemon (f.e. pimd or mrouted ). Due to the limitations of the current interf

Tk_InternalBorderRight(3) - retrieve information from Tk's l
Tk_WindowId and the other names listed above are all macros that return fields from Tks local data structure for tkwin. None of these macros requires any intera

XAllocColor(3) - allocate and free colors - Linux man page
The XAllocColor function allocates a read-only colormap entry corresponding to the closest RGB value supported by the hardware. XAllocColor returns the pixel va

We can't live, work or learn in freedom unless the software we use is free.