xref: /386bsd/usr/X386/man/man3/XAllocIconSize.3x (revision a2142627)
.\\$1D \\$2 \\$1
.ps \\n(PS
.if \\n(VS>=40 .vs \\n(VSu
.if \\n(VS<=39 .vs \\n(VSp
..

0 .nr BD 0

..

.KS .TA .5i 3i

..
.KE

.. .. .KS

.D

choose appropriate monospace font
the imagen conditional, 480,
may be changed to L if LB is too
heavy for your eyes...

.. .R .. .. .. .TB

\\*(NO .R .. . \" Note End -- doug kraft 3/85

0 .. .ny0

XAllocIconSize 3X11 "Release 5" "X Version 11" "XLIB FUNCTIONS"
NAME
XAllocIconSize, XSetIconSizes, XGetIconSizes, XIconSize - allocate icon size structure and set or read a window's WM_ICON_SIZES property
SYNTAX
XIconSize *XAllocIconSize\^(\|)

XSetIconSizes\^(\^display, w, size_list, count\^)

Display *display\^;

Window w\^;

XIconSize *size_list\^;

int count\^;

Status XGetIconSizes\^(\^display, w, size_list_return, count_return\^)

Display *display\^;

Window w\^;

XIconSize **size_list_return\^;

int *count_return\^;

ARGUMENTS
$Header: display.a,v 1.1 88/02/26 10:26:29 mento Exp $
display 1i
Specifies the connection to the X server.
count 1i
Specifies the number of items in the size list.
count_return 1i
Returns the number of items in the size list.
size_list 1i
Specifies the size list.
size_list_return 1i
Returns the size list. $Header: w.a,v 1.2 88/05/07 11:35:31 mento Exp $
w 1i
Specifies the window.
DESCRIPTION
The .ZN XAllocIconSize function allocates and returns a pointer to a .ZN XIconSize structure. Note that all fields in the .ZN XIconSize structure are initially set to zero. If insufficient memory is available, .ZN XAllocIconSize returns NULL. To free the memory allocated to this structure, use .ZN XFree .

$Header: XSetISizes.d,v 1.2 88/06/11 07:53:16 mento Exp $
The .ZN XSetIconSizes function is used only by window managers to set the supported icon sizes.

.ZN XSetIconSizes can generate .ZN BadAlloc and .ZN BadWindow errors.

$Header: XGetISizes.d,v 1.2 88/06/11 07:51:07 mento Exp $
The .ZN XGetIconSizes function returns zero if a window manager has not set icon sizes; otherwise, it return nonzero. .ZN 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 .ZN 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 .ZN XFree .

.ZN XGetIconSizes can generate a .ZN BadWindow error.

PROPERTIES

1i \s-1WM_ICON_SIZES\s+1 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 .ZN XIconSize .

STRUCTURES
The .ZN XIconSize structure contains:

N "XIconSize" "" "@DEF@" .Ds 0 .TA .5i 2.5i typedef struct { int min_width, min_height; int max_width, max_height; int width_inc, height_inc; } XIconSize; .De

The width_inc and height_inc members define an arithmetic progression of sizes (minimum to maximum) that represent the supported icon sizes.

DIAGNOSTICS
$Header: badalloc.e,v 1.3 87/09/11 11:17:14 mento Exp $

1i .ZN BadAlloc The server failed to allocate the requested resource or server memory. $Header: badwindow.e,v 1.1 87/09/04 08:23:20 mento Exp $

1i .ZN 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)

\*(xL