diff options
Diffstat (limited to 'libXt/man/XtAppAddInput.man')
| -rw-r--r-- | libXt/man/XtAppAddInput.man | 204 |
1 files changed, 204 insertions, 0 deletions
diff --git a/libXt/man/XtAppAddInput.man b/libXt/man/XtAppAddInput.man new file mode 100644 index 000000000..1eb34d820 --- /dev/null +++ b/libXt/man/XtAppAddInput.man @@ -0,0 +1,204 @@ +.\" $Xorg: XtAppAI.man,v 1.3 2000/08/17 19:41:57 cpqbld Exp $ +.\" +.\" 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. +.\" $XFree86: xc/doc/man/Xt/XtAppAI.man,v 1.5 2001/02/09 03:47:49 tsi Exp $ +.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-Input wid-get +.na +.de Ds +.nf +.\\$1D \\$2 \\$1 +.ft 1 +.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 FD +.LP +.KS +.TA .5i 3i +.ta .5i 3i +.nf +.. +.de FN +.fi +.KE +.LP +.. +.de IN \" send an index entry to the stderr +.. +.de C{ +.KS +.nf +.D +.\" +.\" choose appropriate monospace font +.\" the imagen conditional, 480, +.\" may be changed to L if LB is too +.\" heavy for your eyes... +.\" +.ie "\\*(.T"480" .ft L +.el .ie "\\*(.T"300" .ft L +.el .ie "\\*(.T"202" .ft PO +.el .ie "\\*(.T"aps" .ft CW +.el .ft R +.ps \\n(PS +.ie \\n(VS>40 .vs \\n(VSu +.el .vs \\n(VSp +.. +.de C} +.DE +.R +.. +.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 +.. +.de NT +.ne 7 +.ds NO Note +.if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2 +.if \\n(.$ .if !'\\$1'C' .ds NO \\$1 +.ie n .sp +.el .sp 10p +.TB +.ce +\\*(NO +.ie n .sp +.el .sp 5p +.if '\\$1'C' .ce 99 +.if '\\$2'C' .ce 99 +.in +5n +.ll -5n +.R +.. +. \" Note End -- doug kraft 3/85 +.de NE +.ce 0 +.in -5n +.ll +5n +.ie n .sp +.el .sp 10p +.. +.ny0 +.TH XtAppAddInput __libmansuffix__ __xorgversion__ "XT FUNCTIONS" +.SH NAME +XtAppAddInput, XtRemoveInput \- register and remove an input source +.SH SYNTAX +.HP +XtInputId XtAppAddInput(XtAppContext \fIapp_context\fP, int \fIsource\fP, +XtPointer \fIcondition\fP, XtInputCallbackProc \fIproc\fP, XtPointer +\fIclient_data\fP); +.HP +void XtRemoveInput(XtInputId \fIid\fP); +.SH ARGUMENTS +.ds Co that identifies the application +.IP \fIapp_context\fP 1i +Specifies the application context \*(Co. +.ds Cd input is available +.IP \fIclient_data\fP 1i +Specifies the argument that is to be passed to the specified procedure +when \*(Cd. +.IP \fIcondition\fP 1i +Specifies the mask that indicates a read, write, or exception condition +or some operating system dependent condition. +.IP \fIid\fP 1i +Specifies the ID returned from the corresponding +.ZN XtAppAddInput +call. +.ds Pr \ to be called when input is available +.IP \fIproc\fP 1i +Specifies the procedure that is\*(Pr. +.IP \fIsource\fP 1i +Specifies the source file descriptor on a UNIX-based system +or other operating system dependent device specification. +.SH DESCRIPTION +The +.ZN XtAppAddInput +function registers with the \*(xI read routine a new source of events, +which is usually file input but can also be file output. +Note that file should be loosely interpreted to mean any sink +or source of data. +.ZN XtAppAddInput +also specifies the conditions under which the source can generate events. +When input is pending on this source, +the callback procedure is called. +.LP +The legal values for the condition argument are operating-system dependent. +On a UNIX-based system, +the condition is some union of +.ZN XtInputReadMask , +.ZN XtInputWriteMask , +and +.ZN XtInputExceptMask . +The +.ZN XtRemoveInput +function causes the \*(xI read routine to stop watching for input +from the input source. +.SH "SEE ALSO" +XtAppAddTimeOut(3Xt),XtAppAddSignal(3Xt) +.br +\fI\*(xT\fP +.br +\fI\*(xL\fP +.LP +.SH "BUGS" +In ANSI C it is necessary to cast the condition to an XtPointer, e.g.: +.RS 4 +.br +XtAppAddInput(app_context, +.RS 4 +.br +source, +.br +.B (XtPointer) +(XtInputReadMask | XtInputWriteMask), +.br +proc, +.br +client_data); +.RE |