Commit | Line | Data |
---|---|---|
86530b38 AT |
1 | '\" |
2 | '\" Copyright (c) 1990-1994 The Regents of the University of California. | |
3 | '\" Copyright (c) 1994-1996 Sun Microsystems, Inc. | |
4 | '\" | |
5 | '\" See the file "license.terms" for information on usage and redistribution | |
6 | '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. | |
7 | '\" | |
8 | '\" RCS: @(#) $Id: selection.n,v 1.4.4.1 2004/10/28 12:25:22 dkf Exp $ | |
9 | '\" | |
10 | '\" The definitions below are for supplemental macros used in Tcl/Tk | |
11 | '\" manual entries. | |
12 | '\" | |
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) | |
19 | '\" | |
20 | '\" .AS ?type? ?name? | |
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. | |
24 | '\" | |
25 | '\" .BS | |
26 | '\" Start box enclosure. From here until next .BE, everything will be | |
27 | '\" enclosed in one large box. | |
28 | '\" | |
29 | '\" .BE | |
30 | '\" End of box enclosure. | |
31 | '\" | |
32 | '\" .CS | |
33 | '\" Begin code excerpt. | |
34 | '\" | |
35 | '\" .CE | |
36 | '\" End code excerpt. | |
37 | '\" | |
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. | |
44 | '\" | |
45 | '\" .VE | |
46 | '\" End of vertical sidebar. | |
47 | '\" | |
48 | '\" .DS | |
49 | '\" Begin an indented unfilled display. | |
50 | '\" | |
51 | '\" .DE | |
52 | '\" End of indented unfilled display. | |
53 | '\" | |
54 | '\" .SO | |
55 | '\" Start of list of standard options for a Tk widget. The | |
56 | '\" options follow on successive lines, in four columns separated | |
57 | '\" by tabs. | |
58 | '\" | |
59 | '\" .SE | |
60 | '\" End of list of standard options for a Tk widget. | |
61 | '\" | |
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. | |
67 | '\" | |
68 | '\" .UL arg1 arg2 | |
69 | '\" Print arg1 underlined, then print arg2 normally. | |
70 | '\" | |
71 | '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $ | |
72 | '\" | |
73 | '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. | |
74 | .if t .wh -1.3i ^B | |
75 | .nr ^l \n(.l | |
76 | .ad b | |
77 | '\" # Start an argument description | |
78 | .de AP | |
79 | .ie !"\\$4"" .TP \\$4 | |
80 | .el \{\ | |
81 | . ie !"\\$2"" .TP \\n()Cu | |
82 | . el .TP 15 | |
83 | .\} | |
84 | .ta \\n()Au \\n()Bu | |
85 | .ie !"\\$3"" \{\ | |
86 | \&\\$1 \\fI\\$2\\fP (\\$3) | |
87 | .\".b | |
88 | .\} | |
89 | .el \{\ | |
90 | .br | |
91 | .ie !"\\$2"" \{\ | |
92 | \&\\$1 \\fI\\$2\\fP | |
93 | .\} | |
94 | .el \{\ | |
95 | \&\\fI\\$1\\fP | |
96 | .\} | |
97 | .\} | |
98 | .. | |
99 | '\" # define tabbing values for .AP | |
100 | .de AS | |
101 | .nr )A 10n | |
102 | .if !"\\$1"" .nr )A \\w'\\$1'u+3n | |
103 | .nr )B \\n()Au+15n | |
104 | .\" | |
105 | .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n | |
106 | .nr )C \\n()Bu+\\w'(in/out)'u+2n | |
107 | .. | |
108 | .AS Tcl_Interp Tcl_CreateInterp in/out | |
109 | '\" # BS - start boxed text | |
110 | '\" # ^y = starting y location | |
111 | '\" # ^b = 1 | |
112 | .de BS | |
113 | .br | |
114 | .mk ^y | |
115 | .nr ^b 1u | |
116 | .if n .nf | |
117 | .if n .ti 0 | |
118 | .if n \l'\\n(.lu\(ul' | |
119 | .if n .fi | |
120 | .. | |
121 | '\" # BE - end boxed text (draw box now) | |
122 | .de BE | |
123 | .nf | |
124 | .ti 0 | |
125 | .mk ^t | |
126 | .ie n \l'\\n(^lu\(ul' | |
127 | .el \{\ | |
128 | .\" Draw four-sided box normally, but don't draw top of | |
129 | .\" box if the box started on an earlier page. | |
130 | .ie !\\n(^b-1 \{\ | |
131 | \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' | |
132 | .\} | |
133 | .el \}\ | |
134 | \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' | |
135 | .\} | |
136 | .\} | |
137 | .fi | |
138 | .br | |
139 | .nr ^b 0 | |
140 | .. | |
141 | '\" # VS - start vertical sidebar | |
142 | '\" # ^Y = starting y location | |
143 | '\" # ^v = 1 (for troff; for nroff this doesn't matter) | |
144 | .de VS | |
145 | .if !"\\$2"" .br | |
146 | .mk ^Y | |
147 | .ie n 'mc \s12\(br\s0 | |
148 | .el .nr ^v 1u | |
149 | .. | |
150 | '\" # VE - end of vertical sidebar | |
151 | .de VE | |
152 | .ie n 'mc | |
153 | .el \{\ | |
154 | .ev 2 | |
155 | .nf | |
156 | .ti 0 | |
157 | .mk ^t | |
158 | \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' | |
159 | .sp -1 | |
160 | .fi | |
161 | .ev | |
162 | .\} | |
163 | .nr ^v 0 | |
164 | .. | |
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. | |
168 | .de ^B | |
169 | .ev 2 | |
170 | 'ti 0 | |
171 | 'nf | |
172 | .mk ^t | |
173 | .if \\n(^b \{\ | |
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 | |
178 | .\} | |
179 | .if \\n(^v \{\ | |
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 | |
182 | .\} | |
183 | .bp | |
184 | 'fi | |
185 | .ev | |
186 | .if \\n(^b \{\ | |
187 | .mk ^y | |
188 | .nr ^b 2 | |
189 | .\} | |
190 | .if \\n(^v \{\ | |
191 | .mk ^Y | |
192 | .\} | |
193 | .. | |
194 | '\" # DS - begin display | |
195 | .de DS | |
196 | .RS | |
197 | .nf | |
198 | .sp | |
199 | .. | |
200 | '\" # DE - end display | |
201 | .de DE | |
202 | .fi | |
203 | .RE | |
204 | .sp | |
205 | .. | |
206 | '\" # SO - start of list of standard options | |
207 | .de SO | |
208 | .SH "STANDARD OPTIONS" | |
209 | .LP | |
210 | .nf | |
211 | .ta 5.5c 11c | |
212 | .ft B | |
213 | .. | |
214 | '\" # SE - end of list of standard options | |
215 | .de SE | |
216 | .fi | |
217 | .ft R | |
218 | .LP | |
219 | See the \\fBoptions\\fR manual entry for details on the standard options. | |
220 | .. | |
221 | '\" # OP - start of full description for a single option | |
222 | .de OP | |
223 | .LP | |
224 | .nf | |
225 | .ta 4c | |
226 | Command-Line Name: \\fB\\$1\\fR | |
227 | Database Name: \\fB\\$2\\fR | |
228 | Database Class: \\fB\\$3\\fR | |
229 | .fi | |
230 | .IP | |
231 | .. | |
232 | '\" # CS - begin code excerpt | |
233 | .de CS | |
234 | .RS | |
235 | .nf | |
236 | .ta .25i .5i .75i 1i | |
237 | .. | |
238 | '\" # CE - end code excerpt | |
239 | .de CE | |
240 | .fi | |
241 | .RE | |
242 | .. | |
243 | .de UL | |
244 | \\$1\l'|0\(ul'\\$2 | |
245 | .. | |
246 | .TH selection n 8.1 Tk "Tk Built-In Commands" | |
247 | .BS | |
248 | '\" Note: do not modify the .SH NAME line immediately below! | |
249 | .SH NAME | |
250 | selection \- Manipulate the X selection | |
251 | .SH SYNOPSIS | |
252 | \fBselection \fIoption\fR ?\fIarg arg ...\fR? | |
253 | .BE | |
254 | ||
255 | .SH DESCRIPTION | |
256 | .PP | |
257 | This command provides a Tcl interface to the X selection mechanism and | |
258 | implements the full selection functionality described in the | |
259 | X Inter-Client Communication Conventions Manual (ICCCM). | |
260 | .PP | |
261 | Note that for management of the CLIPBOARD selection (see below), the | |
262 | \fBclipboard\fR command may also be used. | |
263 | .PP | |
264 | The first argument to \fBselection\fR determines the format of the | |
265 | rest of the arguments and the behavior of the command. The following | |
266 | forms are currently supported: | |
267 | .PP | |
268 | .TP | |
269 | \fBselection clear\fR ?\fB\-displayof\fR \fIwindow\fR? ?\fB\-selection\fR \fIselection\fR? | |
270 | If \fIselection\fR exists anywhere on \fIwindow\fR's display, clear it | |
271 | so that no window owns the selection anymore. \fISelection\fR | |
272 | specifies the X selection that should be cleared, and should be an | |
273 | atom name such as PRIMARY or CLIPBOARD; see the Inter-Client | |
274 | Communication Conventions Manual for complete details. | |
275 | \fISelection\fR defaults to PRIMARY and \fIwindow\fR defaults to ``.''. | |
276 | Returns an empty string. | |
277 | .TP | |
278 | \fBselection get\fR ?\fB\-displayof\fR \fIwindow\fR? ?\fB\-selection\fR \fIselection\fR? ?\fB\-type\fR \fItype\fR? | |
279 | Retrieves the value of \fIselection\fR from \fIwindow\fR's display and | |
280 | returns it as a result. \fISelection\fR defaults to PRIMARY and | |
281 | \fIwindow\fR defaults to ``.''. | |
282 | \fIType\fR specifies the form in which the selection is to be returned | |
283 | (the desired ``target'' for conversion, in ICCCM terminology), and | |
284 | should be an atom name such as STRING or FILE_NAME; see the | |
285 | Inter-Client Communication Conventions Manual for complete details. | |
286 | \fIType\fR defaults to STRING. The selection owner may choose to | |
287 | return the selection in any of several different representation | |
288 | formats, such as STRING, ATOM, INTEGER, etc. (this format is different | |
289 | than the selection type; see the ICCCM for all the confusing details). | |
290 | If the selection is returned in a non-string format, such as INTEGER | |
291 | or ATOM, the \fBselection\fR command converts it to string format as a | |
292 | collection of fields separated by spaces: atoms are converted to their | |
293 | textual names, and anything else is converted to hexadecimal integers. | |
294 | .TP | |
295 | \fBselection handle\fR ?\fB\-selection\fR \fIselection\fR? ?\fB\-type\fR \fItype\fR? ?\fB\-format\fR \fIformat\fR? \fIwindow command\fR | |
296 | Creates a handler for selection requests, such that \fIcommand\fR will | |
297 | be executed whenever \fIselection\fR is owned by \fIwindow\fR and | |
298 | someone attempts to retrieve it in the form given by \fItype\fR | |
299 | (e.g. \fItype\fR is specified in the \fBselection get\fR command). | |
300 | \fISelection\fR defaults to PRIMARY, \fItype\fR defaults to STRING, and | |
301 | \fIformat\fR defaults to STRING. If \fIcommand\fR is an empty string | |
302 | then any existing handler for \fIwindow\fR, \fItype\fR, and | |
303 | \fIselection\fR is removed. | |
304 | .RS | |
305 | .PP | |
306 | When \fIselection\fR is requested, \fIwindow\fR is the selection owner, | |
307 | and \fItype\fR is the requested type, \fIcommand\fR will be executed | |
308 | as a Tcl command with two additional numbers appended to it | |
309 | (with space separators). | |
310 | The two additional numbers | |
311 | .VS | |
312 | are \fIoffset\fR and \fImaxChars\fR: \fIoffset\fR specifies a starting | |
313 | character position in the selection and \fImaxChars\fR gives the maximum | |
314 | number of characters to retrieve. The command should return a value consisting | |
315 | of at most \fImaxChars\fR of the selection, starting at position | |
316 | \fIoffset\fR. For very large selections (larger than \fImaxChars\fR) | |
317 | the selection will be retrieved using several invocations of \fIcommand\fR | |
318 | with increasing \fIoffset\fR values. If \fIcommand\fR returns a string | |
319 | whose length is less than \fImaxChars\fR, the return value is assumed to | |
320 | include all of the remainder of the selection; if the length of | |
321 | \fIcommand\fR's result is equal to \fImaxChars\fR then | |
322 | \fIcommand\fR will be invoked again, until it eventually | |
323 | returns a result shorter than \fImaxChars\fR. The value of \fImaxChars\fR | |
324 | will always be relatively large (thousands of characters). | |
325 | .VE | |
326 | .PP | |
327 | If \fIcommand\fR returns an error then the selection retrieval is rejected | |
328 | just as if the selection didn't exist at all. | |
329 | .PP | |
330 | The \fIformat\fR argument specifies the representation that should be | |
331 | used to transmit the selection to the requester (the second column of | |
332 | Table 2 of the ICCCM), and defaults to STRING. If \fIformat\fR is | |
333 | STRING, the selection is transmitted as 8-bit ASCII characters (i.e. | |
334 | just in the form returned by \fIcommand\fR). If \fIformat\fR is | |
335 | ATOM, then the return value from \fIcommand\fR is divided into fields | |
336 | separated by white space; each field is converted to its atom value, | |
337 | and the 32-bit atom value is transmitted instead of the atom name. | |
338 | For any other \fIformat\fR, the return value from \fIcommand\fR is | |
339 | divided into fields separated by white space and each field is | |
340 | converted to a 32-bit integer; an array of integers is transmitted | |
341 | to the selection requester. | |
342 | .PP | |
343 | The \fIformat\fR argument is needed only for compatibility with | |
344 | selection requesters that don't use Tk. If Tk is being | |
345 | used to retrieve the selection then the value is converted back to | |
346 | a string at the requesting end, so \fIformat\fR is | |
347 | irrelevant. | |
348 | .RE | |
349 | .TP | |
350 | \fBselection own\fR ?\fB\-displayof\fR \fIwindow\fR? ?\fB\-selection\fR \fIselection\fR? | |
351 | .TP | |
352 | \fBselection own\fR ?\fB\-command\fR \fIcommand\fR? ?\fB\-selection\fR \fIselection\fR? \fIwindow\fR | |
353 | The first form of \fBselection own\fR returns the path name of the | |
354 | window in this application that owns \fIselection\fR on the display | |
355 | containing \fIwindow\fR, or an empty string if no window in this | |
356 | application owns the selection. \fISelection\fR defaults to PRIMARY and | |
357 | \fIwindow\fR defaults to ``.''. | |
358 | .PP | |
359 | The second form of \fBselection own\fR causes \fIwindow\fR to become | |
360 | the new owner of \fIselection\fR on \fIwindow\fR's display, returning | |
361 | an empty string as result. The existing owner, if any, is notified | |
362 | that it has lost the selection. | |
363 | If \fIcommand\fR is specified, it is a Tcl script to execute when | |
364 | some other window claims ownership of the selection away from | |
365 | \fIwindow\fR. \fISelection\fR defaults to PRIMARY. | |
366 | .SH EXAMPLES | |
367 | On X11 platforms, one of the standard selections available is the | |
368 | SECONDARY selection. Hardly anything uses it, but here is how to read | |
369 | it using Tk: | |
370 | .CS | |
371 | set selContents [\fBselection get\fR \-selection SECONDARY] | |
372 | .CE | |
373 | .PP | |
374 | Many different types of data may be available for a selection; the | |
375 | special type TARGETS allows you to get a list of available types: | |
376 | .CS | |
377 | foreach type [\fBselection get\fR \-type TARGETS] { | |
378 | puts "Selection PRIMARY supports type $type" | |
379 | } | |
380 | .CE | |
381 | .PP | |
382 | To claim the selection, you must first set up a handler to supply the | |
383 | data for the selection. Then you have to claim the selection... | |
384 | .CS | |
385 | # Set up the data handler ready for incoming requests | |
386 | set foo "This is a string with some data in it... blah blah" | |
387 | \fBselection handle\fR \-selection SECONDARY . getData | |
388 | proc getData {offset maxChars} { | |
389 | puts "Retrieving selection starting at $offset" | |
390 | return [string range $::foo $offset [expr {$offset+$maxChars}]] | |
391 | } | |
392 | ||
393 | # Now we grab the selection itself | |
394 | puts "Claiming selection" | |
395 | \fBselection own\fR \-command lost \-selection SECONDARY . | |
396 | proc lost {} { | |
397 | puts "Lost selection" | |
398 | } | |
399 | .CE | |
400 | ||
401 | .SH "SEE ALSO" | |
402 | clipboard(n) | |
403 | ||
404 | .SH KEYWORDS | |
405 | clear, format, handler, ICCCM, own, selection, target, type |