137 lines
4.3 KiB
Groff
137 lines
4.3 KiB
Groff
.\" 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.
|
|
.\"
|
|
.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 XtAdd-Grab wid-get
|
|
.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
|
|
..
|
|
.ny0
|
|
.TH XtAddGrab __libmansuffix__ __xorgversion__ "XT FUNCTIONS"
|
|
.SH NAME
|
|
XtAddGrab, XtRemoveGrab \- redirect user input to a modal widget
|
|
.SH SYNTAX
|
|
.HP
|
|
void XtAddGrab(Widget \fIw\fP, Boolean \fIexclusive\fP, Boolean
|
|
\fIspring_loaded\fP);
|
|
.HP
|
|
void XtRemoveGrab(Widget \fIw\fP);
|
|
.SH ARGUMENTS
|
|
.IP \fIexclusive\fP 1i
|
|
Specifies whether user events should be dispatched exclusively to this widget
|
|
or also to previous widgets in the cascade.
|
|
.IP \fIspring_loaded\fP 1i
|
|
Specifies whether this widget was popped up because the user pressed
|
|
a pointer button.
|
|
.ds Wi to add to or remove from the modal cascade
|
|
.IP \fIw\fP 1i
|
|
Specifies the widget \*(Wi.
|
|
.SH DESCRIPTION
|
|
The
|
|
.ZN XtAddGrab
|
|
function appends the widget (and associated parameters) to the modal cascade
|
|
and checks that exclusive is
|
|
.ZN True
|
|
if spring_loaded is
|
|
.ZN True .
|
|
If these are not
|
|
.ZN True ,
|
|
.ZN XtAddGrab
|
|
generates an error.
|
|
.LP
|
|
The modal cascade is used by
|
|
.ZN XtDispatchEvent
|
|
when it tries to dispatch a user event.
|
|
When at least one modal widget is in the widget cascade,
|
|
.ZN XtDispatchEvent
|
|
first determines if the event should be delivered.
|
|
It starts at the most recent cascade entry and follows the cascade up to and
|
|
including the most recent cascade entry added with the exclusive parameter
|
|
.ZN True .
|
|
.LP
|
|
This subset of the modal cascade along with all descendants of these widgets
|
|
comprise the active subset.
|
|
User events that occur outside the widgets in this subset are ignored
|
|
or remapped.
|
|
Modal menus with submenus generally add a submenu widget to the cascade
|
|
with exclusive
|
|
.ZN False .
|
|
Modal dialog boxes that need to restrict user input to the most deeply nested
|
|
dialog box add a subdialog widget to the cascade with exclusive
|
|
.ZN True .
|
|
User events that occur within the active subset are delivered to the
|
|
appropriate widget, which is usually a child or further descendant of the modal
|
|
widget.
|
|
.LP
|
|
Regardless of where on the screen they occur,
|
|
remap events are always delivered to the most recent widget in the active
|
|
subset of the cascade that has spring_loaded
|
|
.ZN True ,
|
|
if any such widget exists.
|
|
.LP
|
|
The
|
|
.ZN XtRemoveGrab
|
|
function removes widgets from the modal cascade starting
|
|
at the most recent widget up to and including the specified widget.
|
|
It issues an error if the specified widget is not on the modal cascade.
|
|
.SH "SEE ALSO"
|
|
.br
|
|
\fI\*(xT\fP
|
|
.br
|
|
\fI\*(xL\fP
|