summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authordonal.k.fellows@manchester.ac.uk <dkf>2004-06-21 21:51:20 (GMT)
committerdonal.k.fellows@manchester.ac.uk <dkf>2004-06-21 21:51:20 (GMT)
commit94ab9336860556f608f21499ded62f25982c1f7e (patch)
tree8c86342f01f77ac34083cd622e1e45babe483b42
parenta828108e0d17391949693f065cd3b0d94e9a7887 (diff)
downloadtk-94ab9336860556f608f21499ded62f25982c1f7e.zip
tk-94ab9336860556f608f21499ded62f25982c1f7e.tar.gz
tk-94ab9336860556f608f21499ded62f25982c1f7e.tar.bz2
Added examples
-rw-r--r--doc/selection.n38
1 files changed, 36 insertions, 2 deletions
diff --git a/doc/selection.n b/doc/selection.n
index 44fda07..1021d19 100644
--- a/doc/selection.n
+++ b/doc/selection.n
@@ -5,7 +5,7 @@
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" RCS: @(#) $Id: selection.n,v 1.4 2001/06/04 03:15:20 hobbs Exp $
+'\" RCS: @(#) $Id: selection.n,v 1.5 2004/06/21 21:51:20 dkf Exp $
'\"
.so man.macros
.TH selection n 8.1 Tk "Tk Built-In Commands"
@@ -128,9 +128,43 @@ that it has lost the selection.
If \fIcommand\fR is specified, it is a Tcl script to execute when
some other window claims ownership of the selection away from
\fIwindow\fR. \fISelection\fR defaults to PRIMARY.
+.SH EXAMPLES
+On X11 platforms, one of the standard selections available is the
+SECONDARY selection. Hardly anything uses it, but here is how to read
+it using Tk:
+.CS
+set selContents [\fBselection\fR get \-selection SECONDARY]
+.CE
+.PP
+Many different types of data may be available for a selection; the
+special type TARGETS allows you to get a list of available types:
+.CS
+foreach type [\fBselection\fR get \-type TARGETS] {
+ puts "Selection PRIMARY supports type $type"
+}
+.CE
+.PP
+To claim the selection, you must first set up a handler to supply the
+data for the selection. Then you have to claim the selection...
+.CS
+# Set up the data handler ready for incoming requests
+set foo "This is a string with some data in it... blah blah"
+\fBselection\fR handle \-selection SECONDARY . getData
+proc getData {offset maxChars} {
+ puts "Retrieving selection starting at $offset"
+ return [string range $::foo $offset [expr {$offset+$maxChars}]]
+}
+
+# Now we grab the selection itself
+puts "Claiming selection"
+\fBselection\fR own \-command lost \-selection SECONDARY .
+proc lost {} {
+ puts "Lost selection"
+}
+.CE
.SH "SEE ALSO"
-clipboard
+clipboard(n)
.SH KEYWORDS
clear, format, handler, ICCCM, own, selection, target, type