Tk_ClipboardClear - Manage the clipboard
#include <tk.h> int Tk_ClipboardClear(interp, tkwin) int Tk_ClipboardAppend(interp, tkwin, target, format, buffer)
Tk_ClipboardClear(3tk) Tk Library Procedures Tk_ClipboardClear(3tk)
______________________________________________________________________________
NAME
Tk_ClipboardClear, Tk_ClipboardAppend - Manage the clipboard
SYNOPSIS
#include <tk.h>
int
Tk_ClipboardClear(interp, tkwin)
int
Tk_ClipboardAppend(interp, tkwin, target, format, buffer)
ARGUMENTS
Tcl_Interp *interp (in) Interpreter to use for reporting
errors.
Tk_Window tkwin (in) Window that determines which dis-
play's clipboard to manipulate.
Atom target (in) Conversion type for this clip-
board item; has same meaning as
target argument to Tk_CreateSel-
Handler.
Atom format (in) Representation to use when data
is retrieved; has same meaning
as format argument to Tk_Create-
SelHandler.
const char *buffer (in) Null terminated string containing
the data to be appended to the
clipboard.
______________________________________________________________________________
DESCRIPTION
These two procedures manage the clipboard for Tk. The clipboard is
typically managed by calling Tk_ClipboardClear once, then calling
Tk_ClipboardAppend to add data for any number of targets.
Tk_ClipboardClear claims the CLIPBOARD selection and frees any data
items previously stored on the clipboard in this application. It nor-
mally returns TCL_OK, but if an error occurs it returns TCL_ERROR and
leaves an error message in interpreter interp's result. Tk_Clipboard-
Clear must be called before a sequence of Tk_ClipboardAppend calls can
be issued.
Tk_ClipboardAppend appends a buffer of data to the clipboard. The
first buffer for a given target determines the format for that target.
Any successive appends for that target must have the same format or an
error will be returned. Tk_ClipboardAppend returns TCL_OK if the buf-
fer is successfully copied onto the clipboard. If the clipboard is not
currently owned by the application, either because Tk_ClipboardClear
has not been called or because ownership of the clipboard has changed
since the last call to Tk_ClipboardClear, Tk_ClipboardAppend returns
TCL_ERROR and leaves an error message in the result of interpreter
interp.
In order to guarantee atomicity, no event handling should occur between
Tk_ClipboardClear and the following Tk_ClipboardAppend calls (otherwise
someone could retrieve a partially completed clipboard or claim owner-
ship away from this application).
Tk_ClipboardClear may invoke callbacks, including arbitrary Tcl
scripts, as a result of losing the CLIPBOARD selection, so any calling
function should take care to be re-entrant at the point Tk_Clipboard-
Clear is invoked.
KEYWORDS
append, clipboard, clear, format, type
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+---------------+------------------+
|ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+---------------+------------------+
|Availability | runtime/tk-8 |
+---------------+------------------+
|Stability | Uncommitted |
+---------------+------------------+
NOTES
Source code for open source software components in Oracle Solaris can
be found at https://www.oracle.com/downloads/opensource/solaris-source-
code-downloads.html.
This software was built from source available at
https://github.com/oracle/solaris-userland. The original community
source was downloaded from https://source-
forge.net/projects/tcl/files/Tcl/8.6.7/tk8.6.7-src.tar.gz/download.
Further information about this software can be found on the open source
community website at https://www.tcl.tk/.
Tk 4.0 Tk_ClipboardClear(3tk)