diff options
Diffstat (limited to 'libXt/man/XtSetSensitive.man')
| -rw-r--r-- | libXt/man/XtSetSensitive.man | 191 |
1 files changed, 191 insertions, 0 deletions
diff --git a/libXt/man/XtSetSensitive.man b/libXt/man/XtSetSensitive.man new file mode 100644 index 000000000..207790a32 --- /dev/null +++ b/libXt/man/XtSetSensitive.man @@ -0,0 +1,191 @@ +.\" $Xorg: XtSetSens.man,v 1.3 2000/08/17 19:42:03 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/XtSetSens.man,v 1.2 2001/01/27 18:20:30 dawes 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-Sensitive XtIs-Sensitive 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 XtSetSensitive __libmansuffix__ __xorgversion__ "XT FUNCTIONS" +.SH NAME +XtSetSensitive, XtIsSensitive \- set and check a widget's sensitivity state +.SH SYNTAX +.HP +void XtSetSensitive(Widget \fIw\fP, Boolean \fIsensitive\fP); +.HP +Boolean XtIsSensitive(Widget \fIw\fP); +.SH ARGUMENTS +.IP \fIsensitive\fP 1i +Specifies a Boolean value that indicates whether the widget should receive +keyboard and pointer events. +.IP \fIw\fP 1i +Specifies the widget. +.SH DESCRIPTION +The +.ZN XtSetSensitive +function first calls +.ZN XtSetValues +on the current widget with an argument list specifying that the +sensitive field should change to the new value. +It then recursively propagates the new value +down the managed children tree by calling +.ZN XtSetValues +on each child to set the ancestor_sensitive to the new value if the new +values for sensitive and the child's ancestor_sensitive are not the same. +.LP +.ZN XtSetSensitive +calls +.ZN XtSetValues +to change sensitive and ancestor_sensitive. +Therefore, when one of these changes, +the widget's set_values procedure should +take whatever display actions are needed +(for example, greying out or stippling the widget). +.LP +.ZN XtSetSensitive +maintains the invariant that if parent has either sensitive +or ancestor_sensitive +.ZN False , +then all children have ancestor_sensitive +.ZN False . +.LP +The +.ZN XtIsSensitive +function returns +.ZN True +or +.ZN False +to indicate whether or not user input events are being dispatched. +If both core.sensitive and core.ancestor_sensitive are +.ZN True , +.ZN XtIsSensitive +returns +.ZN True ; +otherwise, it returns +.ZN False . +.SH "SEE ALSO" +.br +\fI\*(xT\fP +.br +\fI\*(xL\fP |