diff options
Diffstat (limited to 'libXt/man/XtSetKeyboardFocus.man')
| -rw-r--r-- | libXt/man/XtSetKeyboardFocus.man | 192 |
1 files changed, 192 insertions, 0 deletions
diff --git a/libXt/man/XtSetKeyboardFocus.man b/libXt/man/XtSetKeyboardFocus.man new file mode 100644 index 000000000..d58da9eac --- /dev/null +++ b/libXt/man/XtSetKeyboardFocus.man @@ -0,0 +1,192 @@ +.\" $Xorg: XtSetKFoc.man,v 1.3 2000/08/17 19:42:02 cpqbld Exp $ +.\" +.\" Copyright 1993 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. +.\" +.\" $XFree86: xc/doc/man/Xt/XtSetKFoc.man,v 1.3 2002/10/12 16:06:41 herrb Exp $ +.\" +.ds tk X Toolkit +.ds xT X Toolkit Intrinsics \- C Language Interface +.ds xI Intrinsics +.ds xW X Toolkit Athena Widgets \- C Language Interface +.ds xL Xlib \- C Language X Interface +.ds xC Inter-Client Communication Conventions Manual +.ds Rn 3 +.ds Vn 2.2 +.hw XtSet-Keyboard-Focus wid-get +.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 XtSetKeyboardFocus __libmansuffix__ __xorgversion__ "XT FUNCTIONS" +.SH NAME +XtSetKeyboardFocus \- focus events on a child widget +.SH SYNTAX +.HP +XtSetKeyboardFocus(Widget \fIsubtree\fP, Widget \fIdescendant\fP); +.SH ARGUMENTS +.IP \fIsubtree\fP 1i +Specifies either the widget in the subtree structure which is to receive the +keyboard event, or +.ZN None . +Note that it is not an error to specify +.ZN None +when no input focus was previously set. +.ds Wi for which the keyboard focus is to be set +.IP \fIdescendant\fP 1i +Specifies the widget \*(Wi. +.SH DESCRIPTION +If a future +.ZN KeyPress +or +.ZN KeyRelease +event occurs within the specified subtree, +.ZN XtSetKeyboardFocus +causes +.ZN XtDispatchEvent +to remap and send the event to the specified descendant widget. +.LP +When there is no modal cascade, +keyboard events can occur within a widget W in one of three ways: +.IP \(bu 5 +W has the X input focus. +.IP \(bu 5 +W has the keyboard focus of one of its ancestors, +and the event occurs within the ancestor or one of the ancestor's descendants. +.IP \(bu 5 +No ancestor of W has a descendant within the keyboard focus, +and the pointer is within W. +.LP +When there is a modal cascade, +a widget W receives keyboard events if an ancestor of W is in the active +subset of the modal cascade and one or more of the previous conditions is +.ZN True . +.LP +When subtree or one of its descendants acquires the X input focus +or the pointer moves into the subtree such that keyboard events would +now be delivered to subtree, a +.ZN FocusIn +event is generated for the descendant if +.ZN FocusNotify +events have been selected by the descendant. +Similarly, when W loses the X input focus +or the keyboard focus for one of its ancestors, a +.ZN FocusOut +event is generated for descendant if +.ZN FocusNotify +events have been selected by the descendant. +.SH "SEE ALSO" +XtCallAcceptFocus(3Xt) +.br +\fI\*(xT\fP +.br +\fI\*(xL\fP |