diff options
author | marha <marha@users.sourceforge.net> | 2012-08-27 08:17:50 +0200 |
---|---|---|
committer | marha <marha@users.sourceforge.net> | 2012-09-04 14:23:00 +0200 |
commit | 02b914d3b9b658a16e17cf2d95deede75dbbacc9 (patch) | |
tree | 3757711ab3e1db8e1b59877354096503d9635112 /libX11/man/XGrabKeyboard.man | |
parent | f479a5fc7f844d96b169c399cb1e8ac085de6c2b (diff) | |
download | vcxsrv-02b914d3b9b658a16e17cf2d95deede75dbbacc9.tar.gz vcxsrv-02b914d3b9b658a16e17cf2d95deede75dbbacc9.tar.bz2 vcxsrv-02b914d3b9b658a16e17cf2d95deede75dbbacc9.zip |
xwininfo fontconfig libX11 libXau libXext libxcb mesa pixman
xkeyboard-config git update 27 Aug 2012
Diffstat (limited to 'libX11/man/XGrabKeyboard.man')
-rw-r--r-- | libX11/man/XGrabKeyboard.man | 533 |
1 files changed, 236 insertions, 297 deletions
diff --git a/libX11/man/XGrabKeyboard.man b/libX11/man/XGrabKeyboard.man index 08397c027..875fe3e5a 100644 --- a/libX11/man/XGrabKeyboard.man +++ b/libX11/man/XGrabKeyboard.man @@ -1,297 +1,236 @@ -.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
-.\"
-.\" Permission is hereby granted, free of charge, to any person obtaining
-.\" a copy of this software and associated documentation files (the
-.\" "Software"), to deal in the Software without restriction, including
-.\" without limitation the rights to use, copy, modify, merge, publish,
-.\" distribute, sublicense, and/or sell copies of the Software, and to
-.\" permit persons to whom the Software is furnished to do so, subject to
-.\" the following conditions:
-.\"
-.\" The above copyright notice and this permission notice shall be included
-.\" in all copies or substantial portions of the Software.
-.\"
-.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
-.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-.\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
-.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
-.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
-.\" OTHER DEALINGS IN THE SOFTWARE.
-.\"
-.\" Except as contained in this notice, the name of the X Consortium shall
-.\" not be used in advertising or otherwise to promote the sale, use or
-.\" other dealings in this Software without prior written authorization
-.\" from the X Consortium.
-.\"
-.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
-.\" Digital Equipment Corporation
-.\"
-.\" Portions Copyright \(co 1990, 1991 by
-.\" Tektronix, Inc.
-.\"
-.\" Permission to use, copy, modify and distribute this documentation for
-.\" any purpose and without fee is hereby granted, provided that the above
-.\" copyright notice appears in all copies and that both that copyright notice
-.\" and this permission notice appear in all copies, and that the names of
-.\" Digital and Tektronix not be used in in advertising or publicity pertaining
-.\" to this documentation without specific, written prior permission.
-.\" Digital and Tektronix makes no representations about the suitability
-.\" of this documentation for any purpose.
-.\" It is provided ``as is'' without express or implied warranty.
-.\"
-.\"
-.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 hN
-.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 XGrabKeyboard __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS"
-.SH NAME
-XGrabKeyboard, XUngrabKeyboard \- grab the keyboard
-.SH SYNTAX
-.HP
-int XGrabKeyboard\^(\^Display *\fIdisplay\fP\^, Window \fIgrab_window\fP\^,
-Bool \fIowner_events\fP\^, int \fIpointer_mode\fP\^, int
-\fIkeyboard_mode\fP\^, Time \fItime\fP\^);
-.HP
-int XUngrabKeyboard\^(\^Display *\fIdisplay\fP\^, Time \fItime\fP\^);
-.SH ARGUMENTS
-.IP \fIdisplay\fP 1i
-Specifies the connection to the X server.
-.IP \fIgrab_window\fP 1i
-Specifies the grab window.
-.IP \fIkeyboard_mode\fP 1i
-Specifies further processing of keyboard events.
-You can pass
-.ZN GrabModeSync
-or
-.ZN GrabModeAsync .
-.IP \fIowner_events\fP 1i
-Specifies a Boolean value that indicates whether the keyboard events
-are to be reported as usual.
-.IP \fIpointer_mode\fP 1i
-Specifies further processing of pointer events.
-You can pass
-.ZN GrabModeSync
-or
-.ZN GrabModeAsync .
-.IP \fItime\fP 1i
-Specifies the time.
-You can pass either a timestamp or
-.ZN CurrentTime .
-.SH DESCRIPTION
-The
-.ZN XGrabKeyboard
-function actively grabs control of the keyboard and generates
-.ZN FocusIn
-and
-.ZN FocusOut
-events.
-Further key events are reported only to the
-grabbing client.
-.ZN XGrabKeyboard
-overrides any active keyboard grab by this client.
-If owner_events is
-.ZN False ,
-all generated key events are reported with
-respect to grab_window.
-If owner_events is
-.ZN True
-and if a generated
-key event would normally be reported to this client, it is reported
-normally; otherwise, the event is reported with respect to the
-grab_window.
-Both
-.ZN KeyPress
-and
-.ZN KeyRelease
-events are always reported,
-independent of any event selection made by the client.
-.LP
-If the keyboard_mode argument is
-.ZN GrabModeAsync ,
-keyboard event processing continues
-as usual.
-If the keyboard is currently frozen by this client,
-then processing of keyboard events is resumed.
-If the keyboard_mode argument is
-.ZN GrabModeSync ,
-the state of the keyboard (as seen by client applications) appears to freeze,
-and the X server generates no further keyboard events until the
-grabbing client issues a releasing
-.ZN XAllowEvents
-call or until the keyboard grab is released.
-Actual keyboard changes are not lost while the keyboard is frozen;
-they are simply queued in the server for later processing.
-.LP
-If pointer_mode is
-.ZN GrabModeAsync ,
-pointer event processing is unaffected
-by activation of the grab.
-If pointer_mode is
-.ZN GrabModeSync ,
-the state of the pointer (as seen by client applications) appears to freeze,
-and the X server generates no further pointer events
-until the grabbing client issues a releasing
-.ZN XAllowEvents
-call or until the keyboard grab is released.
-Actual pointer changes are not lost while the pointer is frozen;
-they are simply queued in the server for later processing.
-.LP
-If the keyboard is actively grabbed by some other client,
-.ZN XGrabKeyboard
-fails and returns
-.ZN AlreadyGrabbed .
-If grab_window is not viewable,
-it fails and returns
-.ZN GrabNotViewable .
-If the keyboard is frozen by an active grab of another client,
-it fails and returns
-.ZN GrabFrozen .
-If the specified time is earlier than the last-keyboard-grab time
-or later than the current X server time,
-it fails and returns
-.ZN GrabInvalidTime .
-Otherwise, the last-keyboard-grab time is set to the specified time
-.Pn ( CurrentTime
-is replaced by the current X server time).
-.LP
-.ZN XGrabKeyboard
-can generate
-.ZN BadValue
-and
-.ZN BadWindow
-errors.
-.LP
-The
-.ZN XUngrabKeyboard
-function
-releases the keyboard and any queued events if this client has it actively grabbed from
-either
-.ZN XGrabKeyboard
-or
-.ZN XGrabKey .
-.ZN XUngrabKeyboard
-does not release the keyboard and any queued events
-if the specified time is earlier than
-the last-keyboard-grab time or is later than the current X server time.
-It also generates
-.ZN FocusIn
-and
-.ZN FocusOut
-events.
-The X server automatically performs an
-.ZN UngrabKeyboard
-request if the event window for an
-active keyboard grab becomes not viewable.
-.SH DIAGNOSTICS
-.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.
-.TP 1i
-.ZN BadWindow
-A value for a Window argument does not name a defined Window.
-.SH "SEE ALSO"
-XAllowEvents(__libmansuffix__),
-XGrabButton(__libmansuffix__),
-XGrabKey(__libmansuffix__),
-XGrabPointer(__libmansuffix__)
-.br
-\fI\*(xL\fP
+.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium +.\" +.\" Permission is hereby granted, free of charge, to any person obtaining +.\" a copy of this software and associated documentation files (the +.\" "Software"), to deal in the Software without restriction, including +.\" without limitation the rights to use, copy, modify, merge, publish, +.\" distribute, sublicense, and/or sell copies of the Software, and to +.\" permit persons to whom the Software is furnished to do so, subject to +.\" the following conditions: +.\" +.\" The above copyright notice and this permission notice shall be included +.\" in all copies or substantial portions of the Software. +.\" +.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS +.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +.\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR +.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, +.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +.\" OTHER DEALINGS IN THE SOFTWARE. +.\" +.\" Except as contained in this notice, the name of the X Consortium shall +.\" not be used in advertising or otherwise to promote the sale, use or +.\" other dealings in this Software without prior written authorization +.\" from the X Consortium. +.\" +.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by +.\" Digital Equipment Corporation +.\" +.\" Portions Copyright \(co 1990, 1991 by +.\" Tektronix, Inc. +.\" +.\" Permission to use, copy, modify and distribute this documentation for +.\" any purpose and without fee is hereby granted, provided that the above +.\" copyright notice appears in all copies and that both that copyright notice +.\" and this permission notice appear in all copies, and that the names of +.\" Digital and Tektronix not be used in in advertising or publicity pertaining +.\" to this documentation without specific, written prior permission. +.\" Digital and Tektronix makes no representations about the suitability +.\" of this documentation for any purpose. +.\" It is provided ``as is'' without express or implied warranty. +.\" +.\" +.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 CW +.\".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 IN \" send an index entry to the stderr +.. +.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 hN +.ie t <\fB\\$1\fR>\\$2 +.el <\fI\\$1\fP>\\$2 +.. +.ny0 +.TH XGrabKeyboard __libmansuffix__ __xorgversion__ "XLIB FUNCTIONS" +.SH NAME +XGrabKeyboard, XUngrabKeyboard \- grab the keyboard +.SH SYNTAX +.HP +int XGrabKeyboard\^(\^Display *\fIdisplay\fP\^, Window \fIgrab_window\fP\^, +Bool \fIowner_events\fP\^, int \fIpointer_mode\fP\^, int +\fIkeyboard_mode\fP\^, Time \fItime\fP\^); +.HP +int XUngrabKeyboard\^(\^Display *\fIdisplay\fP\^, Time \fItime\fP\^); +.SH ARGUMENTS +.IP \fIdisplay\fP 1i +Specifies the connection to the X server. +.IP \fIgrab_window\fP 1i +Specifies the grab window. +.IP \fIkeyboard_mode\fP 1i +Specifies further processing of keyboard events. +You can pass +.ZN GrabModeSync +or +.ZN GrabModeAsync . +.IP \fIowner_events\fP 1i +Specifies a Boolean value that indicates whether the keyboard events +are to be reported as usual. +.IP \fIpointer_mode\fP 1i +Specifies further processing of pointer events. +You can pass +.ZN GrabModeSync +or +.ZN GrabModeAsync . +.IP \fItime\fP 1i +Specifies the time. +You can pass either a timestamp or +.ZN CurrentTime . +.SH DESCRIPTION +The +.ZN XGrabKeyboard +function actively grabs control of the keyboard and generates +.ZN FocusIn +and +.ZN FocusOut +events. +Further key events are reported only to the +grabbing client. +.ZN XGrabKeyboard +overrides any active keyboard grab by this client. +If owner_events is +.ZN False , +all generated key events are reported with +respect to grab_window. +If owner_events is +.ZN True +and if a generated +key event would normally be reported to this client, it is reported +normally; otherwise, the event is reported with respect to the +grab_window. +Both +.ZN KeyPress +and +.ZN KeyRelease +events are always reported, +independent of any event selection made by the client. +.LP +If the keyboard_mode argument is +.ZN GrabModeAsync , +keyboard event processing continues +as usual. +If the keyboard is currently frozen by this client, +then processing of keyboard events is resumed. +If the keyboard_mode argument is +.ZN GrabModeSync , +the state of the keyboard (as seen by client applications) appears to freeze, +and the X server generates no further keyboard events until the +grabbing client issues a releasing +.ZN XAllowEvents +call or until the keyboard grab is released. +Actual keyboard changes are not lost while the keyboard is frozen; +they are simply queued in the server for later processing. +.LP +If pointer_mode is +.ZN GrabModeAsync , +pointer event processing is unaffected +by activation of the grab. +If pointer_mode is +.ZN GrabModeSync , +the state of the pointer (as seen by client applications) appears to freeze, +and the X server generates no further pointer events +until the grabbing client issues a releasing +.ZN XAllowEvents +call or until the keyboard grab is released. +Actual pointer changes are not lost while the pointer is frozen; +they are simply queued in the server for later processing. +.LP +If the keyboard is actively grabbed by some other client, +.ZN XGrabKeyboard +fails and returns +.ZN AlreadyGrabbed . +If grab_window is not viewable, +it fails and returns +.ZN GrabNotViewable . +If the keyboard is frozen by an active grab of another client, +it fails and returns +.ZN GrabFrozen . +If the specified time is earlier than the last-keyboard-grab time +or later than the current X server time, +it fails and returns +.ZN GrabInvalidTime . +Otherwise, the last-keyboard-grab time is set to the specified time +.Pn ( CurrentTime +is replaced by the current X server time). +.LP +.ZN XGrabKeyboard +can generate +.ZN BadValue +and +.ZN BadWindow +errors. +.LP +The +.ZN XUngrabKeyboard +function +releases the keyboard and any queued events if this client has it actively grabbed from +either +.ZN XGrabKeyboard +or +.ZN XGrabKey . +.ZN XUngrabKeyboard +does not release the keyboard and any queued events +if the specified time is earlier than +the last-keyboard-grab time or is later than the current X server time. +It also generates +.ZN FocusIn +and +.ZN FocusOut +events. +The X server automatically performs an +.ZN UngrabKeyboard +request if the event window for an +active keyboard grab becomes not viewable. +.SH DIAGNOSTICS +.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. +.TP 1i +.ZN BadWindow +A value for a Window argument does not name a defined Window. +.SH "SEE ALSO" +XAllowEvents(__libmansuffix__), +XGrabButton(__libmansuffix__), +XGrabKey(__libmansuffix__), +XGrabPointer(__libmansuffix__) +.br +\fI\*(xL\fP |