diff options
Diffstat (limited to 'doc/Clipboard.3')
| -rw-r--r-- | doc/Clipboard.3 | 15 |
1 files changed, 7 insertions, 8 deletions
diff --git a/doc/Clipboard.3 b/doc/Clipboard.3 index 4cf58d8..f7ab6f3 100644 --- a/doc/Clipboard.3 +++ b/doc/Clipboard.3 @@ -5,7 +5,7 @@ '\" See the file "license.terms" for information on usage and redistribution '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. '\" -'\" RCS: @(#) $Id: Clipboard.3,v 1.3 2004/09/19 16:05:36 dkf Exp $ +'\" RCS: @(#) $Id: Clipboard.3,v 1.7 2009/05/04 09:12:33 dkf Exp $ '\" .so man.macros .TH Tk_ClipboardClear 3 4.0 Tk "Tk Library Procedures" @@ -33,10 +33,9 @@ Conversion type for this clipboard item; has same meaning as .AP Atom format in Representation to use when data is retrieved; has same meaning as \fIformat\fR argument to \fBTk_CreateSelHandler\fR. -.AP char *buffer in +.AP "const char" *buffer in Null terminated string containing the data to be appended to the clipboard. .BE - .SH DESCRIPTION .PP These two procedures manage the clipboard for Tk. @@ -45,9 +44,10 @@ once, then calling \fBTk_ClipboardAppend\fR to add data for any number of targets. .PP \fBTk_ClipboardClear\fR claims the CLIPBOARD selection and frees any -data items previously stored on the clipboard in this application. +data items previously stored on the clipboard in this application. It normally returns \fBTCL_OK\fR, but if an error occurs it returns -\fBTCL_ERROR\fR and leaves an error message in \fIinterp->result\fR. +\fBTCL_ERROR\fR and leaves an error message in interpreter +\fIinterp\fR's result. \fBTk_ClipboardClear\fR must be called before a sequence of \fBTk_ClipboardAppend\fR calls can be issued. .PP @@ -62,8 +62,8 @@ currently owned by the application, either because \fBTk_ClipboardClear\fR has not been called or because ownership of the clipboard has changed since the last call to \fBTk_ClipboardClear\fR, -\fBTk_ClipboardAppend\fR returns \fBTCL_ERROR\fR and leaves an error message in -\fIinterp->result\fR. +\fBTk_ClipboardAppend\fR returns \fBTCL_ERROR\fR and leaves an error +message in the result of interpreter \fIinterp\fR. .PP In order to guarantee atomicity, no event handling should occur between \fBTk_ClipboardClear\fR and the following @@ -75,6 +75,5 @@ this application). Tcl scripts, as a result of losing the CLIPBOARD selection, so any calling function should take care to be reentrant at the point \fBTk_ClipboardClear\fR is invoked. - .SH KEYWORDS append, clipboard, clear, format, type |