Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
XAllocWMHints(3)		XLIB FUNCTIONS		      XAllocWMHints(3)

NAME
       XAllocWMHints, XSetWMHints, XGetWMHints,	XWMHints - allocate window
       manager hints structure and set or read a window's WM_HINTS property

SYNTAX
       XWMHints	*XAllocWMHints(void);

       int XSetWMHints(Display *display, Window	w, XWMHints *wmhints);

       XWMHints	*XGetWMHints(Display *display, Window w);

ARGUMENTS
       display	 Specifies the connection to the X server.

       w	 Specifies the window.

       wmhints	 Specifies the XWMHints	structure to be	used.

DESCRIPTION
       The XAllocWMHints function allocates and	returns	a pointer to a
       XWMHints	structure.  Note that all fields in the	XWMHints structure are
       initially set to	zero.  If insufficient memory is available, XAl-
       locWMHints returns NULL.	 To free the memory allocated to this struc-
       ture, use XFree.

       The XSetWMHints function	sets the window	manager	hints that include
       icon information	and location, the initial state	of the window, and
       whether the application relies on the window manager to get keyboard
       input.

       XSetWMHints can generate	BadAlloc and BadWindow errors.

       The XGetWMHints function	reads the window manager hints and returns
       NULL if no WM_HINTS property was	set on the window or returns a pointer
       to a XWMHints structure if it succeeds.	When finished with the data,
       free the	space used for it by calling XFree.

       XGetWMHints can generate	a BadWindow error.

PROPERTIES
       WM_HINTS	 Additional hints set by the client for	use by the window man-
		 ager.	The C type of this property is XWMHints.

STRUCTURES
       The XWMHints structure contains:

       /* Window manager hints mask bits */

       #de-    InputHint		   (1L << 0)
       fine
       #de-    StateHint		   (1L << 1)
       fine
       #de-    IconPixmapHint		   (1L << 2)
       fine
       #de-    IconWindowHint		   (1L << 3)
       fine
       #de-    IconPositionHint		   (1L << 4)
       fine
       #de-    IconMaskHint		   (1L << 5)
       fine

       #de-    WindowGroupHint		   (1L << 6)
       fine
       #de-    XUrgencyHint		   (1L << 8)
       fine
       #de-    AllHints			   (InputHint|State-
       fine				   Hint|IconPixmapHint|
					   IconWindowHint|IconPosi-
					   tionHint|
					   IconMaskHint|Window-
					   GroupHint)
       /* Values */

       typedef struct {
	       long flags;     /* marks	which fields in	this structure are defined */
	       Bool input;     /* does this application	rely on	the window manager to
			       get keyboard input? */
	       int initial_state;      /* see below */
	       Pixmap icon_pixmap;     /* pixmap to be used as icon */
	       Window icon_window;     /* window to be used as icon */
	       int icon_x, icon_y;     /* initial position of icon */
	       Pixmap icon_mask;       /* pixmap to be used as mask for	icon_pixmap */
	       XID window_group;       /* id of	related	window group */
	       /* this structure may be	extended in the	future */
       } XWMHints;

       The input member	is used	to communicate to the window manager the input
       focus model used	by the application.  Applications that expect input
       but never explicitly set	focus to any of	their subwindows (that is, use
       the push	model of focus management), such as X Version 10 style appli-
       cations that use	real-estate driven focus, should set this member to
       True.  Similarly, applications that set input focus to their subwindows
       only when it is given to	their top-level	window by a window manager
       should also set this member to True.  Applications that manage their
       own input focus by explicitly setting focus to one of their subwindows
       whenever	they want keyboard input (that is, use the pull	model of focus
       management) should set this member to False.  Applications that never
       expect any keyboard input also should set this member to	False.

       Pull model window managers should make it possible for push model ap-
       plications to get input by setting input	focus to the top-level windows
       of applications whose input member is True.  Push model window managers
       should make sure	that pull model	applications do	not break them by re-
       setting input focus to PointerRoot when it is appropriate (for example,
       whenever	an application whose input member is False sets	input focus to
       one of its subwindows).

       The definitions for the initial_state flag are:

       #de-    WithdrawnState	      0
       fine
       #de-    NormalState	      1	   /* most applications	start
       fine				   this	way */
       #de-    IconicState	      3	   /* application wants	to
       fine				   start as an icon */
       The icon_mask specifies which pixels of the icon_pixmap should be used
       as the icon.  This allows for nonrectangular icons.  Both icon_pixmap
       and icon_mask must be bitmaps.  The icon_window lets an application
       provide a window	for use	as an icon for window managers that support
       such use.  The window_group lets	you specify that this window belongs
       to a group of other windows.  For example, if a single application ma-
       nipulates multiple top-level windows, this allows you to	provide	enough
       information that	a window manager can iconify all of the	windows	rather
       than just the one window.

       The UrgencyHint flag, if	set in the flags field,	indicates that the
       client deems the	window contents	to be urgent, requiring	the timely re-
       sponse of the user.  The	window manager will make some effort to	draw
       the user's attention to this window while this flag is set.  The	client
       must provide some means by which	the user can cause the urgency flag to
       be cleared (either mitigating the condition that	made the window	urgent
       or merely shutting off the alarm) or the	window to be withdrawn.

DIAGNOSTICS
       BadAlloc	 The server failed to allocate the requested resource or
		 server	memory.

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

SEE ALSO
       XAllocClassHint(3), XAllocIconSize(3), XAllocSizeHints(3), XFree(3),
       XSetCommand(3), XSetTransientForHint(3),	XSetTextProperty(3), XSetWM-
       ClientMachine(3), XSetWMColormapWindows(3), XSetWMIconName(3), XSetWM-
       Name(3),	XSetWMProperties(3), XSetWMProtocols(3), XStringListTo-
       TextProperty(3)
       Xlib - C	Language X Interface, O'Reilly and Associates, Sebastopol,
       1991.

X Version 11			 libX11	1.6.5		      XAllocWMHints(3)

NAME | SYNTAX | ARGUMENTS | DESCRIPTION | PROPERTIES | STRUCTURES | DIAGNOSTICS | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=XAllocWMHints&sektion=3&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help