| 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: CrtSelHdlr.3,v 1.2 1998/09/14 18:22:47 stanton 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 Tk_CreateSelHandler 3 4.0 Tk "Tk Library Procedures" |
| 247 | .BS |
| 248 | .SH NAME |
| 249 | Tk_CreateSelHandler, Tk_DeleteSelHandler \- arrange to handle requests for a selection |
| 250 | .SH SYNOPSIS |
| 251 | .nf |
| 252 | \fB#include <tk.h>\fR |
| 253 | .sp |
| 254 | \fBTk_CreateSelHandler\fR(\fItkwin, selection, target, proc, clientData, format\fR) |
| 255 | .sp |
| 256 | \fBTk_DeleteSelHandler\fR(\fItkwin, selection, target\fR) |
| 257 | .SH ARGUMENTS |
| 258 | .AS Tk_SelectionProc clientData |
| 259 | .AP Tk_Window tkwin in |
| 260 | Window for which \fIproc\fR will provide selection information. |
| 261 | .AP Atom selection in |
| 262 | The name of the selection for which \fIproc\fR will provide |
| 263 | selection information. |
| 264 | .AP Atom target in |
| 265 | Form in which \fIproc\fR can provide the selection (e.g. STRING |
| 266 | or FILE_NAME). Corresponds to \fItype\fR arguments in \fBselection\fR |
| 267 | commands. |
| 268 | .AP Tk_SelectionProc *proc in |
| 269 | Procedure to invoke whenever the selection is owned by \fItkwin\fR |
| 270 | and the selection contents are requested in the format given by |
| 271 | \fItarget\fR. |
| 272 | .AP ClientData clientData in |
| 273 | Arbitrary one-word value to pass to \fIproc\fR. |
| 274 | .AP Atom format in |
| 275 | If the selection requestor isn't in this process, \fIformat\fR determines |
| 276 | the representation used to transmit the selection to its |
| 277 | requestor. |
| 278 | .BE |
| 279 | |
| 280 | .SH DESCRIPTION |
| 281 | .PP |
| 282 | \fBTk_CreateSelHandler\fR arranges for a particular procedure |
| 283 | (\fIproc\fR) to be called whenever \fIselection\fR is owned by |
| 284 | \fItkwin\fR and the selection contents are requested in the |
| 285 | form given by \fItarget\fR. |
| 286 | \fITarget\fR should be one of |
| 287 | the entries defined in the left column of Table 2 of the |
| 288 | X Inter-Client Communication Conventions Manual (ICCCM) or |
| 289 | any other form in which an application is willing to present |
| 290 | the selection. The most common form is STRING. |
| 291 | .PP |
| 292 | \fIProc\fR should have arguments and result that match the |
| 293 | type \fBTk_SelectionProc\fR: |
| 294 | .CS |
| 295 | typedef int Tk_SelectionProc( |
| 296 | ClientData \fIclientData\fR, |
| 297 | int \fIoffset\fR, |
| 298 | char *\fIbuffer\fR, |
| 299 | int \fImaxBytes\fR); |
| 300 | .CE |
| 301 | The \fIclientData\fR parameter to \fIproc\fR is a copy of the |
| 302 | \fIclientData\fR argument given to \fBTk_CreateSelHandler\fR. |
| 303 | Typically, \fIclientData\fR points to a data |
| 304 | structure containing application-specific information that is |
| 305 | needed to retrieve the selection. \fIOffset\fR specifies an |
| 306 | offset position into the selection, \fIbuffer\fR specifies a |
| 307 | location at which to copy information about the selection, and |
| 308 | \fImaxBytes\fR specifies the amount of space available at |
| 309 | \fIbuffer\fR. \fIProc\fR should place a NULL-terminated string |
| 310 | at \fIbuffer\fR containing \fImaxBytes\fR or fewer characters |
| 311 | (not including the terminating NULL), and it should return a |
| 312 | count of the number of non-NULL characters stored at |
| 313 | \fIbuffer\fR. If the selection no longer exists (e.g. it once |
| 314 | existed but the user deleted the range of characters containing |
| 315 | it), then \fIproc\fR should return -1. |
| 316 | .PP |
| 317 | When transferring large selections, Tk will break them up into |
| 318 | smaller pieces (typically a few thousand bytes each) for more |
| 319 | efficient transmission. It will do this by calling \fIproc\fR |
| 320 | one or more times, using successively higher values of \fIoffset\fR |
| 321 | to retrieve successive portions of the selection. If \fIproc\fR |
| 322 | returns a count less than \fImaxBytes\fR it means that the entire |
| 323 | remainder of the selection has been returned. If \fIproc\fR's return |
| 324 | value is \fImaxBytes\fR it means there may be additional information |
| 325 | in the selection, so Tk must make another call to \fIproc\fR to |
| 326 | retrieve the next portion. |
| 327 | .PP |
| 328 | \fIProc\fR always returns selection information in the form of a |
| 329 | character string. However, the ICCCM allows for information to |
| 330 | be transmitted from the selection owner to the selection requestor |
| 331 | in any of several formats, such as a string, an array of atoms, an |
| 332 | array of integers, etc. The \fIformat\fR argument to |
| 333 | \fBTk_CreateSelHandler\fR indicates what format should be used to |
| 334 | transmit the selection to its requestor (see the middle column of |
| 335 | Table 2 of the ICCCM for examples). If \fIformat\fR is not |
| 336 | STRING, then Tk will take the value returned by \fIproc\fR and divided |
| 337 | it into fields separated by white space. If \fIformat\fR is ATOM, |
| 338 | then Tk will return the selection as an array of atoms, with each |
| 339 | field in \fIproc\fR's result treated as the name of one atom. For |
| 340 | any other value of \fIformat\fR, Tk will return the selection as an |
| 341 | array of 32-bit values where each field of \fIproc\fR's result is |
| 342 | treated as a number and translated to a 32-bit value. In any event, |
| 343 | the \fIformat\fR atom is returned to the selection requestor along |
| 344 | with the contents of the selection. |
| 345 | .PP |
| 346 | If \fBTk_CreateSelHandler\fR is called when there already exists a |
| 347 | handler for \fIselection\fR and \fItarget\fR on \fItkwin\fR, then the |
| 348 | existing handler is replaced with a new one. |
| 349 | .PP |
| 350 | \fBTk_DeleteSelHandler\fR removes the handler given by \fItkwin\fR, |
| 351 | \fIselection\fR, and \fItarget\fR, if such a handler exists. |
| 352 | If there is no such handler then it has no effect. |
| 353 | |
| 354 | .SH KEYWORDS |
| 355 | format, handler, selection, target |