man/XtAppAddBlockHook.man

   1 .\" Copyright (c) 1993, 1994  X Consortium
   2 .\"
   3 .\" Permission is hereby granted, free of charge, to any person obtaining a
   4 .\" copy of this software and associated documentation files (the "Software"),
   5 .\" to deal in the Software without restriction, including without limitation
   6 .\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
   7 .\" and/or sell copies of the Software, and to permit persons to whom the
   8 .\" Software furnished to do so, subject to the following conditions:
   9 .\"
  10 .\" The above copyright notice and this permission notice shall be included in
  11 .\" all copies or substantial portions of the Software.
  12 .\"
  13 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  14 .\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  15 .\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  16 .\" THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
  17 .\" WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
  18 .\" OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  19 .\" SOFTWARE.
  20 .\"
  21 .\" Except as contained in this notice, the name of the X Consortium shall not
  22 .\" be used in advertising or otherwise to promote the sale, use or other
  23 .\" dealing in this Software without prior written authorization from the
  24 .\" X Consortium.
  25 .\"
  26 .ds tk X Toolkit
  27 .ds xT X Toolkit Intrinsics \- C Language Interface
  28 .ds xI Intrinsics
  29 .ds xW X Toolkit Athena Widgets \- C Language Interface
  30 .ds xL Xlib \- C Language X Interface
  31 .ds xC Inter-Client Communication Conventions Manual
  32 .ds Rn 3
  33 .ds Vn 2.2
  34 .hw XtApp-Add-Block-Hook XtRemove-Block-Hook wid-get
  35 .na
  36 .de Ds
  37 .nf
  38 .\\$1D \\$2 \\$1
  39 .ft 1
  40 .ps \\n(PS
  41 .\".if \\n(VS>=40 .vs \\n(VSu
  42 .\".if \\n(VS<=39 .vs \\n(VSp
  43 ..
  44 .de De
  45 .ce 0
  46 .if \\n(BD .DF
  47 .nr BD 0
  48 .in \\n(OIu
  49 .if \\n(TM .ls 2
  50 .sp \\n(DDu
  51 .fi
  52 ..
  53 .de FD
  54 .LP
  55 .KS
  56 .TA .5i 3i
  57 .ta .5i 3i
  58 .nf
  59 ..
  60 .de FN
  61 .fi
  62 .KE
  63 .LP
  64 ..
  65 .de IN          \" send an index entry to the stderr
  66 ..
  67 .de C{
  68 .KS
  69 .nf
  70 .D
  71 .\"
  72 .\"     choose appropriate monospace font
  73 .\"     the imagen conditional, 480,
  74 .\"     may be changed to L if LB is too
  75 .\"     heavy for your eyes...
  76 .\"
  77 .ie "\\*(.T"480" .ft L
  78 .el .ie "\\*(.T"300" .ft L
  79 .el .ie "\\*(.T"202" .ft PO
  80 .el .ie "\\*(.T"aps" .ft CW
  81 .el .ft R
  82 .ps \\n(PS
  83 .ie \\n(VS>40 .vs \\n(VSu
  84 .el .vs \\n(VSp
  85 ..
  86 .de C}
  87 .DE
  88 .R
  89 ..
  90 .de Pn
  91 .ie t \\$1\fB\^\\$2\^\fR\\$3
  92 .el \\$1\fI\^\\$2\^\fP\\$3
  93 ..
  94 .de ZN
  95 .ie t \fB\^\\$1\^\fR\\$2
  96 .el \fI\^\\$1\^\fP\\$2
  97 ..
  98 .de NT
  99 .ne 7
 100 .ds NO Note
 101 .if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
 102 .if \\n(.$ .if !'\\$1'C' .ds NO \\$1
 103 .ie n .sp
 104 .el .sp 10p
 105 .TB
 106 .ce
 107 \\*(NO
 108 .ie n .sp
 109 .el .sp 5p
 110 .if '\\$1'C' .ce 99
 111 .if '\\$2'C' .ce 99
 112 .in +5n
 113 .ll -5n
 114 .R
 115 ..
 116 .               \" Note End -- doug kraft 3/85
 117 .de NE
 118 .ce 0
 119 .in -5n
 120 .ll +5n
 121 .ie n .sp
 122 .el .sp 10p
 123 ..
 124 .ny0
 125 .TH XtAppAddBlockHook __libmansuffix__ __xorgversion__ "XT FUNCTIONS"
 126 .SH NAME
 127 XtAppAddBlockHook, XtRemoveBlockHook \- register a block hook procedure
 128 .SH SYNTAX
 129 .HP
 130 XtBlockHookId XtAppAddBlockHook(XtAppContext \fIapp_context\fP,
 131 XtBlockHookProc \fIproc\fP, XtPointer \fIclient_data\fP);
 132 .HP
 133 void XtRemoveBlockHook(XtBlockHookId \fIid\fP);
 134 .SH ARGUMENTS
 135 .IP \fIapp_context\fP 1i
 136 Specifies the application context.
 137 .IP \fIproc\fP 1i
 138 Specifies the block hook procedure.
 139 .IP \fInum_args\fP 1i
 140 Specifies the application-specific data to be passed to the block hook.
 141 .SH DESCRIPTION
 142 .ZN XtAppAddBlockHook
 143 registers the specified procedure and returns an identifier for it.
 144 The hook is called at any time in the future when the Intrinsics are
 145 about to block pending some input.
 146 .LP
 147 Block hook procedures are removed automatically and the
 148 .ZN XtBlockHookId
 149 is destroyed when the application context in which they were added is
 150 destroyed.
 151 .LP
 152 .ZN XtRemoveBlockHook
 153 removes the specified block hook procedure from the list in which it
 154 was registered.
 155 .SH "SEE ALSO"
 156 .br
 157 \fI\*(xT\fP
 158 .br
 159 \fI\*(xL\fP