MirBSD manpage: XAllocIconSize(3), XGetIconSizes(3), XIconSize(3), XSetIconSizes(3)

XAllocIconSize(3X11)     XLIB FUNCTIONS      XAllocIconSize(3X11)


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


     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);


     display   Specifies the connection to the X server.

     count     Specifies the number of items in the size list.

               Returns the number of items in the size list.

     size_list Specifies the size list.

               Returns the size list.

     w         Specifies the window.


     The XAllocIconSize function allocates and returns a pointer
     to a XIconSize structure. Note that all fields in the XIcon-
     Size structure are initially set to zero. 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.

     XSetIconSizes can generate BadAlloc and BadWindow errors.

     The XGetIconSizes function returns zero if a window manager
     has 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 window
     manager with an icon pixmap or window in one of the sup-
     ported sizes. To free the data allocated in
     size_list_return, use XFree.

XFree86                   Version 4.5.0                         1

XAllocIconSize(3X11)     XLIB FUNCTIONS      XAllocIconSize(3X11)

     XGetIconSizes can generate a BadWindow error.


               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.


     The 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.


     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.


     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),
     Xlib - C Language X Interface

XFree86                   Version 4.5.0                         2

Generated on 2021-12-07 11:07:08 by $MirOS: src/scripts/roff2htm,v 1.103 2021/01/23 20:24:35 tg Exp $ — This product includes material provided by mirabilos.

These manual pages and other documentation are copyrighted by their respective writers; their sources are available at the project’s CVSweb, AnonCVS and other mirrors. The rest is Copyright © 2002–2021 MirBSD.

This manual page’s HTML representation is supposed to be valid XHTML/1.1; if not, please send a bug report — diffs preferred.