| '\" |
| '\" Copyright (c) 1990-1994 The Regents of the University of California. |
| '\" Copyright (c) 1994-1996 Sun Microsystems, Inc. |
| '\" |
| '\" See the file "license.terms" for information on usage and redistribution |
| '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES. |
| '\" |
| '\" RCS: @(#) $Id: CrtSelHdlr.3,v 1.2 1998/09/14 18:22:47 stanton Exp $ |
| '\" |
| '\" The definitions below are for supplemental macros used in Tcl/Tk |
| '\" manual entries. |
| '\" |
| '\" .AP type name in/out ?indent? |
| '\" Start paragraph describing an argument to a library procedure. |
| '\" type is type of argument (int, etc.), in/out is either "in", "out", |
| '\" or "in/out" to describe whether procedure reads or modifies arg, |
| '\" and indent is equivalent to second arg of .IP (shouldn't ever be |
| '\" needed; use .AS below instead) |
| '\" |
| '\" .AS ?type? ?name? |
| '\" Give maximum sizes of arguments for setting tab stops. Type and |
| '\" name are examples of largest possible arguments that will be passed |
| '\" to .AP later. If args are omitted, default tab stops are used. |
| '\" |
| '\" .BS |
| '\" Start box enclosure. From here until next .BE, everything will be |
| '\" enclosed in one large box. |
| '\" |
| '\" .BE |
| '\" End of box enclosure. |
| '\" |
| '\" .CS |
| '\" Begin code excerpt. |
| '\" |
| '\" .CE |
| '\" End code excerpt. |
| '\" |
| '\" .VS ?version? ?br? |
| '\" Begin vertical sidebar, for use in marking newly-changed parts |
| '\" of man pages. The first argument is ignored and used for recording |
| '\" the version when the .VS was added, so that the sidebars can be |
| '\" found and removed when they reach a certain age. If another argument |
| '\" is present, then a line break is forced before starting the sidebar. |
| '\" |
| '\" .VE |
| '\" End of vertical sidebar. |
| '\" |
| '\" .DS |
| '\" Begin an indented unfilled display. |
| '\" |
| '\" .DE |
| '\" End of indented unfilled display. |
| '\" |
| '\" .SO |
| '\" Start of list of standard options for a Tk widget. The |
| '\" options follow on successive lines, in four columns separated |
| '\" by tabs. |
| '\" |
| '\" .SE |
| '\" End of list of standard options for a Tk widget. |
| '\" |
| '\" .OP cmdName dbName dbClass |
| '\" Start of description of a specific option. cmdName gives the |
| '\" option's name as specified in the class command, dbName gives |
| '\" the option's name in the option database, and dbClass gives |
| '\" the option's class in the option database. |
| '\" |
| '\" .UL arg1 arg2 |
| '\" Print arg1 underlined, then print arg2 normally. |
| '\" |
| '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $ |
| '\" |
| '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages. |
| .if t .wh -1.3i ^B |
| .nr ^l \n(.l |
| .ad b |
| '\" # Start an argument description |
| .de AP |
| .ie !"\\$4"" .TP \\$4 |
| .el \{\ |
| . ie !"\\$2"" .TP \\n()Cu |
| . el .TP 15 |
| .\} |
| .ta \\n()Au \\n()Bu |
| .ie !"\\$3"" \{\ |
| \&\\$1 \\fI\\$2\\fP (\\$3) |
| .\".b |
| .\} |
| .el \{\ |
| .br |
| .ie !"\\$2"" \{\ |
| \&\\$1 \\fI\\$2\\fP |
| .\} |
| .el \{\ |
| \&\\fI\\$1\\fP |
| .\} |
| .\} |
| .. |
| '\" # define tabbing values for .AP |
| .de AS |
| .nr )A 10n |
| .if !"\\$1"" .nr )A \\w'\\$1'u+3n |
| .nr )B \\n()Au+15n |
| .\" |
| .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n |
| .nr )C \\n()Bu+\\w'(in/out)'u+2n |
| .. |
| .AS Tcl_Interp Tcl_CreateInterp in/out |
| '\" # BS - start boxed text |
| '\" # ^y = starting y location |
| '\" # ^b = 1 |
| .de BS |
| .br |
| .mk ^y |
| .nr ^b 1u |
| .if n .nf |
| .if n .ti 0 |
| .if n \l'\\n(.lu\(ul' |
| .if n .fi |
| .. |
| '\" # BE - end boxed text (draw box now) |
| .de BE |
| .nf |
| .ti 0 |
| .mk ^t |
| .ie n \l'\\n(^lu\(ul' |
| .el \{\ |
| .\" Draw four-sided box normally, but don't draw top of |
| .\" box if the box started on an earlier page. |
| .ie !\\n(^b-1 \{\ |
| \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' |
| .\} |
| .el \}\ |
| \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul' |
| .\} |
| .\} |
| .fi |
| .br |
| .nr ^b 0 |
| .. |
| '\" # VS - start vertical sidebar |
| '\" # ^Y = starting y location |
| '\" # ^v = 1 (for troff; for nroff this doesn't matter) |
| .de VS |
| .if !"\\$2"" .br |
| .mk ^Y |
| .ie n 'mc \s12\(br\s0 |
| .el .nr ^v 1u |
| .. |
| '\" # VE - end of vertical sidebar |
| .de VE |
| .ie n 'mc |
| .el \{\ |
| .ev 2 |
| .nf |
| .ti 0 |
| .mk ^t |
| \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n' |
| .sp -1 |
| .fi |
| .ev |
| .\} |
| .nr ^v 0 |
| .. |
| '\" # Special macro to handle page bottom: finish off current |
| '\" # box/sidebar if in box/sidebar mode, then invoked standard |
| '\" # page bottom macro. |
| .de ^B |
| .ev 2 |
| 'ti 0 |
| 'nf |
| .mk ^t |
| .if \\n(^b \{\ |
| .\" Draw three-sided box if this is the box's first page, |
| .\" draw two sides but no top otherwise. |
| .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 |
| .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c |
| .\} |
| .if \\n(^v \{\ |
| .nr ^x \\n(^tu+1v-\\n(^Yu |
| \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c |
| .\} |
| .bp |
| 'fi |
| .ev |
| .if \\n(^b \{\ |
| .mk ^y |
| .nr ^b 2 |
| .\} |
| .if \\n(^v \{\ |
| .mk ^Y |
| .\} |
| .. |
| '\" # DS - begin display |
| .de DS |
| .RS |
| .nf |
| .sp |
| .. |
| '\" # DE - end display |
| .de DE |
| .fi |
| .RE |
| .sp |
| .. |
| '\" # SO - start of list of standard options |
| .de SO |
| .SH "STANDARD OPTIONS" |
| .LP |
| .nf |
| .ta 5.5c 11c |
| .ft B |
| .. |
| '\" # SE - end of list of standard options |
| .de SE |
| .fi |
| .ft R |
| .LP |
| See the \\fBoptions\\fR manual entry for details on the standard options. |
| .. |
| '\" # OP - start of full description for a single option |
| .de OP |
| .LP |
| .nf |
| .ta 4c |
| Command-Line Name: \\fB\\$1\\fR |
| Database Name: \\fB\\$2\\fR |
| Database Class: \\fB\\$3\\fR |
| .fi |
| .IP |
| .. |
| '\" # CS - begin code excerpt |
| .de CS |
| .RS |
| .nf |
| .ta .25i .5i .75i 1i |
| .. |
| '\" # CE - end code excerpt |
| .de CE |
| .fi |
| .RE |
| .. |
| .de UL |
| \\$1\l'|0\(ul'\\$2 |
| .. |
| .TH Tk_CreateSelHandler 3 4.0 Tk "Tk Library Procedures" |
| .BS |
| .SH NAME |
| Tk_CreateSelHandler, Tk_DeleteSelHandler \- arrange to handle requests for a selection |
| .SH SYNOPSIS |
| .nf |
| \fB#include <tk.h>\fR |
| .sp |
| \fBTk_CreateSelHandler\fR(\fItkwin, selection, target, proc, clientData, format\fR) |
| .sp |
| \fBTk_DeleteSelHandler\fR(\fItkwin, selection, target\fR) |
| .SH ARGUMENTS |
| .AS Tk_SelectionProc clientData |
| .AP Tk_Window tkwin in |
| Window for which \fIproc\fR will provide selection information. |
| .AP Atom selection in |
| The name of the selection for which \fIproc\fR will provide |
| selection information. |
| .AP Atom target in |
| Form in which \fIproc\fR can provide the selection (e.g. STRING |
| or FILE_NAME). Corresponds to \fItype\fR arguments in \fBselection\fR |
| commands. |
| .AP Tk_SelectionProc *proc in |
| Procedure to invoke whenever the selection is owned by \fItkwin\fR |
| and the selection contents are requested in the format given by |
| \fItarget\fR. |
| .AP ClientData clientData in |
| Arbitrary one-word value to pass to \fIproc\fR. |
| .AP Atom format in |
| If the selection requestor isn't in this process, \fIformat\fR determines |
| the representation used to transmit the selection to its |
| requestor. |
| .BE |
| |
| .SH DESCRIPTION |
| .PP |
| \fBTk_CreateSelHandler\fR arranges for a particular procedure |
| (\fIproc\fR) to be called whenever \fIselection\fR is owned by |
| \fItkwin\fR and the selection contents are requested in the |
| form given by \fItarget\fR. |
| \fITarget\fR should be one of |
| the entries defined in the left column of Table 2 of the |
| X Inter-Client Communication Conventions Manual (ICCCM) or |
| any other form in which an application is willing to present |
| the selection. The most common form is STRING. |
| .PP |
| \fIProc\fR should have arguments and result that match the |
| type \fBTk_SelectionProc\fR: |
| .CS |
| typedef int Tk_SelectionProc( |
| ClientData \fIclientData\fR, |
| int \fIoffset\fR, |
| char *\fIbuffer\fR, |
| int \fImaxBytes\fR); |
| .CE |
| The \fIclientData\fR parameter to \fIproc\fR is a copy of the |
| \fIclientData\fR argument given to \fBTk_CreateSelHandler\fR. |
| Typically, \fIclientData\fR points to a data |
| structure containing application-specific information that is |
| needed to retrieve the selection. \fIOffset\fR specifies an |
| offset position into the selection, \fIbuffer\fR specifies a |
| location at which to copy information about the selection, and |
| \fImaxBytes\fR specifies the amount of space available at |
| \fIbuffer\fR. \fIProc\fR should place a NULL-terminated string |
| at \fIbuffer\fR containing \fImaxBytes\fR or fewer characters |
| (not including the terminating NULL), and it should return a |
| count of the number of non-NULL characters stored at |
| \fIbuffer\fR. If the selection no longer exists (e.g. it once |
| existed but the user deleted the range of characters containing |
| it), then \fIproc\fR should return -1. |
| .PP |
| When transferring large selections, Tk will break them up into |
| smaller pieces (typically a few thousand bytes each) for more |
| efficient transmission. It will do this by calling \fIproc\fR |
| one or more times, using successively higher values of \fIoffset\fR |
| to retrieve successive portions of the selection. If \fIproc\fR |
| returns a count less than \fImaxBytes\fR it means that the entire |
| remainder of the selection has been returned. If \fIproc\fR's return |
| value is \fImaxBytes\fR it means there may be additional information |
| in the selection, so Tk must make another call to \fIproc\fR to |
| retrieve the next portion. |
| .PP |
| \fIProc\fR always returns selection information in the form of a |
| character string. However, the ICCCM allows for information to |
| be transmitted from the selection owner to the selection requestor |
| in any of several formats, such as a string, an array of atoms, an |
| array of integers, etc. The \fIformat\fR argument to |
| \fBTk_CreateSelHandler\fR indicates what format should be used to |
| transmit the selection to its requestor (see the middle column of |
| Table 2 of the ICCCM for examples). If \fIformat\fR is not |
| STRING, then Tk will take the value returned by \fIproc\fR and divided |
| it into fields separated by white space. If \fIformat\fR is ATOM, |
| then Tk will return the selection as an array of atoms, with each |
| field in \fIproc\fR's result treated as the name of one atom. For |
| any other value of \fIformat\fR, Tk will return the selection as an |
| array of 32-bit values where each field of \fIproc\fR's result is |
| treated as a number and translated to a 32-bit value. In any event, |
| the \fIformat\fR atom is returned to the selection requestor along |
| with the contents of the selection. |
| .PP |
| If \fBTk_CreateSelHandler\fR is called when there already exists a |
| handler for \fIselection\fR and \fItarget\fR on \fItkwin\fR, then the |
| existing handler is replaced with a new one. |
| .PP |
| \fBTk_DeleteSelHandler\fR removes the handler given by \fItkwin\fR, |
| \fIselection\fR, and \fItarget\fR, if such a handler exists. |
| If there is no such handler then it has no effect. |
| |
| .SH KEYWORDS |
| format, handler, selection, target |