2 '\" Copyright (c) 1990 The Regents of the University of California.
3 '\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
5 '\" See the file "license.terms" for information on usage and redistribution
6 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
8 '\" RCS: @(#) $Id: EventHndlr.3,v 1.4 1999/04/21 21:53:21 rjohnson Exp $
10 '\" The definitions below are for supplemental macros used in Tcl/Tk
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)
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.
26 '\" Start box enclosure. From here until next .BE, everything will be
27 '\" enclosed in one large box.
30 '\" End of box enclosure.
33 '\" Begin code excerpt.
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.
46 '\" End of vertical sidebar.
49 '\" Begin an indented unfilled display.
52 '\" End of indented unfilled display.
55 '\" Start of list of standard options for a Tk widget. The
56 '\" options follow on successive lines, in four columns separated
60 '\" End of list of standard options for a Tk widget.
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.
69 '\" Print arg1 underlined, then print arg2 normally.
71 '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
73 '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
77 '\" # Start an argument description
81 . ie !"\\$2"" .TP \\n()Cu
86 \&\\$1 \\fI\\$2\\fP (\\$3)
99 '\" # define tabbing values for .AP
102 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
105 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
106 .nr )C \\n()Bu+\\w'(in/out)'u+2n
108 .AS Tcl_Interp Tcl_CreateInterp in/out
109 '\" # BS - start boxed text
110 '\" # ^y = starting y location
118 .if n \l'\\n(.lu\(ul'
121 '\" # BE - end boxed text (draw box now)
126 .ie n \l'\\n(^lu\(ul'
128 .\" Draw four-sided box normally, but don't draw top of
129 .\" box if the box started on an earlier page.
131 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
134 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
141 '\" # VS - start vertical sidebar
142 '\" # ^Y = starting y location
143 '\" # ^v = 1 (for troff; for nroff this doesn't matter)
147 .ie n 'mc \s12\(br\s0
150 '\" # VE - end of vertical sidebar
158 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
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.
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
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
194 '\" # DS - begin display
200 '\" # DE - end display
206 '\" # SO - start of list of standard options
208 .SH "STANDARD OPTIONS"
214 '\" # SE - end of list of standard options
219 See the \\fBoptions\\fR manual entry for details on the standard options.
221 '\" # OP - start of full description for a single option
226 Command-Line Name: \\fB\\$1\\fR
227 Database Name: \\fB\\$2\\fR
228 Database Class: \\fB\\$3\\fR
232 '\" # CS - begin code excerpt
238 '\" # CE - end code excerpt
246 .TH Tk_CreateEventHandler 3 "" Tk "Tk Library Procedures"
249 Tk_CreateEventHandler, Tk_DeleteEventHandler \- associate procedure callback with an X event
252 \fB#include <tk.h>\fR
254 \fBTk_CreateEventHandler\fR(\fItkwin, mask, proc, clientData\fR)
256 \fBTk_DeleteEventHandler\fR(\fItkwin, mask, proc, clientData\fR)
258 .AS "unsigned long" clientData
259 .AP Tk_Window tkwin in
260 Token for window in which events may occur.
261 .AP "unsigned long" mask in
262 Bit-mask of events (such as \fBButtonPressMask\fR)
263 for which \fIproc\fR should be called.
264 .AP Tk_EventProc *proc in
265 Procedure to invoke whenever an event in \fImask\fR occurs
266 in the window given by \fItkwin\fR.
267 .AP ClientData clientData in
268 Arbitrary one-word value to pass to \fIproc\fR.
273 \fBTk_CreateEventHandler\fR arranges for \fIproc\fR to be
274 invoked in the future whenever one of the event types specified
275 by \fImask\fR occurs in the window specified by \fItkwin\fR.
276 The callback to \fIproc\fR will be made by \fBTk_HandleEvent\fR;
277 this mechanism only works in programs that dispatch events
278 through \fBTk_HandleEvent\fR (or through other Tk procedures that
279 call \fBTk_HandleEvent\fR, such as \fBTk_DoOneEvent\fR or
282 \fIProc\fR should have arguments and result that match the
283 type \fBTk_EventProc\fR:
285 typedef void Tk_EventProc(
286 ClientData \fIclientData\fR,
287 XEvent *\fIeventPtr\fR);
289 The \fIclientData\fR parameter to \fIproc\fR is a copy of the \fIclientData\fR
290 argument given to \fBTk_CreateEventHandler\fR when the callback
291 was created. Typically, \fIclientData\fR points to a data
292 structure containing application-specific information about
293 the window in which the event occurred. \fIEventPtr\fR is
294 a pointer to the X event, which will be one of the ones
295 specified in the \fImask\fR argument to \fBTk_CreateEventHandler\fR.
297 \fBTk_DeleteEventHandler\fR may be called to delete a
298 previously-created event handler: it deletes the first handler
299 it finds that is associated with \fItkwin\fR and matches the
300 \fImask\fR, \fIproc\fR, and \fIclientData\fR arguments. If
301 no such handler exists, then \fBTk_HandleEvent\fR returns
302 without doing anything. Although Tk supports it, it's probably
303 a bad idea to have more than one callback with the same \fImask\fR,
304 \fIproc\fR, and \fIclientData\fR arguments.
305 When a window is deleted all of its handlers will be deleted
306 automatically; in this case there is no need to call
307 \fBTk_DeleteEventHandler\fR.
309 If multiple handlers are declared for the same type of X event
310 on the same window, then the handlers will be invoked in the
311 order they were created.
314 bind, callback, event, handler