NAME

XGetIconSizes − get preferred icon sizes. 

Synopsis

Status XGetIconSizes(display, w, size_list_return, count_return)
Display *display;
Window w;
XIconSize **size_list_return;
int *count_return;

Arguments

displaySpecifies a connection to an X server; returned from XOpenDisplay(). 

wSpecifies the window ID (usually of the root window). 

size_list_return
Returns a pointer to the size list.

count_return
Returns the number of items in the size list.

Description

XGetIconSizes() reads the XA_WM_ICON_SIZE property that should be set by the window manager to specify its desired icon sizes.  XGetIconSizes() returns a Status of zero if a window manager has not set icon sizes, and a nonzero Status otherwise.  This function should be called by all programs to find out what icon sizes are preferred by the window manager.  The application should then use XSetWMHints() 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 XFree().  For more information, see Volume One, Chapter 10, Interclient Communication. 

Structures

typedef struct {
int min_width, min_height;
int max_width, max_height;
int width_inc, height_inc;
} XIconSize;
 /* width_inc and height_inc provide the preferred
 * increment of sizes in the range from min_width
 * to max_width and min_height to max_height. */

Errors

BadWindow

See Also

XAllocIconSize(), XGetClassHint(), XGetNormalHints(), XGetSizeHints(), XGetTransientForHint(), XGetWMHints(), XGetZoomHints(), XSetClassHint(), XSetCommand(), XSetIconSizes(), XSetNormalHints(), XSetSizeHints(), XSetTransientForHint(), XSetWMHints(), XSetZoomHints(),

Copyright O’Reilly & Assoc.  —