Commit | Line | Data |
---|---|---|
920dae64 AT |
1 | '\" |
2 | '\" Copyright (c) 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: BindTable.3,v 1.3 2002/08/05 04:30:38 dgp 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_CreateBindingTable 3 4.0 Tk "Tk Library Procedures" | |
247 | .BS | |
248 | .SH NAME | |
249 | Tk_CreateBindingTable, Tk_DeleteBindingTable, Tk_CreateBinding, Tk_DeleteBinding, Tk_GetBinding, Tk_GetAllBindings, Tk_DeleteAllBindings, Tk_BindEvent \- invoke scripts in response to X events | |
250 | .SH SYNOPSIS | |
251 | .nf | |
252 | \fB#include <tk.h>\fR | |
253 | .sp | |
254 | Tk_BindingTable | |
255 | \fBTk_CreateBindingTable(\fIinterp\fB)\fR | |
256 | .sp | |
257 | \fBTk_DeleteBindingTable(\fIbindingTable\fB)\fR | |
258 | .sp | |
259 | unsigned long | |
260 | \fBTk_CreateBinding(\fIinterp, bindingTable, object, eventString, script, append\fB)\fR | |
261 | .sp | |
262 | int | |
263 | \fBTk_DeleteBinding(\fIinterp, bindingTable, object, eventString\fB)\fR | |
264 | .sp | |
265 | CONST char * | |
266 | \fBTk_GetBinding(\fIinterp, bindingTable, object, eventString\fB)\fR | |
267 | .sp | |
268 | \fBTk_GetAllBindings(\fIinterp, bindingTable, object\fB)\fR | |
269 | .sp | |
270 | \fBTk_DeleteAllBindings(\fIbindingTable, object\fB)\fR | |
271 | .sp | |
272 | \fBTk_BindEvent(\fIbindingTable, eventPtr, tkwin, numObjects, objectPtr\fB)\fR | |
273 | .SH ARGUMENTS | |
274 | .AS Tk_BindingTable bindingTable | |
275 | .AP Tcl_Interp *interp in | |
276 | Interpreter to use when invoking bindings in binding table. Also | |
277 | used for returning results and errors from binding procedures. | |
278 | .AP Tk_BindingTable bindingTable in | |
279 | Token for binding table; must have been returned by some previous | |
280 | call to \fBTk_CreateBindingTable\fR. | |
281 | .AP ClientData object in | |
282 | Identifies object with which binding is associated. | |
283 | .AP "CONST char" *eventString in | |
284 | String describing event sequence. | |
285 | .AP char *script in | |
286 | Tcl script to invoke when binding triggers. | |
287 | .AP int append in | |
288 | Non-zero means append \fIscript\fR to existing script for binding, | |
289 | if any; zero means replace existing script with new one. | |
290 | .AP XEvent *eventPtr in | |
291 | X event to match against bindings in \fIbindingTable\fR. | |
292 | .AP Tk_Window tkwin in | |
293 | Identifier for any window on the display where the event occurred. | |
294 | Used to find display-related information such as key maps. | |
295 | .AP int numObjects in | |
296 | Number of object identifiers pointed to by \fIobjectPtr\fR. | |
297 | .AP ClientData *objectPtr in | |
298 | Points to an array of object identifiers: bindings will be considered | |
299 | for each of these objects in order from first to last. | |
300 | .BE | |
301 | ||
302 | .SH DESCRIPTION | |
303 | .PP | |
304 | These procedures provide a general-purpose mechanism for creating | |
305 | and invoking bindings. | |
306 | Bindings are organized in terms of \fIbinding tables\fR. | |
307 | A binding table consists of a collection of bindings plus a history | |
308 | of recent events. | |
309 | Within a binding table, bindings are associated with \fIobjects\fR. | |
310 | The meaning of an object is defined by clients of the binding package. | |
311 | For example, Tk keeps uses one binding table to hold all of the bindings | |
312 | created by the \fBbind\fR command. | |
313 | For this table, objects are pointers to strings such as window names, class | |
314 | names, or other binding tags such as \fBall\fR. | |
315 | Tk also keeps a separate binding table for each canvas widget, which manages | |
316 | bindings created by the canvas's \fBbind\fR widget command; within | |
317 | this table, an object is either a pointer to the internal structure for a | |
318 | canvas item or a Tk_Uid identifying a tag. | |
319 | .PP | |
320 | The procedure \fBTk_CreateBindingTable\fR creates a new binding | |
321 | table and associates \fIinterp\fR with it (when bindings in the | |
322 | table are invoked, the scripts will be evaluated in \fIinterp\fR). | |
323 | \fBTk_CreateBindingTable\fR returns a token for the table, which | |
324 | must be used in calls to other procedures such as \fBTk_CreateBinding\fR | |
325 | or \fBTk_BindEvent\fR. | |
326 | .PP | |
327 | \fBTk_DeleteBindingTable\fR frees all of the state associated | |
328 | with a binding table. | |
329 | Once it returns the caller should not use the \fIbindingTable\fR | |
330 | token again. | |
331 | .PP | |
332 | \fBTk_CreateBinding\fR adds a new binding to an existing table. | |
333 | The \fIobject\fR argument identifies the object with which the | |
334 | binding is to be associated, and it may be any one-word value. | |
335 | Typically it is a pointer to a string or data structure. | |
336 | The \fIeventString\fR argument identifies the event or sequence | |
337 | of events for the binding; see the documentation for the | |
338 | \fBbind\fR command for a description of its format. | |
339 | \fIscript\fR is the Tcl script to be evaluated when the binding | |
340 | triggers. | |
341 | \fIappend\fR indicates what to do if there already | |
342 | exists a binding for \fIobject\fR and \fIeventString\fR: if \fIappend\fR | |
343 | is zero then \fIscript\fR replaces the old script; if \fIappend\fR | |
344 | is non-zero then the new script is appended to the old one. | |
345 | \fBTk_CreateBinding\fR returns an X event mask for all the events | |
346 | associated with the bindings. | |
347 | This information may be useful to invoke \fBXSelectInput\fR to | |
348 | select relevant events, or to disallow the use of certain events | |
349 | in bindings. | |
350 | If an error occurred while creating the binding (e.g., \fIeventString\fR | |
351 | refers to a non-existent event), then 0 is returned and an error | |
352 | message is left in \fIinterp->result\fR. | |
353 | .PP | |
354 | \fBTk_DeleteBinding\fR removes from \fIbindingTable\fR the | |
355 | binding given by \fIobject\fR and \fIeventString\fR, if | |
356 | such a binding exists. | |
357 | \fBTk_DeleteBinding\fR always returns TCL_OK. | |
358 | In some cases it may reset \fIinterp->result\fR to the default | |
359 | empty value. | |
360 | .PP | |
361 | \fBTk_GetBinding\fR returns a pointer to the script associated | |
362 | with \fIeventString\fR and \fIobject\fR in \fIbindingTable\fR. | |
363 | If no such binding exists then NULL is returned and an error | |
364 | message is left in \fIinterp->result\fR. | |
365 | .PP | |
366 | \fBTk_GetAllBindings\fR returns in \fIinterp->result\fR a list | |
367 | of all the event strings for which there are bindings in | |
368 | \fIbindingTable\fR associated with \fIobject\fR. | |
369 | If there are no bindings for \fIobject\fR then an empty | |
370 | string is returned in \fIinterp->result\fR. | |
371 | .PP | |
372 | \fBTk_DeleteAllBindings\fR deletes all of the bindings in | |
373 | \fIbindingTable\fR that are associated with \fIobject\fR. | |
374 | .PP | |
375 | \fBTk_BindEvent\fR is called to process an event. | |
376 | It makes a copy of the event in an internal history list associated | |
377 | with the binding table, then it checks for bindings that match | |
378 | the event. | |
379 | \fBTk_BindEvent\fR processes each of the objects pointed to | |
380 | by \fIobjectPtr\fR in turn. | |
381 | For each object, it finds all the bindings that match the current | |
382 | event history, selects the most specific binding using the priority | |
383 | mechanism described in the documentation for \fBbind\fR, | |
384 | and invokes the script for that binding. | |
385 | If there are no matching bindings for a particular object, then | |
386 | the object is skipped. | |
387 | \fBTk_BindEvent\fR continues through all of the objects, handling | |
388 | exceptions such as errors, \fBbreak\fR, and \fBcontinue\fR as | |
389 | described in the documentation for \fBbind\fR. | |
390 | ||
391 | .SH KEYWORDS | |
392 | binding, event, object, script |