[OpenSPARC-T2-SAM] / sam-t2 / devtools / v9 / man / man3 / Tk_CreateClientMessageHandler.3

'\"
'\" Copyright (c) 2000 Ajuba Solutions.
'\"
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\" 
'\" RCS: @(#) $Id: CrtCmHdlr.3,v 1.1 2000/06/03 08:57:34 hobbs 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_CreateClientMessageHandler 3 "8.4" Tk "Tk Library Procedures"
.BS
.SH NAME
Tk_CreateClientMessageHandler, Tk_DeleteClientMessageHandler \- associate procedure callback with ClientMessage type X events
.SH SYNOPSIS
.nf
\fB#include <tk.h>\fR
.sp
\fBTk_CreateClientMessageHandler\fR(\fIproc\fR)
.sp
\fBTk_DeleteClientMessageHandler\fR(\fIproc\fR)
.SH ARGUMENTS
.AP Tk_ClientMessageProc *proc in
Procedure to invoke whenever a ClientMessage X event occurs on any display.
.BE

.SH DESCRIPTION
.PP

\fBTk_CreateClientMessageHandler\fR arranges for \fIproc\fR to be invoked
in the future whenever a ClientMessage X event occurs that isn't handled by
\fBWM_PROTOCOL\fR.  \fBTk_CreateClientMessageHandler\fR is intended for use
by applications which need to watch X ClientMessage events, such as drag and
drop applications.
.PP
The callback to \fIproc\fR will be made by \fBTk_HandleEvent\fR;
this mechanism only works in programs that dispatch events
through \fBTk_HandleEvent\fR (or through other Tk procedures that
call \fBTk_HandleEvent\fR, such as \fBTk_DoOneEvent\fR or
\fBTk_MainLoop\fR).
.PP
\fIProc\fR should have arguments and result that match the
type \fBTk_ClientMessageProc\fR:
.CS
typedef int Tk_ClientMessageProc(
	Tk_Window \fItkwin\fR,
	XEvent *\fIeventPtr\fR);
.CE
The \fItkwin\fR parameter to \fIproc\fR is the Tk window which is
associated with this event.  \fIEventPtr\fR is a pointer to the X event.
.PP
Whenever an X ClientMessage event is processed by \fBTk_HandleEvent\fR,
the \fIproc\fR is called if it wasn't handled as a \fBWM_PROTOCOL\fR.
The return value from \fIproc\fR is normally 0.
A non-zero return value indicates that the event is not to be handled
further; that is, \fIproc\fR has done all processing that is to be
allowed for the event.
.PP
If there are multiple ClientMessage event handlers, each one is called
for each event, in the order in which they were established.
.PP
\fBTk_DeleteClientMessageHandler\fR may be called to delete a
previously-created ClientMessage event handler: it deletes each handler it
finds that matches the \fIproc\fR argument.  If no such handler exists,
then \fBTk_DeleteClientMessageHandler\fR returns without doing anything.
Although Tk supports it, it's probably a bad idea to have more than one
callback with the same \fIproc\fR argument.

.SH KEYWORDS
bind, callback, event, handler
Commit	Line	Data
920dae64 AT	1	'\"
	2	'\" Copyright (c) 2000 Ajuba Solutions.
	3	'\"
	4	'\" See the file "license.terms" for information on usage and redistribution
	5	'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
	6	'\"
	7	'\" RCS: @(#) $Id: CrtCmHdlr.3,v 1.1 2000/06/03 08:57:34 hobbs Exp $
	8	'\"
	9	'\" The definitions below are for supplemental macros used in Tcl/Tk
	10	'\" 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
	54	'\" Start of list of standard options for a Tk widget. The
	55	'\" options follow on successive lines, in four columns separated
	56	'\" by tabs.
	57	'\"
	58	'\" .SE
	59	'\" End of list of standard options for a Tk widget.
	60	'\"
	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.
66	'\"
67	'\" .UL arg1 arg2
68	'\" Print arg1 underlined, then print arg2 normally.
69	'\"
70	'\" RCS: @(#) $Id: man.macros,v 1.4 2000/08/25 06:18:32 ericm Exp $
71	'\"
72	'\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
73	.if t .wh -1.3i ^B
74	.nr ^l \n(.l
75	.ad b
76	'\" # Start an argument description
77	.de AP
78	.ie !"\\$4"" .TP \\$4
79	.el \{\
80	. ie !"\\$2"" .TP \\n()Cu
81	. el .TP 15
82	.\}
83	.ta \\n()Au \\n()Bu
84	.ie !"\\$3"" \{\
85	\&\\$1 \\fI\\$2\\fP (\\$3)
86	.\".b
87	.\}
88	.el \{\
89	.br
90	.ie !"\\$2"" \{\
91	\&\\$1 \\fI\\$2\\fP
92	.\}
93	.el \{\
94	\&\\fI\\$1\\fP
95	.\}
96	.\}
97	..
98	'\" # define tabbing values for .AP
99	.de AS
100	.nr )A 10n
101	.if !"\\$1"" .nr )A \\w'\\$1'u+3n
102	.nr )B \\n()Au+15n
103	.\"
104	.if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
105	.nr )C \\n()Bu+\\w'(in/out)'u+2n
106	..
107	.AS Tcl_Interp Tcl_CreateInterp in/out
108	'\" # BS - start boxed text
109	'\" # ^y = starting y location
110	'\" # ^b = 1
111	.de BS
112	.br
113	.mk ^y
114	.nr ^b 1u
115	.if n .nf
116	.if n .ti 0
117	.if n \l'\\n(.lu\(ul'
118	.if n .fi
119	..
120	'\" # BE - end boxed text (draw box now)
121	.de BE
122	.nf
123	.ti 0
124	.mk ^t
125	.ie n \l'\\n(^lu\(ul'
126	.el \{\
127	.\" Draw four-sided box normally, but don't draw top of
128	.\" box if the box started on an earlier page.
129	.ie !\\n(^b-1 \{\
130	\h'-1.5n'\L'\|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'\|0u-1.5n\(ul'
131	.\}
132	.el \}\
133	\h'-1.5n'\L'\|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'\|0u-1.5n\(ul'
134	.\}
135	.\}
136	.fi
137	.br
138	.nr ^b 0
139	..
140	'\" # VS - start vertical sidebar
141	'\" # ^Y = starting y location
142	'\" # ^v = 1 (for troff; for nroff this doesn't matter)
143	.de VS
144	.if !"\\$2"" .br
145	.mk ^Y
146	.ie n 'mc \s12\(br\s0
147	.el .nr ^v 1u
148	..
149	'\" # VE - end of vertical sidebar
150	.de VE
151	.ie n 'mc
152	.el \{\
153	.ev 2
154	.nf
155	.ti 0
156	.mk ^t
157	\h'\|\\n(^lu+3n'\L'\|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-\|\\n(^lu+3n'
158	.sp -1
159	.fi
160	.ev
161	.\}
162	.nr ^v 0
163	..
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.
167	.de ^B
168	.ev 2
169	'ti 0
170	'nf
171	.mk ^t
172	.if \\n(^b \{\
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
177	.\}
178	.if \\n(^v \{\
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
181	.\}
182	.bp
183	'fi
184	.ev
185	.if \\n(^b \{\
186	.mk ^y
187	.nr ^b 2
188	.\}
189	.if \\n(^v \{\
190	.mk ^Y
191	.\}
192	..
193	'\" # DS - begin display
194	.de DS
195	.RS
196	.nf
197	.sp
198	..
199	'\" # DE - end display
200	.de DE
201	.fi
202	.RE
203	.sp
204	..
205	'\" # SO - start of list of standard options
206	.de SO
207	.SH "STANDARD OPTIONS"
208	.LP
209	.nf
210	.ta 5.5c 11c
211	.ft B
212	..
213	'\" # SE - end of list of standard options
214	.de SE
215	.fi
216	.ft R
217	.LP
218	See the \\fBoptions\\fR manual entry for details on the standard options.
219	..
220	'\" # OP - start of full description for a single option
221	.de OP
222	.LP
223	.nf
224	.ta 4c
225	Command-Line Name: \\fB\\$1\\fR
226	Database Name: \\fB\\$2\\fR
227	Database Class: \\fB\\$3\\fR
228	.fi
229	.IP
230	..
231	'\" # CS - begin code excerpt
232	.de CS
233	.RS
234	.nf
235	.ta .25i .5i .75i 1i
236	..
237	'\" # CE - end code excerpt
238	.de CE
239	.fi
240	.RE
241	..
242	.de UL
243	\\$1\l'\|0\(ul'\\$2
244	..
245	.TH Tk_CreateClientMessageHandler 3 "8.4" Tk "Tk Library Procedures"
246	.BS
247	.SH NAME
248	Tk_CreateClientMessageHandler, Tk_DeleteClientMessageHandler \- associate procedure callback with ClientMessage type X events
249	.SH SYNOPSIS
250	.nf
251	\fB#include <tk.h>\fR
252	.sp
253	\fBTk_CreateClientMessageHandler\fR(\fIproc\fR)
254	.sp
255	\fBTk_DeleteClientMessageHandler\fR(\fIproc\fR)
256	.SH ARGUMENTS
257	.AP Tk_ClientMessageProc *proc in
258	Procedure to invoke whenever a ClientMessage X event occurs on any display.
259	.BE
260
261	.SH DESCRIPTION
262	.PP
263
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
268	drop applications.
269	.PP
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
274	\fBTk_MainLoop\fR).
275	.PP
276	\fIProc\fR should have arguments and result that match the
277	type \fBTk_ClientMessageProc\fR:
278	.CS
279	typedef int Tk_ClientMessageProc(
280	Tk_Window \fItkwin\fR,
281	XEvent *\fIeventPtr\fR);
282	.CE
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.
285	.PP
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.
292	.PP
293	If there are multiple ClientMessage event handlers, each one is called
294	for each event, in the order in which they were established.
295	.PP
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.
302
303	.SH KEYWORDS
304	bind, callback, event, handler