diff options
Diffstat (limited to 'man/XtCreateSelectionRequest.man')
| -rw-r--r-- | man/XtCreateSelectionRequest.man | 209 |
1 files changed, 209 insertions, 0 deletions
diff --git a/man/XtCreateSelectionRequest.man b/man/XtCreateSelectionRequest.man new file mode 100644 index 0000000..d1f030b --- /dev/null +++ b/man/XtCreateSelectionRequest.man @@ -0,0 +1,209 @@ +.\" $Xorg: XtCreateSR.man,v 1.4 2001/03/16 17:53:52 pookie Exp $ +.\" +.\" 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 XtCreate-Selection-Request XtSend-Selection-Request XtCancel-Selection-Request 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 XtCreateSelectionRequest 3Xt "Release 6.6" "X Version 11" "XT FUNCTIONS" +.SH NAME +XtCreateSelectionRequest, XtSendSelectionRequest, XtCancelSelectionRequest \- bundle multiple selection conversion requests into a single request using MULTIPLE target +.SH SYNTAX +void XtCreateSelectionRequest(\fIrequestor\fP, \fIselection\fP) +.br + Widget \fIrequestor\fP; +.br + Atom \fIselection\fP; +.LP +void XtSendSelectionRequest(\fIrequestor\fP, \fIselection\fP, \fItime\fP) +.br + Widget \fIrequestor\fP; +.br + Atom \fIselection\fP; +.br + Time \fItime\fP; +.LP +void XtCancelSelectionRequest(\fIrequestor\fP, \fIselection\fP) +.br + Widget \fIrequestor\fP; +.br + Atom \fIselection\fP; +.SH ARGUMENTS +.IP \fIrequestor\fP 1i +Specifies the widget making the request. Must be of class Core or a +subclass thereof. +.IP \fIselection\fP 1i +Specifies the particular selection desired. +.IP \fItime\fP 1i +Specifies the timestamp to be used in making the request. +.SH DESCRIPTION +When +.ZN XtCreateSelectionRequest +is called, subsequent calls to +.ZN XtGetSelectionValue +and +.ZN XtGetSelectionValueIncremental +with the requestor and selection as specified to +.ZN XtCreateSelectionRequest +will be bundled into a single selection conversion request with +multiple targets. The request is actually initiated by calling +.ZN XtSendSelectionRequest . +.LP +When +.ZN XtSendSelectionRequest +is called with a value of \fIrequestor\fP and \fIselection\fP matching +a previous call to +.ZN XtCreateSelectionRequest , +a selection conversion request is actually sent to the selection owner. +If a single target request is queued, that request is made. If multiple +targets are queued they are bundled into a single request with the +target MULTIPLE using the specified timestamp. As the conversions are +made, the callbacks associated with each +.ZN XtGetSelectionValue +and +.ZN XtGetSelectionValueIncremental +are invoked in turn. +.LP +Multi-threaded applications should lock the application context before +calling +.ZN XtCreateSelectionRequest +and release the lock after calling +.ZN XtSendSelectionRequest +to ensure that the thread assembling the reqeuest is safe from interference +by another thread assembling a different request naming the same widget +and selection. +.LP +When +.ZN XtCancelSelectionRequest +is called, any requests queued since the last call to +.ZN XtCreateSelectionRequest +are cleaned up. Subsequent calls to +.ZN XtGetSelectionValue , +.ZN XtGetSelectionValues , +.ZN XtGetSelectionValueIncremental , +and +.ZN XtGetSelectionValuesIncremental +will not be defered. +.SH "SEE ALSO" +.br +\fI\*(xT\fP +.br +\fI\*(xL\fP |