280 lines
6.7 KiB
Plaintext
280 lines
6.7 KiB
Plaintext
.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
|
|
.TH XGrabKey 3X11 "Release 5" "X Version 11" "XLIB FUNCTIONS"
|
|
.SH NAME
|
|
XGrabKey, XUngrabKey \- grab keyboard keys
|
|
.SH SYNTAX
|
|
.\" $Header: XGrabKey.f,v 1.1 88/02/26 10:01:04 mento Exp $
|
|
XGrabKey\^(\^\fIdisplay\fP, \fIkeycode\fP\^, \fImodifiers\fP\^, \fIgrab_window\fP\^, \fIowner_events\fP\^, \fIpointer_mode\fP\^,
|
|
.br
|
|
\fIkeyboard_mode\fP\^)
|
|
.br
|
|
Display *\fIdisplay\fP\^;
|
|
.br
|
|
int \fIkeycode\fP\^;
|
|
.br
|
|
unsigned int \fImodifiers\fP\^;
|
|
.br
|
|
Window \fIgrab_window\fP\^;
|
|
.br
|
|
Bool \fIowner_events\fP\^;
|
|
.br
|
|
int \fIpointer_mode\fP\^, \fIkeyboard_mode\fP\^;
|
|
.LP
|
|
.\" $Header: XUngrabKey.f,v 1.2 88/05/14 08:28:06 mento Exp $
|
|
XUngrabKey\^(\^\fIdisplay\fP, \fIkeycode\fP\^, \fImodifiers\fP\^, \fIgrab_window\fP\^)
|
|
.br
|
|
Display *\fIdisplay\fP\^;
|
|
.br
|
|
int \fIkeycode\fP\^;
|
|
.br
|
|
unsigned int \fImodifiers\fP\^;
|
|
.br
|
|
Window \fIgrab_window\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.
|
|
.IP \fIgrab_window\fP 1i
|
|
Specifies the grab window.
|
|
.\" $Header: keybdmode.a,v 1.3 88/04/06 14:22:10 mento Exp $
|
|
.IP \fIkeyboard_mode\fP 1i
|
|
Specifies further processing of keyboard events.
|
|
You can pass
|
|
.ZN GrabModeSync
|
|
or
|
|
.ZN GrabModeAsync .
|
|
.\" $Header: keycode1.a,v 1.1 88/05/14 08:09:00 mento Exp $
|
|
.IP \fIkeycode\fP 1i
|
|
Specifies the KeyCode or
|
|
.ZN AnyKey .
|
|
.\" $Header: modifiers.a,v 1.4 88/05/14 07:28:56 mento Exp $
|
|
.IP \fImodifiers\fP 1i
|
|
Specifies the set of keymasks or
|
|
.ZN AnyModifier .
|
|
The mask is the bitwise inclusive OR of the valid keymask bits.
|
|
.\" $Header: ownerevents2.a,v 1.3 88/05/14 07:32:25 mento Exp $
|
|
.IP \fIowner_events\fP 1i
|
|
Specifies a Boolean value that indicates whether the keyboard events
|
|
are to be reported as usual.
|
|
.\" $Header: pointermode.a,v 1.3 88/04/06 14:21:24 mento Exp $
|
|
.IP \fIpointer_mode\fP 1i
|
|
Specifies further processing of pointer events.
|
|
You can pass
|
|
.ZN GrabModeSync
|
|
or
|
|
.ZN GrabModeAsync .
|
|
.SH DESCRIPTION
|
|
.\" $Header: XGrabKey.d,v 1.4 88/08/19 20:28:57 mento Exp $
|
|
The
|
|
.ZN XGrabKey
|
|
function establishes a passive grab on the keyboard.
|
|
In the future,
|
|
the keyboard is actively grabbed (as for
|
|
.ZN XGrabKeyboard ),
|
|
the last-keyboard-grab time is set to the time at which the key was pressed
|
|
(as transmitted in the
|
|
.ZN KeyPress
|
|
event), and the
|
|
.ZN KeyPress
|
|
event is reported if all of the following conditions are true:
|
|
.IP \(bu 5
|
|
The keyboard is not grabbed and the specified key
|
|
(which can itself be a modifier key) is logically pressed
|
|
when the specified modifier keys are logically down,
|
|
and no other modifier keys are logically down.
|
|
.IP \(bu 5
|
|
Either the grab_window is an ancestor of (or is) the focus window,
|
|
or the grab_window is a descendant of the focus window and contains the pointer.
|
|
.IP \(bu 5
|
|
A passive grab on the same key combination does not exist
|
|
on any ancestor of grab_window.
|
|
.LP
|
|
The interpretation of the remaining arguments is as for
|
|
.ZN XGrabKeyboard .
|
|
The active grab is terminated automatically when the logical state of the
|
|
keyboard has the specified key released
|
|
(independent of the logical state of the modifier keys).
|
|
.LP
|
|
Note that the logical state of a device (as seen by client applications)
|
|
may lag the physical state if device event processing is frozen.
|
|
.LP
|
|
A modifiers argument of
|
|
.ZN AnyModifier
|
|
is equivalent to issuing the request for all
|
|
possible modifier combinations (including the combination of no
|
|
modifiers).
|
|
It is not required that all modifiers specified have
|
|
currently assigned KeyCodes.
|
|
A keycode argument of
|
|
.ZN AnyKey
|
|
is equivalent to issuing
|
|
the request for all possible KeyCodes.
|
|
Otherwise, the specified keycode must be in
|
|
the range specified by min_keycode and max_keycode in the connection
|
|
setup,
|
|
or a
|
|
.ZN BadValue
|
|
error results.
|
|
.LP
|
|
If some other client has issued a
|
|
.ZN XGrabKey
|
|
with the same key combination on the same window, a
|
|
.ZN BadAccess
|
|
error results.
|
|
When using
|
|
.ZN AnyModifier
|
|
or
|
|
.ZN AnyKey ,
|
|
the request fails completely,
|
|
and a
|
|
.ZN BadAccess
|
|
error results (no grabs are established)
|
|
if there is a conflicting grab for any combination.
|
|
.LP
|
|
.ZN XGrabKey
|
|
can generate
|
|
.ZN BadAccess ,
|
|
.ZN BadValue ,
|
|
and
|
|
.ZN BadWindow
|
|
errors.
|
|
.LP
|
|
.\" $Header: XUngrabKey.d,v 1.3 88/08/19 20:29:50 mento Exp $
|
|
The
|
|
.ZN XUngrabKey
|
|
function releases the key combination on the specified window if it was grabbed
|
|
by this client.
|
|
It has no effect on an active grab.
|
|
A modifiers of
|
|
.ZN AnyModifier
|
|
is equivalent to issuing
|
|
the request for all possible modifier combinations
|
|
(including the combination of no modifiers).
|
|
A keycode argument of
|
|
.ZN AnyKey
|
|
is equivalent to issuing the request for all possible key codes.
|
|
.LP
|
|
.ZN XUngrabKey
|
|
can generate
|
|
.ZN BadValue
|
|
and
|
|
.ZN BadWindow
|
|
error.
|
|
.SH DIAGNOSTICS
|
|
.\" $Header: badaccess1.e,v 1.1 87/09/04 08:22:25 mento Exp $
|
|
.TP 1i
|
|
.ZN BadAccess
|
|
A client attempted
|
|
to grab a key/button combination already grabbed by another client.
|
|
.\" $Header: badvalue.e,v 1.1 87/09/04 08:23:19 mento Exp $
|
|
.TP 1i
|
|
.ZN BadValue
|
|
Some numeric value falls outside the range of values accepted by the request.
|
|
Unless a specific range is specified for an argument, the full range defined
|
|
by the argument's type is accepted. Any argument defined as a set of
|
|
alternatives can generate this error.
|
|
.\" $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"
|
|
XAllowAccess(3X11),
|
|
XGrabButton(3X11),
|
|
XGrabKeyboard(3X11),
|
|
XGrabPointer(3X11)
|
|
.br
|
|
\fI\*(xL\fP
|