|
Packit |
b099d7 |
'\" t
|
|
Packit |
b099d7 |
...\" ClipbL.sgm /main/10 1996/09/25 10:24:57 cdedoc $
|
|
Packit |
b099d7 |
.de P!
|
|
Packit |
b099d7 |
.fl
|
|
Packit |
b099d7 |
\!!1 setgray
|
|
Packit |
b099d7 |
.fl
|
|
Packit |
b099d7 |
\\&.\"
|
|
Packit |
b099d7 |
.fl
|
|
Packit |
b099d7 |
\!!0 setgray
|
|
Packit |
b099d7 |
.fl \" force out current output buffer
|
|
Packit |
b099d7 |
\!!save /psv exch def currentpoint translate 0 0 moveto
|
|
Packit |
b099d7 |
\!!/showpage{}def
|
|
Packit |
b099d7 |
.fl \" prolog
|
|
Packit |
b099d7 |
.sy sed -e 's/^/!/' \\$1\" bring in postscript file
|
|
Packit |
b099d7 |
\!!psv restore
|
|
Packit |
b099d7 |
.
|
|
Packit |
b099d7 |
.de pF
|
|
Packit |
b099d7 |
.ie ?\\*(f1?? .ds f1 \\n(.f
|
|
Packit |
b099d7 |
.el .ie ?\\*(f2?? .ds f2 \\n(.f
|
|
Packit |
b099d7 |
.el .ie ?\\*(f3?? .ds f3 \\n(.f
|
|
Packit |
b099d7 |
.el .ie ?\\*(f4?? .ds f4 \\n(.f
|
|
Packit |
b099d7 |
.el .tm ? font overflow
|
|
Packit |
b099d7 |
.ft \\$1
|
|
Packit |
b099d7 |
..
|
|
Packit |
b099d7 |
.de fP
|
|
Packit |
b099d7 |
.ie !?\\*(f4?? \{\
|
|
Packit |
b099d7 |
. ft \\*(f4
|
|
Packit |
b099d7 |
. ds f4\"
|
|
Packit |
b099d7 |
' br \}
|
|
Packit |
b099d7 |
.el .ie !?\\*(f3?? \{\
|
|
Packit |
b099d7 |
. ft \\*(f3
|
|
Packit |
b099d7 |
. ds f3\"
|
|
Packit |
b099d7 |
' br \}
|
|
Packit |
b099d7 |
.el .ie !?\\*(f2?? \{\
|
|
Packit |
b099d7 |
. ft \\*(f2
|
|
Packit |
b099d7 |
. ds f2\"
|
|
Packit |
b099d7 |
' br \}
|
|
Packit |
b099d7 |
.el .ie !?\\*(f1?? \{\
|
|
Packit |
b099d7 |
. ft \\*(f1
|
|
Packit |
b099d7 |
. ds f1\"
|
|
Packit |
b099d7 |
' br \}
|
|
Packit |
b099d7 |
.el .tm ? font underflow
|
|
Packit |
b099d7 |
..
|
|
Packit |
b099d7 |
.ds f1\"
|
|
Packit |
b099d7 |
.ds f2\"
|
|
Packit |
b099d7 |
.ds f3\"
|
|
Packit |
b099d7 |
.ds f4\"
|
|
Packit |
b099d7 |
.ta 8n 16n 24n 32n 40n 48n 56n 64n 72n
|
|
Packit |
b099d7 |
.TH "XmClipboardRetrieve" "library call"
|
|
Packit |
b099d7 |
.SH "NAME"
|
|
Packit |
b099d7 |
\fBXmClipboardRetrieve\fP \(em A clipboard function that retrieves a data item from the clipboard
|
|
Packit |
b099d7 |
.iX "XmClipboardRetrieve"
|
|
Packit |
b099d7 |
.iX "clipboard functions" "XmClipboardRetrieve"
|
|
Packit |
b099d7 |
.SH "SYNOPSIS"
|
|
Packit |
b099d7 |
.PP
|
|
Packit |
b099d7 |
.nf
|
|
Packit |
b099d7 |
#include <Xm/CutPaste\&.h>
|
|
Packit |
b099d7 |
int XmClipboardRetrieve (\fIdisplay, window, format_name,
|
|
Packit |
b099d7 |
buffer, length, num_bytes, private_id\fP)
|
|
Packit |
b099d7 |
Display \fI* display\fP;
|
|
Packit |
b099d7 |
Window \fIwindow\fP;
|
|
Packit |
b099d7 |
char \fI* format_name\fP;
|
|
Packit |
b099d7 |
XtPointer \fIbuffer\fP;
|
|
Packit |
b099d7 |
unsigned long \fIlength\fP;
|
|
Packit |
b099d7 |
unsigned long \fI* num_bytes\fP;
|
|
Packit |
b099d7 |
long \fI* private_id\fP;
|
|
Packit |
b099d7 |
\fB\fR(\fBvoid\fR)
|
|
Packit |
b099d7 |
.fi
|
|
Packit |
b099d7 |
.SH "DESCRIPTION"
|
|
Packit |
b099d7 |
.PP
|
|
Packit |
b099d7 |
\fBXmClipboardRetrieve\fP retrieves the current data item from clipboard
|
|
Packit |
b099d7 |
storage\&. It returns a warning if the clipboard is locked, if there is
|
|
Packit |
b099d7 |
no data on the clipboard, or if the data needs to be truncated because the
|
|
Packit |
b099d7 |
buffer length is too short\&.
|
|
Packit |
b099d7 |
.PP
|
|
Packit |
b099d7 |
Between a call
|
|
Packit |
b099d7 |
to \fBXmClipboardStartRetrieve\fP and a call to \fBXmClipboardEndRetrieve\fP,
|
|
Packit |
b099d7 |
multiple calls to \fBXmClipboardRetrieve\fP
|
|
Packit |
b099d7 |
with the same format name result
|
|
Packit |
b099d7 |
in data being incrementally copied from the clipboard until the data in that
|
|
Packit |
b099d7 |
format has all been copied\&.
|
|
Packit |
b099d7 |
.PP
|
|
Packit |
b099d7 |
The return value \fBXmClipboardTruncate\fP from calls to
|
|
Packit |
b099d7 |
\fBXmClipboardRetrieve\fP indicates that more data remains to be copied in the
|
|
Packit |
b099d7 |
given format\&.
|
|
Packit |
b099d7 |
It is recommended that any calls to the \fBInquire\fP functions that
|
|
Packit |
b099d7 |
the application needs to make to effect the copy from the clipboard be
|
|
Packit |
b099d7 |
made between the call to \fBXmClipboardStartRetrieve\fP and the first
|
|
Packit |
b099d7 |
call to \fBXmClipboardRetrieve\fP\&. This way, the application does not
|
|
Packit |
b099d7 |
need to call \fBXmClipboardLock\fP and \fBXmClipboardUnlock\fP\&.
|
|
Packit |
b099d7 |
.IP "\fIdisplay\fP" 10
|
|
Packit |
b099d7 |
Specifies a pointer to the \fBDisplay\fR structure that was returned in a
|
|
Packit |
b099d7 |
previous call to \fBXOpenDisplay\fP or \fBXtDisplay\fP\&.
|
|
Packit |
b099d7 |
.IP "\fIwindow\fP" 10
|
|
Packit |
b099d7 |
Specifies the window ID of a widget that relates the application window to the
|
|
Packit |
b099d7 |
clipboard\&. The widget\&'s window ID can be obtained through
|
|
Packit |
b099d7 |
\fBXtWindow\fP\&.
|
|
Packit |
b099d7 |
The same application instance should pass the same window ID to each of the
|
|
Packit |
b099d7 |
clipboard functions that it calls\&.
|
|
Packit |
b099d7 |
.IP "\fIformat_name\fP" 10
|
|
Packit |
b099d7 |
Specifies the name of a format in which the data
|
|
Packit |
b099d7 |
is stored on the clipboard\&.
|
|
Packit |
b099d7 |
.IP "\fIbuffer\fP" 10
|
|
Packit |
b099d7 |
Specifies the buffer to which the application wants the
|
|
Packit |
b099d7 |
clipboard to copy the data\&.
|
|
Packit |
b099d7 |
The function allocates space to hold the data returned into the buffer\&.
|
|
Packit |
b099d7 |
The application is responsible for managing this allocated space\&.
|
|
Packit |
b099d7 |
The application can recover this allocated space by calling \fBXtFree\fP\&.
|
|
Packit |
b099d7 |
.IP "\fIlength\fP" 10
|
|
Packit |
b099d7 |
Specifies the length of the application buffer\&.
|
|
Packit |
b099d7 |
.IP "\fInum_bytes\fP" 10
|
|
Packit |
b099d7 |
Specifies the number of bytes of data copied into the application
|
|
Packit |
b099d7 |
buffer\&.
|
|
Packit |
b099d7 |
.IP "\fIprivate_id\fP" 10
|
|
Packit |
b099d7 |
Specifies the private data stored with the data item by the
|
|
Packit |
b099d7 |
application that placed the data item on the clipboard\&. If the
|
|
Packit |
b099d7 |
application did not store private data with the data item, this
|
|
Packit |
b099d7 |
argument returns 0 (zero)\&.
|
|
Packit |
b099d7 |
.SH "RETURN"
|
|
Packit |
b099d7 |
.IP "\fBXmClipboardSuccess\fP" 10
|
|
Packit |
b099d7 |
The function was successful\&.
|
|
Packit |
b099d7 |
.IP "\fBXmClipboardLocked\fP" 10
|
|
Packit |
b099d7 |
The function failed because the clipboard was locked by another
|
|
Packit |
b099d7 |
application\&. The application can continue to call the function again with
|
|
Packit |
b099d7 |
the same parameters until the lock goes away\&. This gives the application
|
|
Packit |
b099d7 |
the opportunity to ask if the user wants to keep trying or to give up
|
|
Packit |
b099d7 |
on the operation\&.
|
|
Packit |
b099d7 |
.IP "\fBXmClipboardTruncate\fP" 10
|
|
Packit |
b099d7 |
The data returned is truncated because the user did not provide a buffer
|
|
Packit |
b099d7 |
large enough to hold the data\&.
|
|
Packit |
b099d7 |
.IP "\fBXmClipboardNoData\fP" 10
|
|
Packit |
b099d7 |
The function could not find data on the clipboard corresponding to the
|
|
Packit |
b099d7 |
format requested\&. This could occur because the clipboard is empty;
|
|
Packit |
b099d7 |
there is data on the clipboard but not in the requested format; or the
|
|
Packit |
b099d7 |
data in the requested format was passed by name and is no longer
|
|
Packit |
b099d7 |
available\&.
|
|
Packit |
b099d7 |
.SH "RELATED"
|
|
Packit |
b099d7 |
.PP
|
|
Packit |
b099d7 |
\fBXmClipboardEndRetrieve\fP(3), \fBXmClipboardLock\fP(3),
|
|
Packit |
b099d7 |
\fBXmClipboardStartCopy\fP(3), \fBXmClipboardStartRetrieve\fP(3),
|
|
Packit |
b099d7 |
and \fBXmClipboardUnlock\fP(3)\&.
|
|
Packit |
b099d7 |
...\" created by instant / docbook-to-man, Sun 22 Dec 1996, 20:18
|