Blame man/XtSetSensitive.man

Packit 0d0b0c
.\" Copyright 1993 X Consortium
Packit 0d0b0c
.\"
Packit 0d0b0c
.\" Permission is hereby granted, free of charge, to any person obtaining
Packit 0d0b0c
.\" a copy of this software and associated documentation files (the
Packit 0d0b0c
.\" "Software"), to deal in the Software without restriction, including
Packit 0d0b0c
.\" without limitation the rights to use, copy, modify, merge, publish,
Packit 0d0b0c
.\" distribute, sublicense, and/or sell copies of the Software, and to
Packit 0d0b0c
.\" permit persons to whom the Software is furnished to do so, subject to
Packit 0d0b0c
.\" the following conditions:
Packit 0d0b0c
.\"
Packit 0d0b0c
.\" The above copyright notice and this permission notice shall be
Packit 0d0b0c
.\" included in all copies or substantial portions of the Software.
Packit 0d0b0c
.\"
Packit 0d0b0c
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
Packit 0d0b0c
.\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
Packit 0d0b0c
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
Packit 0d0b0c
.\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
Packit 0d0b0c
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
Packit 0d0b0c
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
Packit 0d0b0c
.\" OTHER DEALINGS IN THE SOFTWARE.
Packit 0d0b0c
.\"
Packit 0d0b0c
.\" Except as contained in this notice, the name of the X Consortium shall
Packit 0d0b0c
.\" not be used in advertising or otherwise to promote the sale, use or
Packit 0d0b0c
.\" other dealings in this Software without prior written authorization
Packit 0d0b0c
.\" from the X Consortium.
Packit 0d0b0c
.\"
Packit 0d0b0c
.ds tk X Toolkit
Packit 0d0b0c
.ds xT X Toolkit Intrinsics \- C Language Interface
Packit 0d0b0c
.ds xI Intrinsics
Packit 0d0b0c
.ds xW X Toolkit Athena Widgets \- C Language Interface
Packit 0d0b0c
.ds xL Xlib \- C Language X Interface
Packit 0d0b0c
.ds xC Inter-Client Communication Conventions Manual
Packit 0d0b0c
.ds Rn 3
Packit 0d0b0c
.ds Vn 2.2
Packit 0d0b0c
.hw XtSet-Sensitive XtIs-Sensitive wid-get
Packit 0d0b0c
.na
Packit 0d0b0c
.de Ds
Packit 0d0b0c
.nf
Packit 0d0b0c
.\\$1D \\$2 \\$1
Packit 0d0b0c
.ft CW
Packit 0d0b0c
.ps \\n(PS
Packit 0d0b0c
.\".if \\n(VS>=40 .vs \\n(VSu
Packit 0d0b0c
.\".if \\n(VS<=39 .vs \\n(VSp
Packit 0d0b0c
..
Packit 0d0b0c
.de De
Packit 0d0b0c
.ce 0
Packit 0d0b0c
.if \\n(BD .DF
Packit 0d0b0c
.nr BD 0
Packit 0d0b0c
.in \\n(OIu
Packit 0d0b0c
.if \\n(TM .ls 2
Packit 0d0b0c
.sp \\n(DDu
Packit 0d0b0c
.fi
Packit 0d0b0c
..
Packit 0d0b0c
.de IN		\" send an index entry to the stderr
Packit 0d0b0c
..
Packit 0d0b0c
.de Pn
Packit 0d0b0c
.ie t \\$1\fB\^\\$2\^\fR\\$3
Packit 0d0b0c
.el \\$1\fI\^\\$2\^\fP\\$3
Packit 0d0b0c
..
Packit 0d0b0c
.de ZN
Packit 0d0b0c
.ie t \fB\^\\$1\^\fR\\$2
Packit 0d0b0c
.el \fI\^\\$1\^\fP\\$2
Packit 0d0b0c
..
Packit 0d0b0c
.ny0
Packit 0d0b0c
.TH XtSetSensitive __libmansuffix__ __xorgversion__ "XT FUNCTIONS"
Packit 0d0b0c
.SH NAME
Packit 0d0b0c
XtSetSensitive, XtIsSensitive \- set and check a widget's sensitivity state
Packit 0d0b0c
.SH SYNTAX
Packit 0d0b0c
.HP
Packit 0d0b0c
void XtSetSensitive(Widget \fIw\fP, Boolean \fIsensitive\fP);
Packit 0d0b0c
.HP
Packit 0d0b0c
Boolean XtIsSensitive(Widget \fIw\fP);
Packit 0d0b0c
.SH ARGUMENTS
Packit 0d0b0c
.IP \fIsensitive\fP 1i
Packit 0d0b0c
Specifies a Boolean value that indicates whether the widget should receive
Packit 0d0b0c
keyboard and pointer events.
Packit 0d0b0c
.IP \fIw\fP 1i
Packit 0d0b0c
Specifies the widget.
Packit 0d0b0c
.SH DESCRIPTION
Packit 0d0b0c
The
Packit 0d0b0c
.ZN XtSetSensitive
Packit 0d0b0c
function first calls
Packit 0d0b0c
.ZN XtSetValues
Packit 0d0b0c
on the current widget with an argument list specifying that the
Packit 0d0b0c
sensitive field should change to the new value.
Packit 0d0b0c
It then recursively propagates the new value
Packit 0d0b0c
down the managed children tree by calling
Packit 0d0b0c
.ZN XtSetValues
Packit 0d0b0c
on each child to set the ancestor_sensitive to the new value if the new
Packit 0d0b0c
values for sensitive and the child's ancestor_sensitive are not the same.
Packit 0d0b0c
.LP
Packit 0d0b0c
.ZN XtSetSensitive
Packit 0d0b0c
calls
Packit 0d0b0c
.ZN XtSetValues
Packit 0d0b0c
to change sensitive and ancestor_sensitive.
Packit 0d0b0c
Therefore, when one of these changes,
Packit 0d0b0c
the widget's set_values procedure should
Packit 0d0b0c
take whatever display actions are needed
Packit 0d0b0c
(for example, greying out or stippling the widget).
Packit 0d0b0c
.LP
Packit 0d0b0c
.ZN XtSetSensitive
Packit 0d0b0c
maintains the invariant that if parent has either sensitive
Packit 0d0b0c
or ancestor_sensitive
Packit 0d0b0c
.ZN False ,
Packit 0d0b0c
then all children have ancestor_sensitive
Packit 0d0b0c
.ZN False .
Packit 0d0b0c
.LP
Packit 0d0b0c
The
Packit 0d0b0c
.ZN XtIsSensitive
Packit 0d0b0c
function returns
Packit 0d0b0c
.ZN True
Packit 0d0b0c
or
Packit 0d0b0c
.ZN False
Packit 0d0b0c
to indicate whether or not user input events are being dispatched.
Packit 0d0b0c
If both core.sensitive and core.ancestor_sensitive are
Packit 0d0b0c
.ZN True ,
Packit 0d0b0c
.ZN XtIsSensitive
Packit 0d0b0c
returns
Packit 0d0b0c
.ZN True ;
Packit 0d0b0c
otherwise, it returns
Packit 0d0b0c
.ZN False .
Packit 0d0b0c
.SH "SEE ALSO"
Packit 0d0b0c
.br
Packit 0d0b0c
\fI\*(xT\fP
Packit 0d0b0c
.br
Packit 0d0b0c
\fI\*(xL\fP