XGetSizeHin(3x) — HP-UX ANSI C A.09.00

NAME

XGetSizeHints − read any property of type XA_WM_SIZE_HINTS.

Synopsis

Status XGetSizeHints(display, w, hints_return, property)
Display *display;
Window w;
XSizeHints *hints_return;
Atom property;

Arguments

displaySpecifies a connection to an X server; returned from XOpenDisplay().

wSpecifies the ID of the window for which size hints will be returned.

hints_return
Returns the size hints structure.

propertySpecifies a property atom of type XA_WM_SIZE_HINTS. May be XA_WM_NORMAL_HINTS, XA_WM_ZOOM_HINTS (in Release 3), or a property defined by an application.

Description

XGetSizeHints() has been superseded by XGetWMSizeHints() as of Release 4, because the interclient communication conventions are now standard. XGetSizeHints() returns the XSizeHints structure for the named property and the specified window. XGetSizeHints() is used by XGetNormalHints() and XGetZoomHints(), and can be used to retrieve the value of any property of type XA_WM_SIZE_HINTS; thus, it is useful if other properties of that type get defined. This function is used almost exclusively by window managers. XGetSizeHints() returns a nonzero Status if a size hint was defined, and zero otherwise. For more information on using hints, see Volume One, Chapter 10, Interclient Communication.

Structures

typedef struct {
long flags;/* which fields in structure are defined */
int x, y;
int width, height;
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;
/* flags argument in size hints */
#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/max aspect ratios */
#define PAllHints (PPosition|PSize|PMinSize|PMaxSize|PResizeInc|PAspect)
#define PBaseSize(1L << 8)
#define PWinGravity(1L << 9)

Errors

BadAtom
BadWindow