Blob Blame History Raw
'\" t
...\" TrackE.sgm /main/8 1996/09/08 21:11:06 rws $
.de P!
.fl
\!!1 setgray
.fl
\\&.\"
.fl
\!!0 setgray
.fl			\" force out current output buffer
\!!save /psv exch def currentpoint translate 0 0 moveto
\!!/showpage{}def
.fl			\" prolog
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
\!!psv restore
.
.de pF
.ie     \\*(f1 .ds f1 \\n(.f
.el .ie \\*(f2 .ds f2 \\n(.f
.el .ie \\*(f3 .ds f3 \\n(.f
.el .ie \\*(f4 .ds f4 \\n(.f
.el .tm ? font overflow
.ft \\$1
..
.de fP
.ie     !\\*(f4 \{\
.	ft \\*(f4
.	ds f4\"
'	br \}
.el .ie !\\*(f3 \{\
.	ft \\*(f3
.	ds f3\"
'	br \}
.el .ie !\\*(f2 \{\
.	ft \\*(f2
.	ds f2\"
'	br \}
.el .ie !\\*(f1 \{\
.	ft \\*(f1
.	ds f1\"
'	br \}
.el .tm ? font underflow
..
.ds f1\"
.ds f2\"
.ds f3\"
.ds f4\"
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n 
.TH "XmTrackingEvent" "library call"
.SH "NAME"
\fBXmTrackingEvent\fP \(em A Toolkit function that provides a modal interaction
.iX "XmTrackingEvent"
.iX "Toolkit functions" "XmTrackingEvent"
.SH "SYNOPSIS"
.PP
.nf
#include <Xm/Xm\&.h>
\fBWidget \fBXmTrackingEvent\fP\fR(
\fBWidget \fBwidget\fR\fR,
\fBCursor \fBcursor\fR\fR,
\fBBoolean \fBconfine_to\fR\fR,
\fBXEvent *\fBevent_return\fR\fR);
.fi
.SH "DESCRIPTION"
.PP
\fBXmTrackingEvent\fP provides a modal interface for selection of a
component\&.
It is intended to support context help\&.
The function
calls the \fBXmUpdateDisplay\fP function\&.
\fBXmTrackingEvent\fP then grabs
the pointer and discards succeeding events until
\fBBSelect\fP is released or a key is pressed and then released\&.
The function then returns the widget or gadget that contains the
pointer when \fBBSelect\fP is released or a key is
released, and ungrabs the pointer\&.
.IP "\fIwidget\fP" 10
Specifies the widget ID of a widget to use as the basis of the modal
interaction\&. That is, the widget within which the interaction must
occur, usually a top-level shell\&.
.IP "\fIcursor\fP" 10
Specifies the cursor to be used for the pointer during the interaction\&.
This is a standard X cursor name\&.
.IP "\fIconfine_to\fP" 10
Specifies whether or not the cursor should be confined to \fIwidget\fP\&.
.IP "\fIevent_return\fP" 10
Returns the ButtonRelease or KeyRelease event that causes the function
to return\&.
.SH "RETURN"
.PP
Returns the widget or gadget that contains the pointer when \fBBSelect\fP
is released or a key is released\&. If no widget or gadget contains the
pointer, the function returns NULL\&.
.SH "RELATED"
.PP
\fBXmTrackingLocate\fP(3)\&.
...\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:33