NAME

XAllocIconSize, XSetIconSizes, XGetIconSizes, XIconSize - allocate icon size structure and set or read a window's WM_ICON_SIZES property

SYNTAX

XIconSize *XAllocIconSize(void);

int XSetIconSizes(Display *_d_i_s_p_l_a_y, Window _w, XIconSize *_s_i_z_e___l_i_s_t, int _c_o_u_n_t);

Status XGetIconSizes(Display *_d_i_s_p_l_a_y, Window _w, XIconSize **_s_i_z_e___l_i_s_t___r_e_t_u_r_n, int _c_o_u_n_t___r_e_t_u_r_n);

ARGUMENTS

_d_i_s_p_l_a_y Specifies the connection to the X server.
_c_o_u_n_t Specifies the number of items in the size list.
_c_o_u_n_t___r_e_t_u_r_n Returns the number of items in the size list.
_s_i_z_e___l_i_s_t Specifies the size list.
_s_i_z_e___l_i_s_t___r_e_t_u_r_n Returns the size list.
_w Specifies the window.

DESCRIPTION

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

The _X_S_e_t_I_c_o_n_S_i_z_e_s function is used only by window managers to set the supported icon sizes.

_X_S_e_t_I_c_o_n_S_i_z_e_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_I_c_o_n_S_i_z_e_s function returns zero if a window manager has not set icon sizes; otherwise, it return nonzero. _X_G_e_t_I_c_o_n_S_i_z_e_s should be called by an application that wants to find out what icon sizes would be most appreciated by the window manager under which the application is running. The application should then use _X_S_e_t_W_M_H_i_n_t_s to supply the window manager with an icon pixmap or window in one of the supported sizes. To free the data allocated in size_list_return, use _X_F_r_e_e.

_X_G_e_t_I_c_o_n_S_i_z_e_s can generate a _B_a_d_W_i_n_d_o_w error.

PROPERTIES

WM_ICON_SIZES
The window manager may set this property on the root window to specify the icon sizes it supports. The C type of this property is _X_I_c_o_n_S_i_z_e.

STRUCTURES

The _X_I_c_o_n_S_i_z_e structure contains:


typedef struct {
     int min_width, min_height;
     int max_width, max_height;
     int width_inc, height_inc;
} XIconSize;


The width_inc and height_inc members define an arithmetic progression of sizes (minimum to maximum) that represent the supported icon sizes.

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), XAllocSizeHints(3X11), XAllocWMHints(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