XLIB FUNCTIONS XAllocIconSize(3x11)
NAME
XAllocIconSize, XSetIconSizes, XGetIconSizes, XIconSize -
allocate icon size structure and set or read a window'sWM_ICON_SIZES property
SYNTAXcc [ flag... ] file... -lX11 [ library... ]
XIconSize *XAllocIconSize(void);
int XSetIconSizes(Display *display, Window w, XIconSize
*size_list, int count);
Status XGetIconSizes(Display *display, Window w, XIconSize
**size_list_return, int count_return);
ARGUMENTS display Specifies the connection to the X server. count Specifies the number of items in the size list.count_return
Returns the number of items in the size list.size_list Specifies the size list.
size_list_return
Returns the size list. w Specifies the window.DESCRIPTION
The XAllocIconSize function allocates and returns a pointerto a XIconSize structure. Note that all fields in the
XIconSize structure are initially set to zero. If insuffi-
cient memory is available, XAllocIconSize returns NULL. To free the memory allocated to this structure, use XFree. The XSetIconSizes function is used only by window managers to set the supported icon sizes. XSetIconSizes can generate BadAlloc and BadWindow errors. The XGetIconSizes function returns zero if a window managerhas not set icon sizes; otherwise, it return nonzero. XGet-
IconSizes 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 XSetWMHints to supply the windowmanager with an icon pixmap or window in one of the sup-
ported sizes. To free the data allocated insize_list_return, use XFree.
X Version 11 Last change: libX11 1.3.5 1 XLIB FUNCTIONS XAllocIconSize(3x11) XGetIconSizes can generate a BadWindow error. PROPERTIESWM_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 XIconSize.
STRUCTURESThe XIconSize 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 BadAlloc The server failed to allocate the requested resource or server memory. BadWindow 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)Xlib - C Language X Interface
ATTRIBUTES
See attributes(5) for descriptions of the following attri-
butes: X Version 11 Last change: libX11 1.3.5 2 XLIB FUNCTIONS XAllocIconSize(3x11)____________________________________________________________
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
|_____________________________|_____________________________|
| Availability | x11/library/libx11 ||_____________________________|_____________________________|
| Interface Stability | Committed ||_____________________________|_____________________________|
| MT-Level | See XInitThreads(3X11) |
|_____________________________|_____________________________|
X Version 11 Last change: libX11 1.3.5 3