xenocara/lib/libXt/man/XtAppAddBlockHook.man
2020-01-14 20:48:59 +00:00

72 lines
2.7 KiB
Groff

.\" Copyright (c) 1993, 1994 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 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
.\" dealing 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 XtApp-Add-Block-Hook XtRemove-Block-Hook wid-get
.na
.TH XtAppAddBlockHook __libmansuffix__ __xorgversion__ "XT FUNCTIONS"
.SH NAME
XtAppAddBlockHook, XtRemoveBlockHook \- register a block hook procedure
.SH SYNTAX
#include <X11/Intrinsic.h>
.HP
XtBlockHookId XtAppAddBlockHook(XtAppContext \fIapp_context\fP,
XtBlockHookProc \fIproc\fP, XtPointer \fIclient_data\fP);
.HP
void XtRemoveBlockHook(XtBlockHookId \fIid\fP);
.SH ARGUMENTS
.IP \fIapp_context\fP 1i
Specifies the application context.
.IP \fIproc\fP 1i
Specifies the block hook procedure.
.IP \fInum_args\fP 1i
Specifies the application-specific data to be passed to the block hook.
.SH DESCRIPTION
.B XtAppAddBlockHook
registers the specified procedure and returns an identifier for it.
The hook is called at any time in the future when the Intrinsics are
about to block pending some input.
.LP
Block hook procedures are removed automatically and the
.B XtBlockHookId
is destroyed when the application context in which they were added is
destroyed.
.LP
.B XtRemoveBlockHook
removes the specified block hook procedure from the list in which it
was registered.
.SH "SEE ALSO"
.br
\fI\*(xT\fP
.br
\fI\*(xL\fP