1991. XAllocWMHints 3X11 XFree86 4.5.0 XLIB FUNCTIONS

NAME

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

SYNTAX

XWMHints *XAllocWMHints(void); int XSetWMHints(Display *_d_i_s_p_l_a_y, Window _w, XWMHints *_w_m_h_i_n_t_s); XWMHints *XGetWMHints(Display *_d_i_s_p_l_a_y, Window _w);

ARGUMENTS

_d_i_s_p_l_a_y Specifies the connection to the X server.
_w Specifies the window.
_w_m_h_i_n_t_s Specifies the
_X_W_M_H_i_n_t_s structure to be used.

DESCRIPTION

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

The _X_S_e_t_W_M_H_i_n_t_s 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.

_X_S_e_t_W_M_H_i_n_t_s can generate _B_a_d_A_l_l_o_c and _B_a_d_W_i_n_d_o_w errors.

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

_X_G_e_t_W_M_H_i_n_t_s can generate a _B_a_d_W_i_n_d_o_w error.

PROPERTIES

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

STRUCTURES

The _X_W_M_H_i_n_t_s structure contains:

/* Window manager hints mask bits */

lw(.5i) lw(2.5i) lw(2.5i).
T{
#define
T}      T{
_I_n_p_u_t_H_i_n_t
T}      T{
(1L << 0);
T}
T{
#define
T}      T{
_S_t_a_t_e_H_i_n_t
T}      T{
(1L << 1);
T}
T{
#define
T}      T{
_I_c_o_n_P_i_x_m_a_p_H_i_n_t
T}      T{
(1L << 2);
T}
T{
#define
T}      T{
_I_c_o_n_W_i_n_d_o_w_H_i_n_t
T}      T{
(1L << 3);
T}
T{
#define
T}      T{
_I_c_o_n_P_o_s_i_t_i_o_n_H_i_n_t
T}      T{
(1L << 4);
T}
T{
#define
T}      T{
_I_c_o_n_M_a_s_k_H_i_n_t
T}      T{
(1L << 5);
T}
T{
#define
T}      T{
_W_i_n_d_o_w_G_r_o_u_p_H_i_n_t
T}      T{
(1L << 6);
T}
T{
#define
T}      T{
_U_r_g_e_n_c_y_H_i_n_t
T}      T{
(1L << 8);
T}
T{
#define
T}      T{
_A_l_l_H_i_n_t_s
T}      T{
(InputHint|StateHint|IconPixmapHint|

IconWindowHint|IconPositionHint|
IconMaskHint|WindowGroupHint); T}

/* 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 _T_r_u_e. 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 _T_r_u_e. 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 _F_a_l_s_e. Applications that never expect any keyboard input also should set this member to _F_a_l_s_e.

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 _T_r_u_e. Push model window managers should make sure that pull model applications do not break them by resetting input focus to _P_o_i_n_t_e_r_R_o_o_t when it is appropriate (for example, whenever an application whose input member is _F_a_l_s_e sets input focus to one of its subwindows).

The definitions for the initial_state flag are:

lw(.5i) lw(2i) lw(.2i) lw(2.8i).
T{
#define
T}   T{
_W_i_t_h_d_r_a_w_n_S_t_a_t_e
T}   T{
0
T}   T{
T}
T{
#define
T}   T{
_N_o_r_m_a_l_S_t_a_t_e
T}   T{
1
T}   T{
/* most applications start this way */
T}
T{
#define
T}   T{
_I_c_o_n_i_c_S_t_a_t_e
T}   T{
3
T}   T{
/* application wants to start as an icon */
T}
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 _U_r_g_e_n_c_y_H_i_n_t 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.

DIAGNOSTICS

_B_a_d_A_l_l_o_c
The server failed to allocate the requested resource or server memory.
_B_a_d_W_i_n_d_o_w
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), XSetTextProperty(3X11), XSetWMClientMachine(3X11), XSetWMColormapWindows(3X11), XSetWMIconName(3X11), XSetWMName(3X11), XSetWMProperties(3X11), XSetWMProtocols(3X11), XStringListToTextProperty(3X11)
_X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e_, O'Reilly and Associates, Sebastopol, _<_/_b_o_d_y_> _<_/_h_t_m_l_>