2 '\" Copyright (c) 2000 Ajuba Solutions.
4 '\" See the file "license.terms" for information on usage and redistribution
5 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
7 '\" RCS: @(#) $Id: CrtCmHdlr.3,v 1.1 2000/06/03 08:57:34 hobbs Exp $
9 '\" The definitions below are for supplemental macros used in Tcl/Tk
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)
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.
25 '\" Start box enclosure. From here until next .BE, everything will be
26 '\" enclosed in one large box.
29 '\" End of box enclosure.
32 '\" Begin code excerpt.
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.
45 '\" End of vertical sidebar.
48 '\" Begin an indented unfilled display.
51 '\" End of indented unfilled display.
54 '\" Start of list of standard options for a Tk widget. The
55 '\" options follow on successive lines, in four columns separated
59 '\" End of list of standard options for a Tk widget.
61 '\" .OP cmdName dbName dbClass
62 '\" Start of description of a specific option. cmdName gives the
63 '\" option's name as specified in the class command, dbName gives
64 '\" the option's name in the option database, and dbClass gives
65 '\" the option's class in the option database.
68 '\" Print arg1 underlined, then print arg2 normally.
70 '\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
72 '\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
76 '\" # Start an argument description
80 . ie !"\\$2"" .TP \\n()Cu
85 \&\\$1 \\fI\\$2\\fP (\\$3)
98 '\" # define tabbing values for .AP
101 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
104 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
105 .nr )C \\n()Bu+\\w'(in/out)'u+2n
107 .AS Tcl_Interp Tcl_CreateInterp in/out
108 '\" # BS - start boxed text
109 '\" # ^y = starting y location
117 .if n \l'\\n(.lu\(ul'
120 '\" # BE - end boxed text (draw box now)
125 .ie n \l'\\n(^lu\(ul'
127 .\" Draw four-sided box normally, but don't draw top of
128 .\" box if the box started on an earlier page.
130 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
133 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
140 '\" # VS - start vertical sidebar
141 '\" # ^Y = starting y location
142 '\" # ^v = 1 (for troff; for nroff this doesn't matter)
146 .ie n 'mc \s12\(br\s0
149 '\" # VE - end of vertical sidebar
157 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
164 '\" # Special macro to handle page bottom: finish off current
165 '\" # box/sidebar if in box/sidebar mode, then invoked standard
166 '\" # page bottom macro.
173 .\" Draw three-sided box if this is the box's first page,
174 .\" draw two sides but no top otherwise.
175 .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
176 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
179 .nr ^x \\n(^tu+1v-\\n(^Yu
180 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
193 '\" # DS - begin display
199 '\" # DE - end display
205 '\" # SO - start of list of standard options
207 .SH "STANDARD OPTIONS"
213 '\" # SE - end of list of standard options
218 See the \\fBoptions\\fR manual entry for details on the standard options.
220 '\" # OP - start of full description for a single option
225 Command-Line Name: \\fB\\$1\\fR
226 Database Name: \\fB\\$2\\fR
227 Database Class: \\fB\\$3\\fR
231 '\" # CS - begin code excerpt
237 '\" # CE - end code excerpt
245 .TH Tk_CreateClientMessageHandler 3 "8.4" Tk "Tk Library Procedures"
248 Tk_CreateClientMessageHandler, Tk_DeleteClientMessageHandler \- associate procedure callback with ClientMessage type X events
251 \fB#include <tk.h>\fR
253 \fBTk_CreateClientMessageHandler\fR(\fIproc\fR)
255 \fBTk_DeleteClientMessageHandler\fR(\fIproc\fR)
257 .AP Tk_ClientMessageProc *proc in
258 Procedure to invoke whenever a ClientMessage X event occurs on any display.
264 \fBTk_CreateClientMessageHandler\fR arranges for \fIproc\fR to be invoked
265 in the future whenever a ClientMessage X event occurs that isn't handled by
266 \fBWM_PROTOCOL\fR. \fBTk_CreateClientMessageHandler\fR is intended for use
267 by applications which need to watch X ClientMessage events, such as drag and
270 The callback to \fIproc\fR will be made by \fBTk_HandleEvent\fR;
271 this mechanism only works in programs that dispatch events
272 through \fBTk_HandleEvent\fR (or through other Tk procedures that
273 call \fBTk_HandleEvent\fR, such as \fBTk_DoOneEvent\fR or
276 \fIProc\fR should have arguments and result that match the
277 type \fBTk_ClientMessageProc\fR:
279 typedef int Tk_ClientMessageProc(
280 Tk_Window \fItkwin\fR,
281 XEvent *\fIeventPtr\fR);
283 The \fItkwin\fR parameter to \fIproc\fR is the Tk window which is
284 associated with this event. \fIEventPtr\fR is a pointer to the X event.
286 Whenever an X ClientMessage event is processed by \fBTk_HandleEvent\fR,
287 the \fIproc\fR is called if it wasn't handled as a \fBWM_PROTOCOL\fR.
288 The return value from \fIproc\fR is normally 0.
289 A non-zero return value indicates that the event is not to be handled
290 further; that is, \fIproc\fR has done all processing that is to be
291 allowed for the event.
293 If there are multiple ClientMessage event handlers, each one is called
294 for each event, in the order in which they were established.
296 \fBTk_DeleteClientMessageHandler\fR may be called to delete a
297 previously-created ClientMessage event handler: it deletes each handler it
298 finds that matches the \fIproc\fR argument. If no such handler exists,
299 then \fBTk_DeleteClientMessageHandler\fR returns without doing anything.
300 Although Tk supports it, it's probably a bad idea to have more than one
301 callback with the same \fIproc\fR argument.
304 bind, callback, event, handler