util/X86LINUX64/man/man3/Tk_CreateSelHandler.3

   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 .TH Tk_CreateSelHandler 3 4.0 Tk "Tk Library Procedures"
   9 .\" The -*- nroff -*- definitions below are for supplemental macros used
  10 .\" in Tcl/Tk manual entries.
  11 .\"
  12 .\" .AP type name in/out ?indent?
  13 .\"     Start paragraph describing an argument to a library procedure.
  14 .\"     type is type of argument (int, etc.), in/out is either "in", "out",
  15 .\"     or "in/out" to describe whether procedure reads or modifies arg,
  16 .\"     and indent is equivalent to second arg of .IP (shouldn't ever be
  17 .\"     needed;  use .AS below instead)
  18 .\"
  19 .\" .AS ?type? ?name?
  20 .\"     Give maximum sizes of arguments for setting tab stops.  Type and
  21 .\"     name are examples of largest possible arguments that will be passed
  22 .\"     to .AP later.  If args are omitted, default tab stops are used.
  23 .\"
  24 .\" .BS
  25 .\"     Start box enclosure.  From here until next .BE, everything will be
  26 .\"     enclosed in one large box.
  27 .\"
  28 .\" .BE
  29 .\"     End of box enclosure.
  30 .\"
  31 .\" .CS
  32 .\"     Begin code excerpt.
  33 .\"
  34 .\" .CE
  35 .\"     End code excerpt.
  36 .\"
  37 .\" .VS ?version? ?br?
  38 .\"     Begin vertical sidebar, for use in marking newly-changed parts
  39 .\"     of man pages.  The first argument is ignored and used for recording
  40 .\"     the version when the .VS was added, so that the sidebars can be
  41 .\"     found and removed when they reach a certain age.  If another argument
  42 .\"     is present, then a line break is forced before starting the sidebar.
  43 .\"
  44 .\" .VE
  45 .\"     End of vertical sidebar.
  46 .\"
  47 .\" .DS
  48 .\"     Begin an indented unfilled display.
  49 .\"
  50 .\" .DE
  51 .\"     End of indented unfilled display.
  52 .\"
  53 .\" .SO ?manpage?
  54 .\"     Start of list of standard options for a Tk widget. The manpage
  55 .\"     argument defines where to look up the standard options; if
  56 .\"     omitted, defaults to "options". The options follow on successive
  57 .\"     lines, in three columns separated 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 .\" .QW arg1 ?arg2?
  72 .\"     Print arg1 in quotes, then arg2 normally (for trailing punctuation).
  73 .\"
  74 .\" .PQ arg1 ?arg2?
  75 .\"     Print an open parenthesis, arg1 in quotes, then arg2 normally
  76 .\"     (for trailing punctuation) and then a closing parenthesis.
  77 .\"
  78 .\"     # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
  79 .if t .wh -1.3i ^B
  80 .nr ^l \n(.l
  81 .ad b
  82 .\"     # Start an argument description
  83 .de AP
  84 .ie !"\\$4"" .TP \\$4
  85 .el \{\
  86 .   ie !"\\$2"" .TP \\n()Cu
  87 .   el          .TP 15
  88 .\}
  89 .ta \\n()Au \\n()Bu
  90 .ie !"\\$3"" \{\
  91 \&\\$1 \\fI\\$2\\fP (\\$3)
  92 .\".b
  93 .\}
  94 .el \{\
  95 .br
  96 .ie !"\\$2"" \{\
  97 \&\\$1  \\fI\\$2\\fP
  98 .\}
  99 .el \{\
 100 \&\\fI\\$1\\fP
 101 .\}
 102 .\}
 103 ..
 104 .\"     # define tabbing values for .AP
 105 .de AS
 106 .nr )A 10n
 107 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
 108 .nr )B \\n()Au+15n
 109 .\"
 110 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
 111 .nr )C \\n()Bu+\\w'(in/out)'u+2n
 112 ..
 113 .AS Tcl_Interp Tcl_CreateInterp in/out
 114 .\"     # BS - start boxed text
 115 .\"     # ^y = starting y location
 116 .\"     # ^b = 1
 117 .de BS
 118 .br
 119 .mk ^y
 120 .nr ^b 1u
 121 .if n .nf
 122 .if n .ti 0
 123 .if n \l'\\n(.lu\(ul'
 124 .if n .fi
 125 ..
 126 .\"     # BE - end boxed text (draw box now)
 127 .de BE
 128 .nf
 129 .ti 0
 130 .mk ^t
 131 .ie n \l'\\n(^lu\(ul'
 132 .el \{\
 133 .\"     Draw four-sided box normally, but don't draw top of
 134 .\"     box if the box started on an earlier page.
 135 .ie !\\n(^b-1 \{\
 136 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 137 .\}
 138 .el \}\
 139 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
 140 .\}
 141 .\}
 142 .fi
 143 .br
 144 .nr ^b 0
 145 ..
 146 .\"     # VS - start vertical sidebar
 147 .\"     # ^Y = starting y location
 148 .\"     # ^v = 1 (for troff;  for nroff this doesn't matter)
 149 .de VS
 150 .if !"\\$2"" .br
 151 .mk ^Y
 152 .ie n 'mc \s12\(br\s0
 153 .el .nr ^v 1u
 154 ..
 155 .\"     # VE - end of vertical sidebar
 156 .de VE
 157 .ie n 'mc
 158 .el \{\
 159 .ev 2
 160 .nf
 161 .ti 0
 162 .mk ^t
 163 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
 164 .sp -1
 165 .fi
 166 .ev
 167 .\}
 168 .nr ^v 0
 169 ..
 170 .\"     # Special macro to handle page bottom:  finish off current
 171 .\"     # box/sidebar if in box/sidebar mode, then invoked standard
 172 .\"     # page bottom macro.
 173 .de ^B
 174 .ev 2
 175 'ti 0
 176 'nf
 177 .mk ^t
 178 .if \\n(^b \{\
 179 .\"     Draw three-sided box if this is the box's first page,
 180 .\"     draw two sides but no top otherwise.
 181 .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
 182 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
 183 .\}
 184 .if \\n(^v \{\
 185 .nr ^x \\n(^tu+1v-\\n(^Yu
 186 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
 187 .\}
 188 .bp
 189 'fi
 190 .ev
 191 .if \\n(^b \{\
 192 .mk ^y
 193 .nr ^b 2
 194 .\}
 195 .if \\n(^v \{\
 196 .mk ^Y
 197 .\}
 198 ..
 199 .\"     # DS - begin display
 200 .de DS
 201 .RS
 202 .nf
 203 .sp
 204 ..
 205 .\"     # DE - end display
 206 .de DE
 207 .fi
 208 .RE
 209 .sp
 210 ..
 211 .\"     # SO - start of list of standard options
 212 .de SO
 213 'ie '\\$1'' .ds So \\fBoptions\\fR
 214 'el .ds So \\fB\\$1\\fR
 215 .SH "STANDARD OPTIONS"
 216 .LP
 217 .nf
 218 .ta 5.5c 11c
 219 .ft B
 220 ..
 221 .\"     # SE - end of list of standard options
 222 .de SE
 223 .fi
 224 .ft R
 225 .LP
 226 See the \\*(So manual entry for details on the standard options.
 227 ..
 228 .\"     # OP - start of full description for a single option
 229 .de OP
 230 .LP
 231 .nf
 232 .ta 4c
 233 Command-Line Name:      \\fB\\$1\\fR
 234 Database Name:  \\fB\\$2\\fR
 235 Database Class: \\fB\\$3\\fR
 236 .fi
 237 .IP
 238 ..
 239 .\"     # CS - begin code excerpt
 240 .de CS
 241 .RS
 242 .nf
 243 .ta .25i .5i .75i 1i
 244 ..
 245 .\"     # CE - end code excerpt
 246 .de CE
 247 .fi
 248 .RE
 249 ..
 250 .\"     # UL - underline word
 251 .de UL
 252 \\$1\l'|0\(ul'\\$2
 253 ..
 254 .\"     # QW - apply quotation marks to word
 255 .de QW
 256 .ie '\\*(lq'"' ``\\$1''\\$2
 257 .\"" fix emacs highlighting
 258 .el \\*(lq\\$1\\*(rq\\$2
 259 ..
 260 .\"     # PQ - apply parens and quotation marks to word
 261 .de PQ
 262 .ie '\\*(lq'"' (``\\$1''\\$2)\\$3
 263 .\"" fix emacs highlighting
 264 .el (\\*(lq\\$1\\*(rq\\$2)\\$3
 265 ..
 266 .\"     # QR - quoted range
 267 .de QR
 268 .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
 269 .\"" fix emacs highlighting
 270 .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
 271 ..
 272 .\"     # MT - "empty" string
 273 .de MT
 274 .QW ""
 275 ..
 276 .BS
 277 .SH NAME
 278 Tk_CreateSelHandler, Tk_DeleteSelHandler \- arrange to handle requests for a selection
 279 .SH SYNOPSIS
 280 .nf
 281 \fB#include <tk.h>\fR
 282 .sp
 283 \fBTk_CreateSelHandler\fR(\fItkwin, selection, target, proc, clientData, format\fR)
 284 .sp
 285 \fBTk_DeleteSelHandler\fR(\fItkwin, selection, target\fR)
 286 .SH ARGUMENTS
 287 .AS Tk_SelectionProc clientData
 288 .AP Tk_Window tkwin in
 289 Window for which \fIproc\fR will provide selection information.
 290 .AP Atom selection in
 291 The name of the selection for which \fIproc\fR will provide
 292 selection information.
 293 .AP Atom target in
 294 Form in which \fIproc\fR can provide the selection (e.g. STRING
 295 or FILE_NAME).  Corresponds to \fItype\fR arguments in \fBselection\fR
 296 commands.
 297 .AP Tk_SelectionProc *proc in
 298 Procedure to invoke whenever the selection is owned by \fItkwin\fR
 299 and the selection contents are requested in the format given by
 300 \fItarget\fR.
 301 .AP ClientData clientData in
 302 Arbitrary one-word value to pass to \fIproc\fR.
 303 .AP Atom format in
 304 If the selection requestor is not in this process, \fIformat\fR determines
 305 the representation used to transmit the selection to its
 306 requestor.
 307 .BE
 308 .SH DESCRIPTION
 309 .PP
 310 \fBTk_CreateSelHandler\fR arranges for a particular procedure
 311 (\fIproc\fR) to be called whenever \fIselection\fR is owned by
 312 \fItkwin\fR and the selection contents are requested in the
 313 form given by \fItarget\fR.
 314 \fITarget\fR should be one of
 315 the entries defined in the left column of Table 2 of the
 316 X Inter-Client Communication Conventions Manual (ICCCM) or
 317 any other form in which an application is willing to present
 318 the selection.  The most common form is STRING.
 319 .PP
 320 \fIProc\fR should have arguments and result that match the
 321 type \fBTk_SelectionProc\fR:
 322 .CS
 323 typedef int \fBTk_SelectionProc\fR(
 324         ClientData \fIclientData\fR,
 325         int \fIoffset\fR,
 326         char *\fIbuffer\fR,
 327         int \fImaxBytes\fR);
 328 .CE
 329 The \fIclientData\fR parameter to \fIproc\fR is a copy of the
 330 \fIclientData\fR argument given to \fBTk_CreateSelHandler\fR.
 331 Typically, \fIclientData\fR points to a data
 332 structure containing application-specific information that is
 333 needed to retrieve the selection.  \fIOffset\fR specifies an
 334 offset position into the selection, \fIbuffer\fR specifies a
 335 location at which to copy information about the selection, and
 336 \fImaxBytes\fR specifies the amount of space available at
 337 \fIbuffer\fR.  \fIProc\fR should place a NULL-terminated string
 338 at \fIbuffer\fR containing \fImaxBytes\fR or fewer characters
 339 (not including the terminating NULL), and it should return a
 340 count of the number of non-NULL characters stored at
 341 \fIbuffer\fR.  If the selection no longer exists (e.g. it once
 342 existed but the user deleted the range of characters containing
 343 it), then \fIproc\fR should return \-1.
 344 .PP
 345 When transferring large selections, Tk will break them up into
 346 smaller pieces (typically a few thousand bytes each) for more
 347 efficient transmission.  It will do this by calling \fIproc\fR
 348 one or more times, using successively higher values of \fIoffset\fR
 349 to retrieve successive portions of the selection.  If \fIproc\fR
 350 returns a count less than \fImaxBytes\fR it means that the entire
 351 remainder of the selection has been returned.  If \fIproc\fR's return
 352 value is \fImaxBytes\fR it means there may be additional information
 353 in the selection, so Tk must make another call to \fIproc\fR to
 354 retrieve the next portion.
 355 .PP
 356 \fIProc\fR always returns selection information in the form of a
 357 character string.  However, the ICCCM allows for information to
 358 be transmitted from the selection owner to the selection requestor
 359 in any of several formats, such as a string, an array of atoms, an
 360 array of integers, etc.  The \fIformat\fR argument to
 361 \fBTk_CreateSelHandler\fR indicates what format should be used to
 362 transmit the selection to its requestor (see the middle column of
 363 Table 2 of the ICCCM for examples).  If \fIformat\fR is not
 364 STRING, then Tk will take the value returned by \fIproc\fR and divided
 365 it into fields separated by white space.  If \fIformat\fR is ATOM,
 366 then Tk will return the selection as an array of atoms, with each
 367 field in \fIproc\fR's result treated as the name of one atom.  For
 368 any other value of \fIformat\fR, Tk will return the selection as an
 369 array of 32-bit values where each field of \fIproc\fR's result is
 370 treated as a number and translated to a 32-bit value.  In any event,
 371 the \fIformat\fR atom is returned to the selection requestor along
 372 with the contents of the selection.
 373 .PP
 374 If \fBTk_CreateSelHandler\fR is called when there already exists a
 375 handler for \fIselection\fR and \fItarget\fR on \fItkwin\fR, then the
 376 existing handler is replaced with a new one.
 377 .PP
 378 \fBTk_DeleteSelHandler\fR removes the handler given by \fItkwin\fR,
 379 \fIselection\fR, and \fItarget\fR, if such a handler exists.
 380 If there is no such handler then it has no effect.
 381 .SH KEYWORDS
 382 format, handler, selection, target