369 lines
7.4 KiB
Plaintext
369 lines
7.4 KiB
Plaintext
'\" t
|
|
.ds xT X Toolkit Intrinsics \- C Language Interface
|
|
.ds xW Athena X Widgets \- C Language X Toolkit Interface
|
|
.ds xL Xlib \- C Language X Interface
|
|
.ds xC Inter-Client Communication Conventions Manual
|
|
.na
|
|
.de Ds
|
|
.nf
|
|
.\\$1D \\$2 \\$1
|
|
.ft 1
|
|
.\".ps \\n(PS
|
|
.\".if \\n(VS>=40 .vs \\n(VSu
|
|
.\".if \\n(VS<=39 .vs \\n(VSp
|
|
..
|
|
.de De
|
|
.ce 0
|
|
.if \\n(BD .DF
|
|
.nr BD 0
|
|
.in \\n(OIu
|
|
.if \\n(TM .ls 2
|
|
.sp \\n(DDu
|
|
.fi
|
|
..
|
|
.de FD
|
|
.LP
|
|
.KS
|
|
.TA .5i 3i
|
|
.ta .5i 3i
|
|
.nf
|
|
..
|
|
.de FN
|
|
.fi
|
|
.KE
|
|
.LP
|
|
..
|
|
.de IN \" send an index entry to the stderr
|
|
..
|
|
.de C{
|
|
.KS
|
|
.nf
|
|
.D
|
|
.\"
|
|
.\" choose appropriate monospace font
|
|
.\" the imagen conditional, 480,
|
|
.\" may be changed to L if LB is too
|
|
.\" heavy for your eyes...
|
|
.\"
|
|
.ie "\\*(.T"480" .ft L
|
|
.el .ie "\\*(.T"300" .ft L
|
|
.el .ie "\\*(.T"202" .ft PO
|
|
.el .ie "\\*(.T"aps" .ft CW
|
|
.el .ft R
|
|
.ps \\n(PS
|
|
.ie \\n(VS>40 .vs \\n(VSu
|
|
.el .vs \\n(VSp
|
|
..
|
|
.de C}
|
|
.DE
|
|
.R
|
|
..
|
|
.de Pn
|
|
.ie t \\$1\fB\^\\$2\^\fR\\$3
|
|
.el \\$1\fI\^\\$2\^\fP\\$3
|
|
..
|
|
.de ZN
|
|
.ie t \fB\^\\$1\^\fR\\$2
|
|
.el \fI\^\\$1\^\fP\\$2
|
|
..
|
|
.de NT
|
|
.ne 7
|
|
.ds NO Note
|
|
.if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
|
|
.if \\n(.$ .if !'\\$1'C' .ds NO \\$1
|
|
.ie n .sp
|
|
.el .sp 10p
|
|
.TB
|
|
.ce
|
|
\\*(NO
|
|
.ie n .sp
|
|
.el .sp 5p
|
|
.if '\\$1'C' .ce 99
|
|
.if '\\$2'C' .ce 99
|
|
.in +5n
|
|
.ll -5n
|
|
.R
|
|
..
|
|
. \" Note End -- doug kraft 3/85
|
|
.de NE
|
|
.ce 0
|
|
.in -5n
|
|
.ll +5n
|
|
.ie n .sp
|
|
.el .sp 10p
|
|
..
|
|
.ny0
|
|
'\" t
|
|
.TH XAllocWMHints 3X11 "Release 5" "X Version 11" "XLIB FUNCTIONS"
|
|
.SH NAME
|
|
XAllocWMHints, XSetWMHints, XGetWMHints, XWMHints \- allocate window manager hints structure and set or read a window's WM_HINTS property
|
|
.SH SYNTAX
|
|
XWMHints *XAllocWMHints\^(\|)
|
|
.LP
|
|
XSetWMHints\^(\^\fIdisplay\fP, \fIw\fP, \fIwmhints\fP\^)
|
|
.br
|
|
Display *\fIdisplay\fP\^;
|
|
.br
|
|
Window \fIw\fP\^;
|
|
.br
|
|
XWMHints *\fIwmhints\fP\^;
|
|
|
|
.LP
|
|
XWMHints *XGetWMHints\^(\^\fIdisplay\fP, \fIw\fP\^)
|
|
.br
|
|
Display *\fIdisplay\fP\^;
|
|
.br
|
|
Window \fIw\fP\^;
|
|
.SH ARGUMENTS
|
|
.\" $Header: display.a,v 1.1 88/02/26 10:26:29 mento Exp $
|
|
.IP \fIdisplay\fP 1i
|
|
Specifies the connection to the X server.
|
|
.\" $Header: w.a,v 1.2 88/05/07 11:35:31 mento Exp $
|
|
.IP \fIw\fP 1i
|
|
Specifies the window.
|
|
.IP \fIwmhints\fP 1i
|
|
Specifies the
|
|
.ZN XWMHints
|
|
structure to be used.
|
|
.SH DESCRIPTION
|
|
The
|
|
.ZN XAllocWMHints
|
|
function allocates and returns a pointer to a
|
|
.ZN XWMHints
|
|
structure.
|
|
Note that all fields in the
|
|
.ZN XWMHints
|
|
structure are initially set to zero.
|
|
If insufficient memory is available,
|
|
.ZN XAllocWMHints
|
|
returns NULL.
|
|
To free the memory allocated to this structure,
|
|
use
|
|
.ZN XFree .
|
|
.LP
|
|
.\" $Header: XSetWMHnts.d,v 1.1 88/02/26 10:51:06 mento Exp $
|
|
The
|
|
.ZN 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.
|
|
.LP
|
|
.ZN XSetWMHints
|
|
can generate
|
|
.ZN BadAlloc
|
|
and
|
|
.ZN BadWindow
|
|
errors.
|
|
.LP
|
|
.\" $Header: XGetWMHnts.d,v 1.5 88/06/11 07:51:30 mento Exp $
|
|
The
|
|
.ZN 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
|
|
.ZN XWMHints
|
|
structure if it succeeds.
|
|
When finished with the data,
|
|
free the space used for it by calling
|
|
.ZN XFree .
|
|
.LP
|
|
.ZN XGetWMHints
|
|
can generate a
|
|
.ZN BadWindow
|
|
error.
|
|
.SH PROPERTIES
|
|
.TP 1i
|
|
\s-1WM_HINTS\s+1
|
|
Additional hints set by the client for use by the window manager.
|
|
The C type of this property is
|
|
.ZN XWMHints .
|
|
.SH STRUCTURES
|
|
The
|
|
.ZN XWMHints
|
|
structure contains:
|
|
.LP
|
|
/* Window manager hints mask bits */
|
|
.TS
|
|
lw(.5i) lw(2.5i) lw(2.5i).
|
|
T{
|
|
#define
|
|
T} T{
|
|
.ZN InputHint
|
|
T} T{
|
|
(1L << 0)
|
|
T}
|
|
T{
|
|
#define
|
|
T} T{
|
|
.ZN StateHint
|
|
T} T{
|
|
(1L << 1)
|
|
T}
|
|
T{
|
|
#define
|
|
T} T{
|
|
.ZN IconPixmapHint
|
|
T} T{
|
|
(1L << 2)
|
|
T}
|
|
T{
|
|
#define
|
|
T} T{
|
|
.ZN IconWindowHint
|
|
T} T{
|
|
(1L << 3)
|
|
T}
|
|
T{
|
|
#define
|
|
T} T{
|
|
.ZN IconPositionHint
|
|
T} T{
|
|
(1L << 4)
|
|
T}
|
|
T{
|
|
#define
|
|
T} T{
|
|
.ZN IconMaskHint
|
|
T} T{
|
|
(1L << 5)
|
|
T}
|
|
T{
|
|
#define
|
|
T} T{
|
|
.ZN WindowGroupHint
|
|
T} T{
|
|
(1L << 6)
|
|
T}
|
|
T{
|
|
#define
|
|
T} T{
|
|
.ZN AllHints
|
|
T} T{
|
|
(InputHint|StateHint|IconPixmapHint|
|
|
.br
|
|
IconWindowHint|IconPositionHint|
|
|
.br
|
|
IconMaskHint|WindowGroupHint)
|
|
T}
|
|
.TE
|
|
.IN "XWMHints" "" "@DEF@"
|
|
.Ds 0
|
|
.TA .5i 2.5i
|
|
.ta .5i 2.5i
|
|
/* 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;
|
|
.De
|
|
.LP
|
|
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 applications that use real-estate
|
|
driven focus, should set this member to
|
|
.ZN 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
|
|
.ZN 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
|
|
.ZN False .
|
|
Applications that never expect any keyboard input also should set this member
|
|
to
|
|
.ZN False .
|
|
.LP
|
|
Pull model window managers should make it possible for push model
|
|
applications to get input by setting input focus to the top-level windows of
|
|
applications whose input member is
|
|
.ZN True .
|
|
Push model window managers should
|
|
make sure that pull model applications do not break them
|
|
by resetting input focus to
|
|
.ZN PointerRoot
|
|
when it is appropriate (for example, whenever an application whose
|
|
input member is
|
|
.ZN False
|
|
sets input focus to one of its subwindows).
|
|
.LP
|
|
The definitions for the initial_state flag are:
|
|
.TS
|
|
lw(.5i) lw(2i) lw(.2i) lw(2.8i).
|
|
T{
|
|
#define
|
|
T} T{
|
|
.ZN WithdrawnState
|
|
T} T{
|
|
0
|
|
T} T{
|
|
T}
|
|
T{
|
|
#define
|
|
T} T{
|
|
.ZN NormalState
|
|
T} T{
|
|
1
|
|
T} T{
|
|
/* most applications start this way */
|
|
T}
|
|
T{
|
|
#define
|
|
T} T{
|
|
.ZN IconicState
|
|
T} T{
|
|
3
|
|
T} T{
|
|
/* application wants to start as an icon */
|
|
T}
|
|
.TE
|
|
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 manipulates 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.
|
|
.SH DIAGNOSTICS
|
|
.\" $Header: badalloc.e,v 1.3 87/09/11 11:17:14 mento Exp $
|
|
.TP 1i
|
|
.ZN BadAlloc
|
|
The server failed to allocate the requested resource or server memory.
|
|
.\" $Header: badwindow.e,v 1.1 87/09/04 08:23:20 mento Exp $
|
|
.TP 1i
|
|
.ZN BadWindow
|
|
A value for a Window argument does not name a defined Window.
|
|
.SH "SEE ALSO"
|
|
XAllocClassHint(3X11),
|
|
XAllocIconSize(3X11),
|
|
XAllocSizeHints(3X11),
|
|
XFree(3X11),
|
|
XSetCommand(3X11),
|
|
XSetTransientForHint(3X11),
|
|
XSetTextProperty(3X11),
|
|
XSetWMClientMachine(3X11),
|
|
XSetWMColormapWindows(3X11),
|
|
XSetWMIconName(3X11),
|
|
XSetWMName(3X11),
|
|
XSetWMProperties(3X11),
|
|
XSetWMProtocols(3X11),
|
|
XStringListToTextProperty(3X11)
|
|
.br
|
|
\fI\*(xL\fP
|