2 '\" Copyright (c) 1990-1994 The Regents of the University of California.
3 '\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
5 '\" See the file "license.terms" for information on usage and redistribution
6 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
8 '\" RCS: @(#) $Id: GetSelect.3,v 1.2 1998/09/14 18:22:51 stanton Exp $
10 '\" The definitions below are for supplemental macros used in Tcl/Tk
13 '\" .AP type name in/out ?indent?
14 '\" Start paragraph describing an argument to a library procedure.
15 '\" type is type of argument (int, etc.), in/out is either "in", "out",
16 '\" or "in/out" to describe whether procedure reads or modifies arg,
17 '\" and indent is equivalent to second arg of .IP (shouldn't ever be
18 '\" needed; use .AS below instead)
21 '\" Give maximum sizes of arguments for setting tab stops. Type and
22 '\" name are examples of largest possible arguments that will be passed
23 '\" to .AP later. If args are omitted, default tab stops are used.
26 '\" Start box enclosure. From here until next .BE, everything will be
27 '\" enclosed in one large box.
30 '\" End of box enclosure.
33 '\" Begin code excerpt.
38 '\" .VS ?version? ?br?
39 '\" Begin vertical sidebar, for use in marking newly-changed parts
40 '\" of man pages. The first argument is ignored and used for recording
41 '\" the version when the .VS was added, so that the sidebars can be
42 '\" found and removed when they reach a certain age. If another argument
43 '\" is present, then a line break is forced before starting the sidebar.
46 '\" End of vertical sidebar.
49 '\" Begin an indented unfilled display.
52 '\" End of indented unfilled display.
55 '\" Start of list of standard options for a Tk widget. The
56 '\" options follow on successive lines, in four columns separated
60 '\" End of list of standard options for a Tk widget.
62 '\" .OP cmdName dbName dbClass
63 '\" Start of description of a specific option. cmdName gives the
64 '\" option's name as specified in the class command, dbName gives
65 '\" the option's name in the option database, and dbClass gives
66 '\" the option's class in the option database.
69 '\" Print arg1 underlined, then print arg2 normally.
71 '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
73 '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
77 '\" # Start an argument description
81 . ie !"\\$2"" .TP \\n()Cu
86 \&\\$1 \\fI\\$2\\fP (\\$3)
99 '\" # define tabbing values for .AP
102 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
105 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
106 .nr )C \\n()Bu+\\w'(in/out)'u+2n
108 .AS Tcl_Interp Tcl_CreateInterp in/out
109 '\" # BS - start boxed text
110 '\" # ^y = starting y location
118 .if n \l'\\n(.lu\(ul'
121 '\" # BE - end boxed text (draw box now)
126 .ie n \l'\\n(^lu\(ul'
128 .\" Draw four-sided box normally, but don't draw top of
129 .\" box if the box started on an earlier page.
131 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
134 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
141 '\" # VS - start vertical sidebar
142 '\" # ^Y = starting y location
143 '\" # ^v = 1 (for troff; for nroff this doesn't matter)
147 .ie n 'mc \s12\(br\s0
150 '\" # VE - end of vertical sidebar
158 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
165 '\" # Special macro to handle page bottom: finish off current
166 '\" # box/sidebar if in box/sidebar mode, then invoked standard
167 '\" # page bottom macro.
174 .\" Draw three-sided box if this is the box's first page,
175 .\" draw two sides but no top otherwise.
176 .ie !\\n(^b-1 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
177 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
180 .nr ^x \\n(^tu+1v-\\n(^Yu
181 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
194 '\" # DS - begin display
200 '\" # DE - end display
206 '\" # SO - start of list of standard options
208 .SH "STANDARD OPTIONS"
214 '\" # SE - end of list of standard options
219 See the \\fBoptions\\fR manual entry for details on the standard options.
221 '\" # OP - start of full description for a single option
226 Command-Line Name: \\fB\\$1\\fR
227 Database Name: \\fB\\$2\\fR
228 Database Class: \\fB\\$3\\fR
232 '\" # CS - begin code excerpt
238 '\" # CE - end code excerpt
246 .TH Tk_GetSelection 3 4.0 Tk "Tk Library Procedures"
249 Tk_GetSelection \- retrieve the contents of a selection
252 \fB#include <tk.h>\fR
255 \fBTk_GetSelection\fR(\fIinterp, tkwin, selection, target, proc, clientData\fR)
257 .AS Tk_GetSelProc clientData
258 .AP Tcl_Interp *interp in
259 Interpreter to use for reporting errors.
260 .AP Tk_Window tkwin in
261 Window on whose behalf to retrieve the selection (determines
262 display from which to retrieve).
263 .AP Atom selection in
264 The name of the selection to be retrieved.
266 Form in which to retrieve selection.
267 .AP Tk_GetSelProc *proc in
268 Procedure to invoke to process pieces of the selection as they
270 .AP ClientData clientData in
271 Arbitrary one-word value to pass to \fIproc\fR.
276 \fBTk_GetSelection\fR retrieves the selection specified by the atom
277 \fIselection\fR in the format specified by \fItarget\fR. The
278 selection may actually be retrieved in several pieces; as each piece
279 is retrieved, \fIproc\fR is called to process the piece. \fIProc\fR
280 should have arguments and result that match the type
283 typedef int Tk_GetSelProc(
284 ClientData \fIclientData\fR,
285 Tcl_Interp *\fIinterp\fR,
286 char *\fIportion\fR);
288 The \fIclientData\fR and \fIinterp\fR parameters to \fIproc\fR
289 will be copies of the corresponding arguments to
290 \fBTk_GetSelection\fR. \fIPortion\fR will be a pointer to
291 a string containing part or all of the selection. For large
292 selections, \fIproc\fR will be called several times with successive
293 portions of the selection. The X Inter-Client Communication
294 Conventions Manual allows a selection to be returned in formats
295 other than strings, e.g. as an array of atoms or integers. If
296 this happens, Tk converts the selection back into a string
297 before calling \fIproc\fR. If a selection is returned as an
298 array of atoms, Tk converts it to a string containing the atom names
299 separated by white space. For any other format besides string,
300 Tk converts a selection to a string containing hexadecimal
301 values separated by white space.
303 \fBTk_GetSelection\fR returns to its caller when the selection has
304 been completely retrieved and processed by \fIproc\fR, or when a
305 fatal error has occurred (e.g. the selection owner didn't respond
306 promptly). \fBTk_GetSelection\fR normally returns TCL_OK; if
307 an error occurs, it returns TCL_ERROR and leaves an error message
308 in \fIinterp->result\fR. \fIProc\fR should also return either
309 TCL_OK or TCL_ERROR. If \fIproc\fR encounters an error in dealing with the
310 selection, it should leave an error message in \fIinterp->result\fR
311 and return TCL_ERROR; this will abort the selection retrieval.
314 format, get, selection retrieval