XAllocSizeHints(3X) XAllocSizeHints(3X)NAME XAllocSizeHints, XSetWMNormalHints, XGetWMNormalHints, XSetWMSizeHints, XGetWMSizeHints, XSizeHints - allocate an XSizeHints structure and set and read a window's WM_NORMAL_HINTS property SYNOPSIS XSizeHints *XAllocSizeHints() void XSetWMNormalHints(display, w, hints) Display *display; Window w; XSizeHints *hints; Status XGetWMNormalHints(display, w, hints-return, supplied-return) Display *display; Window w; XSizeHints *hints-return; long *supplied-return; void XSetWMSizeHints(display, w, hints, property) Display *display; Window w; XSizeHints *hints; Atom property; Status XGetWMSizeHints(display, w, hints-return, supplied- return, property) Display *display; Window w; XSizeHints *hints-return; long *supplied-return; Atom property; DESCRIPTION The XAllocSizeHints function allocates and returns a pointer to a XSizeHints structure. Note that all members of the XSizeHints structure are initially set to 0. If insuffi- cient memory is available, XAllocSizeHints returns NULL. To free the memory allocated to this structure, use XFree. The XSetWMNormalHints function replaces the size hints for the WM_NORMAL_HINTS property on the specified window. If the property does not already exist, XSetWMNormalHints sets the size hints for the WM_NORMAL_HINTS property on the specified window. The property is stored with a type of WM_SIZE_HINTS and a format of 32. The XGetWMNormalHints function returns the size hints stored in the WM_NORMAL_HINTS property on the specified window. If the property is of type WM_SIZE_HINTS, of format 32, and is November, 1990 1
XAllocSizeHints(3X) XAllocSizeHints(3X)long enough to contain either an old (prior to Inter-Client Communications Conventions Manual (ICCCM)) or new size hints structure, XGetWMNormalHints sets the various members of the XSizeHints structure, sets supplied-return to the list of members that were supplied by the user (whether or not they contained defined values) and returns a nonzero status. Otherwise, it returns a 0 status. If XGetWMNormalHints returns successfully and a pre-ICCCM size hints property is read, supplied-return contains the following bits: (USPosition|USSize|PPosition|PSize|PMinSize| PMaxSize|PResizeInc|PAspect) If the property is large enough to contain the base size and window gravity members as well, supplied-return also con- tains the following bits: PBaseSize|PWinGravity The XSetWMSizeHints function replaces the size hints for the specified property on the named window. If the specified property does not already exist, XSetWMSizeHints sets the size hints for the specified property on the named window. The property is stored with a type of WM_SIZE_HINTS and a format of 32. To set a window's normal size hints, you can use the XSetWMNormalHints function. The XGetWMSizeHints function returns the size hints stored in the specified property on the named window. If the pro- perty is of type WM_SIZE_HINTS, of format 32, and is long enough to contain either an old (pre-ICCCM) or new size hints structure, XGetWMSizeHints sets the various members of the XSizeHints structure, sets supplied-return to the list of members that were supplied by the user (whether or not they contained defined values), and returns a nonzero status. Otherwise, it returns a 0 status. To get a window's normal size hints, you can use the XGetWMNor- malHints function. If XGetWMSizeHints returns successfully and a pre-ICCCM size hints property is read, supplied-return contains the follow- ing bits: (USPosition|USSize|PPosition|PSize|PMinSize| PMaxSize|PResizeInc|PAspect) If the property is large enough to contain the base size and window gravity members as well, supplied-return also con- 2 November, 1990
XAllocSizeHints(3X) XAllocSizeHints(3X)tains the following bits: PBaseSize|PWinGravity Arguments These functions accept the following arguments: display Specifies the connection to the X server. hints Specifies the size hints for the window in its nor- mal state. hints Specifies the XSizeHints structure to be used. hints-return Returns the size hints for the window in its normal state. property Specifies the property name. supplied-return Returns the hints that were supplied by the user. w Specifies the window. Properties These functions use the following property: WM_NORMAL_HINTS Specifies size hints for a window in its normal state. The C type of this property is XSizeHints. November, 1990 3
XAllocSizeHints(3X) XAllocSizeHints(3X)Structures The XSizeHints structure is defined as follows. /* Size hints mask bits */ #define USPosition (1L << 0)/* user specified */ /* x, y */ #define USSize (1L << 1)/* user specified */ /* width, height */ #define PPosition (1L << 2)/* program specified */ /* position */ #define PSize (1L << 3)/* program specified */ /* size */ #define PMinSize (1L << 4)/* program specified */ /* minimum size */ #define PMaxSize (1L << 5)/* program specified */ /* maximum size */ #define PResizeInc (1L << 6)/* program specified */ /* resize increments */ #define PAspect (1L << 7)/* program specified */ /* min and max aspect */ /* ratios */ #define PBaseSize (1L << 8) #define PWinGravity (1L << 9) #define PAllHints(PPosition|PSize|PMinSize| PMaxSize|PResizeInc|PAspect) /* Values */ typedef struct { long flags; /* marks which members in this */ /* structure are defined */ int x, y; /* Obsolete */ int width, height;/* Obsolete */ int min_width, min_height; int max_width, max_height; int width_inc, height_inc; struct { int x; /* numerator */ int y; /* denominator */ } min_aspect, max_aspect; int base_width, base_height; int win_gravity; } XSizeHints; The x, y, width, and height members are now obsolete and are left solely for compatibility reasons. The min_width and min_height members specify the minimum window size that still allows the application to be useful. The max_width and max_height members specify the maximum window size. The width_inc and height_inc members define an arithmetic pro- gression of sizes (minimum to maximum) into which the window prefers to be resized. The min_aspect and max_aspect members are expressed as ratios of x and y, and they allow an application to specify the range of aspect ratios it 4 November, 1990
XAllocSizeHints(3X) XAllocSizeHints(3X)prefers. The base_width and base_height members define the desired size of the window. The win_gravity member defines the region of the window that is to be retained when it is resized. Note that use of the PAllHints macro is highly discouraged. ERRORS BadAlloc The server failed to allocate the requested resource or server memory. BadAtom A value for an Atom argument does not name a defined Atom. BadWindow A value for a Window argument does not name a de- fined Window. The XGetWMNormalHints function can generate a B BadWindow error. The XGetWMSizeHints function can generate BadAtom and BadWindow errors. The XSetWMNormalHints function can generate BadAlloc and BadWindow errors. The XSetWMSizeHints function can generate BadAlloc, BadAtom, and BadWindow errors. SEE ALSO XAllocClassHint(3X), XAllocIconSize(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 InterfaceNovember, 1990 5