301 lines
7.5 KiB
Plaintext
301 lines
7.5 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 XGrabButton 3X11 "Release 5" "X Version 11" "XLIB FUNCTIONS"
|
|
.SH NAME
|
|
XGrabButton, XUngrabButton \- grab pointer buttons
|
|
.SH SYNTAX
|
|
.\" $Header: XGrabButton.f,v 1.2 88/05/14 07:20:38 mento Exp $
|
|
XGrabButton\^(\^\fIdisplay\fP, \fIbutton\fP\^, \fImodifiers\fP\^, \fIgrab_window\fP\^, \fIowner_events\fP\^, \fIevent_mask\fP\^,
|
|
.br
|
|
\fIpointer_mode\fP\^, \fIkeyboard_mode\fP\^, \fIconfine_to\fP\^, \fIcursor\fP\^)
|
|
.br
|
|
Display *\fIdisplay\fP\^;
|
|
.br
|
|
unsigned int \fIbutton\fP\^;
|
|
.br
|
|
unsigned int \fImodifiers\fP\^;
|
|
.br
|
|
Window \fIgrab_window\fP\^;
|
|
.br
|
|
Bool \fIowner_events\fP\^;
|
|
.br
|
|
unsigned int \fIevent_mask\fP\^;
|
|
.br
|
|
int \fIpointer_mode\fP\^, \fIkeyboard_mode\fP\^;
|
|
.br
|
|
Window \fIconfine_to\fP\^;
|
|
.br
|
|
Cursor \fIcursor\fP\^;
|
|
.LP
|
|
.\" $Header: XUngrabBut.f,v 1.2 88/05/14 07:50:53 mento Exp $
|
|
XUngrabButton\^(\^\fIdisplay\fP, \fIbutton\fP\^, \fImodifiers\fP\^, \fIgrab_window\fP\^)
|
|
.br
|
|
Display *\fIdisplay\fP\^;
|
|
.br
|
|
unsigned int \fIbutton\fP\^;
|
|
.br
|
|
unsigned int \fImodifiers\fP\^;
|
|
.br
|
|
Window \fIgrab_window\fP\^;
|
|
.SH ARGUMENTS
|
|
.ds Bu grabbed or released
|
|
.\" $Header: button_gen.a,v 1.2 88/08/04 11:06:39 mento Exp $
|
|
.IP \fIbutton\fP 1i
|
|
Specifies the pointer button that is to be \*(Bu or
|
|
.ZN AnyButton .
|
|
.\" $Header: confineto.a,v 1.2 88/05/14 07:01:28 mento Exp $
|
|
.IP \fIconfine_to\fP 1i
|
|
Specifies the window to confine the pointer in or
|
|
.ZN None .
|
|
.\" $Header: cursor_def.a,v 1.2 88/05/13 13:12:57 mento Exp $
|
|
.IP \fIcursor\fP 1i
|
|
Specifies the cursor that is to be displayed or
|
|
.ZN None .
|
|
.\" $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: pointermask.a,v 1.3 88/05/14 07:34:39 mento Exp $
|
|
.IP \fIevent_mask\fP 1i
|
|
Specifies which pointer events are reported to the client.
|
|
The mask is the bitwise inclusive OR of the valid pointer event mask bits.
|
|
.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: 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 pointer
|
|
events are to be reported as usual or reported with respect to the grab window
|
|
if selected by the event mask.
|
|
.\" $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: XGrabButton.d,v 1.4 88/08/19 20:24:59 mento Exp $
|
|
The
|
|
.ZN XGrabButton
|
|
function establishes a passive grab.
|
|
In the future,
|
|
the pointer is actively grabbed (as for
|
|
.ZN XGrabPointer ),
|
|
the last-pointer-grab time is set to the time at which the button was pressed
|
|
(as transmitted in the
|
|
.ZN ButtonPress
|
|
event), and the
|
|
.ZN ButtonPress
|
|
event is reported if all of the following conditions are true:
|
|
.IP \(bu 5
|
|
The pointer is not grabbed, and the specified button is logically pressed
|
|
when the specified modifier keys are logically down,
|
|
and no other buttons or modifier keys are logically down.
|
|
.IP \(bu 5
|
|
The grab_window contains the pointer.
|
|
.IP \(bu 5
|
|
The confine_to window (if any) is viewable.
|
|
.IP \(bu 5
|
|
A passive grab on the same button/key combination does not exist
|
|
on any ancestor of grab_window.
|
|
.LP
|
|
The interpretation of the remaining arguments is as for
|
|
.ZN XGrabPointer .
|
|
The active grab is terminated automatically when the logical state of the
|
|
pointer has all buttons released
|
|
(independent of the state of the logical 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
|
|
This request overrides all previous grabs by the same client on the same
|
|
button/key combinations on the same window.
|
|
A modifiers of
|
|
.ZN AnyModifier
|
|
is equivalent to issuing the grab 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 button of
|
|
.ZN AnyButton
|
|
is equivalent to
|
|
issuing the request for all possible buttons.
|
|
Otherwise, it is not required that the specified button currently be assigned
|
|
to a physical button.
|
|
.LP
|
|
If some other client has already issued a
|
|
.ZN XGrabButton
|
|
with the same button/key combination on the same window, a
|
|
.ZN BadAccess
|
|
error results.
|
|
When using
|
|
.ZN AnyModifier
|
|
or
|
|
.ZN AnyButton ,
|
|
the request fails completely,
|
|
and a
|
|
.ZN BadAccess
|
|
error results (no grabs are
|
|
established) if there is a conflicting grab for any combination.
|
|
.ZN XGrabButton
|
|
has no effect on an active grab.
|
|
.LP
|
|
.ZN XGrabButton
|
|
can generate
|
|
.ZN BadCursor ,
|
|
.ZN BadValue ,
|
|
and
|
|
.ZN BadWindow
|
|
errors.
|
|
.LP
|
|
.\" $Header: XUngrabBut.d,v 1.2 88/06/11 07:54:20 mento Exp $
|
|
The
|
|
.ZN XUngrabButton
|
|
function releases the passive button/key combination on the specified window if
|
|
it was grabbed by this client.
|
|
A modifiers of
|
|
.ZN AnyModifier
|
|
is
|
|
equivalent to issuing
|
|
the ungrab request for all possible modifier combinations, including
|
|
the combination of no modifiers.
|
|
A button of
|
|
.ZN AnyButton
|
|
is equivalent to issuing the
|
|
request for all possible buttons.
|
|
.ZN XUngrabButton
|
|
has no effect on an active grab.
|
|
.LP
|
|
.ZN XUngrabButton
|
|
can generate
|
|
.ZN BadValue
|
|
and
|
|
.ZN BadWindow
|
|
errors.
|
|
.SH DIAGNOSTICS
|
|
.\" $Header: badcursor.e,v 1.1 87/09/04 08:22:58 mento Exp $
|
|
.TP 1i
|
|
.ZN BadCursor
|
|
A value for a Cursor argument does not name a defined Cursor.
|
|
.\" $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"
|
|
XAllowEvents(3X11),
|
|
XGrabPointer(3X11),
|
|
XGrabKey(3X11),
|
|
XGrabKeyboard(3X11),
|
|
.br
|
|
\fI\*(xL\fP
|