XAllocIconSize(3X)                             XAllocIconSize(3X)



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

SYNOPSIS
     XIconSize *XAllocIconSize()

     XSetIconSizes(display, w, size-list, count)
     Display *display;
     Window w;
     XIconSize *size-list;
     intcount;

     Status XGetIconSizes(display, w, size-list-return, count-
     return)
     Display *display;
     Window w;
     XIconSize **size-list-return;
     int *count-return;

DESCRIPTION
     The XAllocIconSize function allocates and returns a pointer
     to a XIconSize structure.  Note that all members of the
     XIconSize structure are initially set to 0.  If insufficient
     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.

     The XGetIconSizes function returns zero if a window manager
     has not set icon sizes or nonzero otherwise.
     XGetIconSizes 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 window
     manager with an icon pixel map or window in one of the sup-
     ported sizes.  To free the data allocated in size_list-
     return, use XFree.

   Arguments
     These functions accept the following 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



November, 1990                                                  1

XAllocIconSize(3X)                             XAllocIconSize(3X)



             Specifies a pointer to the size list.

     size-list-return
             Returns a pointer to the size list.

     w       Specifies the window.

   Propterties
     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 XIconSize.

   Structures
     The XIconSize structure is defined as follows.

     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.

ERRORS
     BadAlloc
             The server failed to allocate the requested resource
             or server memory.

     BadWindow
             A value for a Window argument does not name a de-
             fined Window.

     The XGetIconSizes function can generate a BadWindow error.

     The XSetIconSizes function can generate BadAlloc and BadWin-
     dow errors.

SEE ALSO
     XAllocClassHint(3X), XAllocSizeHints(3X), XAllocWMHints(3X),
     XFree(3X), XSetCommand(3X), XSetTransientForHint(3X),
     XSetTextProperty(3X), XSetWMClientMachine(3X),
     XSetWMColormapWindows(3X), XSetWMIconName(3X),
     XSetWMName(3X), XSetWMProperties(3X), XSetWMProtocols(3X),
     XStringListToTextProperty(3X)

     Xlib - C Language Interface







2                                                  November, 1990