Tk_GetSelection (3)
retrieve the contents of a selection
SYNOPSIS
#include <tk.h>
int
Tk_GetSelection(interp, tkwin, selection, target, proc, clientData)
ARGUMENTS
Tk_GetSelProc clientData
Tcl_Interp *interp in
Interpreter to use for reporting errors.
Tk_Window tkwin in
Window on whose behalf to retrieve the selection (determines
display from which to retrieve).
Atom selection in
The name of the selection to be retrieved.
Atom target in
Form in which to retrieve selection.
Tk_GetSelProc *proc in
Procedure to invoke to process pieces of the selection as they
are retrieved.
ClientData clientData in
Arbitrary one-word value to pass to proc.
DESCRIPTION
Tk_GetSelection retrieves the selection specified by the atom
selection in the format specified by target. The
selection may actually be retrieved in several pieces; as each piece
is retrieved, proc is called to process the piece. Proc
should have arguments and result that match the type
Tk_GetSelProc:
typedef int Tk_GetSelProc(
ClientData clientData,
Tcl_Interp *interp,
char *portion);
The clientData and interp parameters to proc
will be copies of the corresponding arguments to
Tk_GetSelection. Portion will be a pointer to
a string containing part or all of the selection. For large
selections, proc will be called several times with successive
portions of the selection. The X Inter-Client Communication
Conventions Manual allows a selection to be returned in formats
other than strings, e.g. as an array of atoms or integers. If
this happens, Tk converts the selection back into a string
before calling proc. If a selection is returned as an
array of atoms, Tk converts it to a string containing the atom names
separated by white space. For any other format besides string,
Tk converts a selection to a string containing hexadecimal
values separated by white space.
Tk_GetSelection returns to its caller when the selection has
been completely retrieved and processed by proc, or when a
fatal error has occurred (e.g. the selection owner didn't respond
promptly). Tk_GetSelection normally returns TCL_OK; if
an error occurs, it returns TCL_ERROR and leaves an error message
in interp->result. Proc should also return either
TCL_OK or TCL_ERROR. If proc encounters an error in dealing with the
selection, it should leave an error message in interp->result
and return TCL_ERROR; this will abort the selection retrieval.
KEYWORDS
format, get, selection retrieval
'\"
'\" Copyright (c) 1990 The Regents of the University of California.
'\" Copyright (c) 1994-1996 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: GetUid.3,v 1.2 1998/09/14 18:22:51 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
|
