


XAllocSizeHints(3X11)					XAllocSizeHints(3X11)
X11R5									X11R5



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(_d_i_s_p_l_a_y, _w, _h_i_n_t_s)
	Display	*_d_i_s_p_l_a_y;
	Window _w;
	XSizeHints *_h_i_n_t_s;

  Status XGetWMNormalHints(_d_i_s_p_l_a_y, _w, _h_i_n_t_s__r_e_t_u_r_n, _s_u_p_p_l_i_e_d__r_e_t_u_r_n)
	Display	*_d_i_s_p_l_a_y;
	Window _w;
	XSizeHints *_h_i_n_t_s__r_e_t_u_r_n;
	long *_s_u_p_p_l_i_e_d__r_e_t_u_r_n;

  void XSetWMSizeHints(_d_i_s_p_l_a_y,	_w, _h_i_n_t_s, _p_r_o_p_e_r_t_y)
	Display	*_d_i_s_p_l_a_y;
	Window _w;
	XSizeHints *_h_i_n_t_s;
	Atom _p_r_o_p_e_r_t_y;

  Status XGetWMSizeHints(_d_i_s_p_l_a_y, _w, _h_i_n_t_s__r_e_t_u_r_n, _s_u_p_p_l_i_e_d__r_e_t_u_r_n, _p_r_o_p_e_r_t_y)
	Display	*_d_i_s_p_l_a_y;
	Window _w;
	XSizeHints *_h_i_n_t_s__r_e_t_u_r_n;
	long *_s_u_p_p_l_i_e_d__r_e_t_u_r_n;
	Atom _p_r_o_p_e_r_t_y;

ARGUMENTS

  _d_i_s_p_l_a_y   Specifies the connection to	the X server.

  _h_i_n_t_s	    Specifies the size hints for the window in its normal state.

  _h_i_n_t_s	    Specifies the _X_S_i_z_e_H_i_n_t_s structure to be used.

  _h_i_n_t_s__r_e_t_u_r_n
	    Returns the	size hints for the window in its normal	state.

  _p_r_o_p_e_r_t_y  Specifies the property name.

  _s_u_p_p_l_i_e_d__r_e_t_u_r_n
	    Returns the	hints that were	supplied by the	user.

  _w	    Specifies the window.



DESCRIPTION
  The _X_A_l_l_o_c_S_i_z_e_H_i_n_t_s function allocates and returns a pointer to a
  _X_S_i_z_e_H_i_n_t_s structure.	 Note that all fields in the _X_S_i_z_e_H_i_n_t_s	structure are
  initially set	to zero.  If insufficient memory is available, _X_A_l_l_o_c_-
  _S_i_z_e_H_i_n_t_s returns NULL.  To free the memory allocated	to this	structure,
  use _X_F_r_e_e.

  The _X_S_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s	function replaces the size hints for the
  WM_NORMAL_HINTS property on the specified window.  If	the property does not
  already exist, _X_S_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s 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.

  _X_S_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s can	generate _B_a_d_A_l_l_o_c and _B_a_d_W_i_n_d_o_w	errors.

  The _X_G_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s	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, is of format 32, and is long enough to contain either
  an old (pre-ICCCM) or	new size hints structure, _X_G_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s sets the
  various fields of the	_X_S_i_z_e_H_i_n_t_s structure, sets the supplied_return argu-
  ment to the list of fields that were supplied	by the user (whether or	not
  they contained defined values), and returns a	nonzero	status.	 Otherwise,
  it returns a zero status.

  If _X_G_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s returns successfully and	a pre-ICCCM size hints pro-
  perty	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 follow-
  ing bits:

  PBaseSize|PWinGravity

  _X_G_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s can	generate a PN BadWindow	error.

  The _X_S_e_t_W_M_S_i_z_e_H_i_n_t_s function replaces	the size hints for the specified pro-
  perty	on the named window.  If the specified property	does not already
  exist, _X_S_e_t_W_M_S_i_z_e_H_i_n_t_s 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
  _X_S_e_t_W_M_N_o_r_m_a_l_H_i_n_t_s function.

  _X_S_e_t_W_M_S_i_z_e_H_i_n_t_s can generate _B_a_d_A_l_l_o_c, _B_a_d_A_t_o_m, and _B_a_d_W_i_n_d_o_w	errors.

  The _X_G_e_t_W_M_S_i_z_e_H_i_n_t_s function returns the size	hints stored in	the specified
  property on the named	window.	 If the	property is of type WM_SIZE_HINTS, is
  of format 32,	and is long enough to contain either an	old (pre-ICCCM)	or
  new size hints structure, _X_G_e_t_W_M_S_i_z_e_H_i_n_t_s sets the various fields of the
  _X_S_i_z_e_H_i_n_t_s 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 nonzero status.  Otherwise, it	returns	a
  zero status.	To get a window's normal size hints, you can use the _X_G_e_t_W_M_-
  _N_o_r_m_a_l_H_i_n_t_s function.

  If _X_G_e_t_W_M_S_i_z_e_H_i_n_t_s 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

  _X_G_e_t_W_M_S_i_z_e_H_i_n_t_s can generate _B_a_d_A_t_o_m and _B_a_d_W_i_n_d_o_w errors.

PROPERTIES

  WM_NORMAL_HINTS
	    Size hints for a window in its normal state.  The C	type of	this
	    property is	_X_S_i_z_e_H_i_n_t_s.

STRUCTURES
  The _X_S_i_z_e_H_i_n_t_s structure contains:

  /* Size hints	mask bits */ tab(); l l	l l.  #defineUSPosition(1L << 0)/*
  user specified x, y */ #defineUSSize(1L << 1)/* user specified width,
  height */ #definePPosition(1L	<< 2)/*	program	specified position */
  #definePSize(1L << 3)/* program specified size */ #definePMinSize(1L <<
  4)/* program specified minimum size */ #definePMaxSize(1L << 5)/* program
  specified maximum size */ #definePResizeInc(1L << 6)/* program specified
  resize increments */ #definePAspect(1L << 7)/* program specified min and
  max aspect ratios */ #definePBaseSize(1L << 8) #definePWinGravity(1L << 9)
  tab(); l l l l.  #definePAllHints(PPosition|PSize|PMinSize|
  PMaxSize|PResizeInc|PAspect)

  /* Values */

  typedef struct {
	  long flags;	  /* marks which fields	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	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	win-
  dow.	The window manager will	interpret the position of the window and its
  border width to position the point of	the outer rectangle of the overall
  window specified by the win_gravity member.  The outer rectangle of the
  window includes any borders or decorations supplied by the window manager.
  In other words, if the window	manager	decides	to place the window where the
  client asked,	the position on	the parent window's border named by the
  win_gravity will be placed where the client window would have	been placed
  in the absence of a window manager.

  Note that use	of the _P_A_l_l_H_i_n_t_s macro is highly discouraged.




DIAGNOSTICS

  _B_a_d_A_l_l_o_c  The	server failed to allocate the requested	resource or server
	    memory.

  _B_a_d_A_t_o_m   A value for	an Atom	argument does not name a defined Atom.

  _B_a_d_W_i_n_d_o_w 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),
  XSetTextProperty(3X11), XSetWMClientMachine(3X11),
  XSetWMColormapWindows(3X11), XSetWMIconName(3X11), XSetWMName(3X11),
  XSetWMProperties(3X11), XSetWMProtocols(3X11),
  XStringListToTextProperty(3X11)
  _X_l_i_b - _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e	delim off























































