NAME

XSetWMProperties, XmbSetWMProperties, Xutf8SetWMProperties - set standard window properties

SYNTAX

void XSetWMProperties(Display *_d_i_s_p_l_a_y, Window _w, XTextProperty *_w_i_n_d_o_w___n_a_m_e, XTextProperty *_i_c_o_n___n_a_m_e, char **_a_r_g_v, int _a_r_g_c, XSizeHints *_n_o_r_m_a_l___h_i_n_t_s, XWMHints *_w_m___h_i_n_t_s, XClassHint *_c_l_a_s_s___h_i_n_t_s); void XmbSetWMProperties(Display *_d_i_s_p_l_a_y, Window _w, char *_w_i_n_d_o_w___n_a_m_e, char *_i_c_o_n___n_a_m_e, char *_a_r_g_v[], int _a_r_g_c, XSizeHints *_n_o_r_m_a_l___h_i_n_t_s, XWMHints *_w_m___h_i_n_t_s, XClassHint *_c_l_a_s_s___h_i_n_t_s); void Xutf8SetWMProperties(Display *_d_i_s_p_l_a_y, Window _w, char *_w_i_n_d_o_w___n_a_m_e, char *_i_c_o_n___n_a_m_e, char *_a_r_g_v[], int _a_r_g_c, XSizeHints *_n_o_r_m_a_l___h_i_n_t_s, XWMHints *_w_m___h_i_n_t_s, XClassHint *_c_l_a_s_s___h_i_n_t_s);

ARGUMENTS

_a_r_g_c Specifies the number of arguments.
_a_r_g_v Specifies the application's argument list.
_c_l_a_s_s___h_i_n_t_s Specifies the
_X_C_l_a_s_s_H_i_n_t structure to be used.
_d_i_s_p_l_a_y Specifies the connection to the X server.
_i_c_o_n___n_a_m_e Specifies the icon name,
which should be a null-terminated string.
_n_o_r_m_a_l___h_i_n_t_s Specifies the size hints for the window in its normal state.
_w Specifies the window.
_w_i_n_d_o_w___n_a_m_e Specifies the window name,
which should be a null-terminated string.
_w_m___h_i_n_t_s Specifies the
_X_W_M_H_i_n_t_s structure to be used.

DESCRIPTION

The _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s convenience function provides a single programming interface for setting those essential window properties that are used for communicating with other clients (particularly window and session managers).

If the window_name argument is non-NULL, _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s calls _X_S_e_t_W_M_N_a_m_e, which in turn, sets the WM_NAME property (see section 14.1.4). If the icon_name argument is non-NULL, _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s calls _X_S_e_t_W_M_I_c_o_n_N_a_m_e, which sets the WM_ICON_NAME property (see section 14.1.5). If the argv argument is non-NULL, _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s calls _X_S_e_t_C_o_m_m_a_n_d, which sets the WM_COMMAND property (see section 14.2.1). Note that an argc of zero is allowed to indicate a zero-length command. Note also that the hostname of this machine is stored using _X_S_e_t_W_M_C_l_i_e_n_t_M_a_c_h_i_n_e (see section 14.2.2).

If the normal_hints argument is non-NULL, _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s calls _X_S_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s, which sets the WM_NORMAL_HINTS property (see section 14.1.7). If the wm_hints argument is non-NULL, _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s calls _X_S_e_t_W_M_H_i_n_t_s, which sets the WM_HINTS property (see section 14.1.6).

If the class_hints argument is non-NULL, _X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s calls _X_S_e_t_C_l_a_s_s_H_i_n_t, which sets the WM_CLASS property (see section 14.1.8). If the res_name member in the _X_C_l_a_s_s_H_i_n_t structure is set to the NULL pointer and the RESOURCE_NAME environment variable is set, then the value of the environment variable is substituted for res_name. If the res_name member is NULL, the environment variable is not set, and argv and argv[0] are set, then the value of argv[0], stripped of any directory prefixes, is substituted for res_name.

The _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s and _X_u_t_f_8_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s convenience functions provide a simple programming interface for setting those essential window properties that are used for communicating with other clients (particularly window and session managers).

If the window_name argument is non-NULL, they set the WM_NAME property. If the icon_name argument is non-NULL, they set the WM_ICON_NAME property. The window_name and icon_name arguments are null-terminated strings, for _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s in the encoding of the current locale, for _X_u_t_f_8_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s in UTF-8 encoding. If the arguments can be fully converted to the STRING encoding, the properties are created with type ``STRING''; otherwise, the arguments are converted to Compound Text, and the properties are created with type ``COMPOUND_TEXT''.

If the normal_hints argument is non-NULL, _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s and _X_u_t_f_8_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s call _X_S_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s, which sets the WM_NORMAL_HINTS property (see section 14.1.7). If the wm_hints argument is non-NULL, _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s and _X_u_t_f_8_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s call _X_S_e_t_W_M_H_i_n_t_s, which sets the WM_HINTS property (see section 14.1.6).

If the argv argument is non-NULL, _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s and _X_u_t_f_8_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s set the WM_COMMAND property from argv and argc. An argc of zero indicates a zero-length command.

The hostname of the machine is stored using _X_S_e_t_W_M_C_l_i_e_n_t_M_a_c_h_i_n_e (see section 14.2.2).

If the class_hints argument is non-NULL, _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s and _X_u_t_f_8_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s set the WM_CLASS property. If the res_name member in the _X_C_l_a_s_s_H_i_n_t structure is set to the NULL pointer and the RESOURCE_NAME environment variable is set, the value of the environment variable is substituted for res_name. If the res_name member is NULL, the environment variable is not set, and argv and argv[0] are set, then the value of argv[0], stripped of any directory prefixes, is substituted for res_name.

It is assumed that the supplied class_hints.res_name and argv, the RESOURCE_NAME environment variable, and the hostname of the machine are in the encoding of the current locale. The corresponding WM_CLASS, WM_COMMAND, and WM_CLIENT_MACHINE properties are typed according to the local host locale announcer. No encoding conversion is performed for these strings prior to storage in the properties.

For clients that need to process the property text in a locale, _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s and _X_u_t_f_8_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s set the WM_LOCALE_NAME property to be the name of the current locale. The name is assumed to be in the Host Portable Character Encoding and is converted to STRING for storage in the property.

_X_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s, _X_m_b_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s and _X_u_t_f_8_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s can generate _B_a_d_A_l_l_o_c and _B_a_d_W_i_n_d_o_w errors.

The function _X_u_t_f_8_S_e_t_W_M_P_r_o_p_e_r_t_i_e_s is an extension introduced by The XFree86 Project, Inc. in their 4.0.2 release. Its presence is indicated by the macro _X___H_A_V_E___U_T_F_8___S_T_R_I_N_G.

PROPERTIES

WM_CLASS
Set by application programs to allow window and session managers to obtain the application's resources from the resource database.
WM_CLIENT_MACHINE
The string name of the machine on which the client application is running.
WM_COMMAND
The command and arguments, null-separated, used to invoke the application.
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.
WM_ICON_NAME
The name to be used in an icon.
WM_NAME
The name of the application.
WM_NORMAL_HINTS
Size hints for a window in its normal state. The C type of this property is _X_S_i_z_e_H_i_n_t_s.

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), XAllocWMHints(3X11), XParseGeometry(3X11), XSetCommand(3X11), XSetTransientForHint(3X11), XSetTextProperty(3X11), XSetWMClientMachine(3X11), XSetWMColormapWindows(3X11), XSetWMIconName(3X11), XSetWMName(3X11), XSetWMProtocols(3X11), XStringListToTextProperty(3X11), XTextListToTextProperty(3X11)
_X_l_i_b _- _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e