ultrix man page for xgetwmnormalhints

XAllocSizeHints(3X11)						     MIT X11R4						     XAllocSizeHints(3X11)

Name
       XAllocSizeHints, XSetWMNormalHints, XGetWMNormalHints, XSetWMSizeHints, XGetWMSizeHints, XSizeHints - allocate size hints structure and set
       or read a window's WM_NORMAL_HINTS property

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

Arguments
       display	 Specifies the connection to the X server.

       hints	 Specifies the size hints for the window in its normal state.

       hints	 Specifies the 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.

Description
       The function allocates and returns a pointer to a structure.  Note that all fields in the structure are initially set to zero.  If insuffi-
       cient memory is available, returns NULL.  To free the memory allocated to this structure, use

       The function replaces the size hints for the WM_NORMAL_HINTS property on the specified window.  If the property does not already exist,
       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.

       can generate and errors.

       The 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 long enough to contain either an old (pre-ICCCM) or new size hints structure, sets the various fields
       of the structure, sets the supplied_return argument to the list of fields that were supplied by the user (whether or not they contained
       defined values) and returns a non-zero status.  Otherwise, it returns a zero status.

       If returns successfully and a pre-ICCCM size hints property is read, the supplied_return argument will contain 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 fields as well, the supplied_return argument will also contain
       the following bits:

       PBaseSize|PWinGravity

       can generate a error.

       The function replaces the size hints for the specified property on the named window.  If the specified property does not already exist,
       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 function.

       can generate and errors.

       The function returns the size hints stored in the specified property on the named window.  If the property 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, sets the various fields of the structure,
       sets the supplied_return argument to the list of fields that were supplied by the user (whether or not they contained defined values), and
       returns a non-zero status.  Otherwise, it returns a zero status.  To get a window's normal size hints, you can use the function.

       If returns successfully and a pre-ICCCM size hints property is read, the supplied_return argument will contain 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 fields as well, the supplied_return argument will also contain
       the following bits:

       PBaseSize|PWinGravity

       can generate and errors.

Properties
       WM_NORMAL_HINTS
		 Size hints for a window in its normal state.  The C type of this property is

Structures
       The structure contains:

       /* 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		   (PPosi-
					   tion|PSize|PMinSize|
					   PMaxSize|PRe-
					   sizeInc|PAspect)

       /* Values */

       typedef struct {
	    long flags; 	/* marks which structure fields
				    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 progression 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 prefers.  The base_width and base_height members define the desired size of the window.  The win_gravity mem-
       ber defines the region of the window that is to be retained when it is resized.

       Note that use of the macro is highly discouraged.

Diagnostics
       The server failed to allocate the requested resource or server memory.

       A value for an Atom argument does not name a defined Atom.

       A value for a Window argument does not name a defined Window.

See Also
       XAllocClassHint(3X11), XAllocIconSize(3X11), XAllocWMHints(3X11), XFree(3X11), XSetCommand(3X11), XSetTransientForHint(3X11), XSetTextProp-
       erty(3X11), XSetWMClientMachine(3X11), XSetWMColormapWindows(3X11), XSetWMIconName(3X11), XSetWMName(3X11), XSetWMProperties(3X11), XSetWM-
       Protocols(3X11), XStringListToTextProperty(3X11)
       X Window System: The Complete Reference, Second Edition, Robert W. Scheifler and James Gettys

															     XAllocSizeHints(3X11)