XIconSize(3)

1XAllocIconSize(3)               XLIB FUNCTIONS               XAllocIconSize(3)
2
3
4

NAME

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

SYNTAX

10       XIconSize *XAllocIconSize(void);
11
12       int XSetIconSizes(Display *display, Window w, XIconSize *size_list, int
13       count);
14
15       Status    XGetIconSizes(Display    *display,    Window   w,   XIconSize
16       **size_list_return, int *count_return);
17

ARGUMENTS

19       display   Specifies the connection to the X server.
20
21       count     Specifies the number of items in the size list.
22
23       count_return
24                 Returns the number of items in the size list.
25
26       size_list Specifies the size list.
27
28       size_list_return
29                 Returns the size list.
30
31       w         Specifies the window.
32

DESCRIPTION

34       The XAllocIconSize function allocates and returns a pointer to a XIcon‐
35       Size  structure.   Note  that all fields in the XIconSize structure are
36       initially set to zero.  If insufficient memory is  available,  XAllocI‐
37       conSize  returns NULL.  To free the memory allocated to this structure,
38       use XFree.
39
40       The XSetIconSizes function is used only by window managers to  set  the
41       supported icon sizes.
42
43       XSetIconSizes can generate BadAlloc and BadWindow errors.
44
45       The XGetIconSizes function returns zero if a window manager has not set
46       icon sizes; otherwise, it  return  nonzero.   XGetIconSizes  should  be
47       called  by  an application that wants to find out what icon sizes would
48       be most appreciated by the window manager under which  the  application
49       is  running.  The application should then use XSetWMHints to supply the
50       window manager with an icon pixmap or window in one  of  the  supported
51       sizes.  To free the data allocated in size_list_return, use XFree.
52
53       XGetIconSizes can generate a BadWindow error.
54

PROPERTIES

56       WM_ICON_SIZES
57                 The  window  manager may set this property on the root window
58                 to specify the icon sizes it supports.  The C  type  of  this
59                 property is XIconSize.
60

STRUCTURES

62       The XIconSize structure contains:
63
64       typedef struct {
65               int min_width, min_height;
66               int max_width, max_height;
67               int width_inc, height_inc;
68       } XIconSize;
69
70       The  width_inc  and height_inc members define an arithmetic progression
71       of sizes (minimum to maximum) that represent the supported icon sizes.
72

DIAGNOSTICS

74       BadAlloc  The server failed  to  allocate  the  requested  resource  or
75                 server memory.
76
77       BadWindow A value for a Window argument does not name a defined Window.
78