XtCreateSelectionRequest.man   [plain text]

.\" $Xorg: XtCreateSR.man,v 1.3 2000/08/17 19:42:00 cpqbld Exp $
.\" $XdotOrg: $
.\"
.\" 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.
.\"
.\" $XFree86: xc/doc/man/Xt/XtCreateSR.man,v 1.2 2001/01/27 18:20:25 dawes 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 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 __libmansuffix__ __xorgversion__ "XT FUNCTIONS"
.SH NAME
XtCreateSelectionRequest, XtSendSelectionRequest, XtCancelSelectionRequest \- bundle multiple selection conversion requests into a single request using MULTIPLE target
.SH SYNTAX
.HP
void XtCreateSelectionRequest(Widget \fIrequestor\fP, Atom \fIselection\fP): 
.HP
void XtSendSelectionRequest(Widget \fIrequestor\fP, Atom \fIselection\fP, Time
\fItime\fP); 
.HP
void XtCancelSelectionRequest(Widget \fIrequestor\fP, 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 request 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 deferred.
.SH "SEE ALSO"
.br
\fI\*(xT\fP
.br
\fI\*(xL\fP