Tk_ClipboardClear (3)
Manage the clipboard
SYNOPSIS
#include <tk.h>
int
Tk_ClipboardClear(interp, tkwin)
int
Tk_ClipboardAppend(interp, tkwin, target, format, buffer)
ARGUMENTS
Tk_ClipboardClear tkwin
Tcl_Interp *interp in
Interpreter to use for reporting errors.
Tk_Window tkwin in
Window that determines which display's clipboard to manipulate.
Atom target in
Conversion type for this clipboard item; has same meaning as
target argument to Tk_CreateSelHandler.
Atom format in
Representation to use when data is retrieved; has same meaning as
format argument to Tk_CreateSelHandler.
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 normally returns TCL_OK, but if an error occurs it returns
TCL_ERROR and leaves an error message in interp->result.
Tk_ClipboardClear 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 buffer 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
interp->result.
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 ownership 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 reentrant at the point
Tk_ClipboardClear is invoked.
KEYWORDS
append, clipboard, clear, format, type
'\"
'\" Copyright (c) 1990-1993 The Regents of the University of California.
'\" Copyright (c) 1994-1997 Sun Microsystems, Inc.
'\"
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
'\" RCS: @(#) $Id: WindowId.3,v 1.2 1998/09/14 18:22:54 stanton Exp $
'\"
'\" The definitions below are for supplemental macros used in Tcl/Tk
'\" manual entries.
'\"
'\" .AP type name in/out ?indent?
'\" Start paragraph describing an argument to a library procedure.
'\" type is type of argument (int, etc.), in/out is either "in", "out",
'\" or "in/out" to describe whether procedure reads or modifies arg,
'\" and indent is equivalent to second arg of .IP (shouldn't ever be
'\" needed; use .AS below instead)
'\"
'\" .AS ?type? ?name?
'\" Give maximum sizes of arguments for setting tab stops. Type and
'\" name are examples of largest possible arguments that will be passed
'\" to .AP later. If args are omitted, default tab stops are used.
'\"
'\" .BS
'\" Start box enclosure. From here until next .BE, everything will be
'\" enclosed in one large box.
'\"
'\" .BE
'\" End of box enclosure.
'\"
'\" .CS
'\" Begin code excerpt.
'\"
'\" .CE
'\" End code excerpt.
'\"
'\" .VS ?version? ?br?
'\" Begin vertical sidebar, for use in marking newly-changed parts
'\" of man pages. The first argument is ignored and used for recording
'\" the version when the .VS was added, so that the sidebars can be
'\" found and removed when they reach a certain age. If another argument
'\" is present, then a line break is forced before starting the sidebar.
'\"
'\" .VE
'\" End of vertical sidebar.
'\"
'\" .DS
'\" Begin an indented unfilled display.
'\"
'\" .DE
'\" End of indented unfilled display.
'\"
'\" .SO
'\" Start of list of standard options for a Tk widget. The
'\" options follow on successive lines, in four columns separated
'\" by tabs.
'\"
'\" .SE
'\" End of list of standard options for a Tk widget.
'\"
'\" .OP cmdName dbName dbClass
'\" Start of description of a specific option. cmdName gives the
'\" option's name as specified in the class command, dbName gives
'\" the option's name in the option database, and dbClass gives
'\" the option's class in the option database.
'\"
'\" .UL arg1 arg2
'\" Print arg1 underlined, then print arg2 normally.
'\"
'\" RCS: @(#) $Id: man.macros,v 1.2 1998/09/14 18:39:54 stanton Exp $
'\"
'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
t .wh -1.3i ^B
^l \n(.l
b
'\" # Start an argument description
AP
!"\\$4"" .TP \\$4
\{\
!"\\$2"" .TP \\n()Cu
.TP 15
|
