Commit | Line | Data |
---|---|---|
920dae64 AT |
1 | '\" |
2 | '\" Copyright (c) 1990 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: CrtErrHdlr.3,v 1.2 1998/09/14 18:22:46 stanton 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_CreateErrorHandler 3 "" Tk "Tk Library Procedures" | |
247 | .BS | |
248 | .SH NAME | |
249 | Tk_CreateErrorHandler, Tk_DeleteErrorHandler \- handle X protocol errors | |
250 | .SH SYNOPSIS | |
251 | .nf | |
252 | \fB#include <tk.h>\fR | |
253 | .sp | |
254 | Tk_ErrorHandler | |
255 | \fBTk_CreateErrorHandler\fR(\fIdisplay, error, request, minor, proc, clientData\fR) | |
256 | .sp | |
257 | \fBTk_DeleteErrorHandler\fR(\fIhandler\fR) | |
258 | .SH ARGUMENTS | |
259 | .AS "Tk_ErrorHandler" clientData | |
260 | .AP Display *display in | |
261 | Display whose errors are to be handled. | |
262 | .AP int error in | |
263 | Match only error events with this value in the \fIerror_code\fR | |
264 | field. If -1, then match any \fIerror_code\fR value. | |
265 | .AP int request in | |
266 | Match only error events with this value in the \fIrequest_code\fR | |
267 | field. If -1, then match any \fIrequest_code\fR value. | |
268 | .AP int minor in | |
269 | Match only error events with this value in the \fIminor_code\fR | |
270 | field. If -1, then match any \fIminor_code\fR value. | |
271 | .AP Tk_ErrorProc *proc in | |
272 | Procedure to invoke whenever an error event is received for | |
273 | \fIdisplay\fR and matches \fIerror\fR, \fIrequest\fR, and \fIminor\fR. | |
274 | NULL means ignore any matching errors. | |
275 | .AP ClientData clientData in | |
276 | Arbitrary one-word value to pass to \fIproc\fR. | |
277 | .AP Tk_ErrorHandler handler in | |
278 | Token for error handler to delete (return value from a previous | |
279 | call to \fBTk_CreateErrorHandler\fR). | |
280 | .BE | |
281 | ||
282 | .SH DESCRIPTION | |
283 | .PP | |
284 | \fBTk_CreateErrorHandler\fR arranges for a particular procedure | |
285 | (\fIproc\fR) to be called whenever certain protocol errors occur on a | |
286 | particular display (\fIdisplay\fR). Protocol errors occur when | |
287 | the X protocol is used incorrectly, such as attempting to map a window | |
288 | that doesn't exist. See the Xlib documentation for \fBXSetErrorHandler\fR | |
289 | for more information on the kinds of errors that can occur. | |
290 | For \fIproc\fR to be invoked | |
291 | to handle a particular error, five things must occur: | |
292 | .IP [1] | |
293 | The error must pertain to \fIdisplay\fR. | |
294 | .IP [2] | |
295 | Either the \fIerror\fR argument to \fBTk_CreateErrorHandler\fR | |
296 | must have been -1, or the \fIerror\fR argument must match | |
297 | the \fIerror_code\fR field from the error event. | |
298 | .IP [3] | |
299 | Either the \fIrequest\fR argument to \fBTk_CreateErrorHandler\fR | |
300 | must have been -1, or the \fIrequest\fR argument must match | |
301 | the \fIrequest_code\fR field from the error event. | |
302 | .IP [4] | |
303 | Either the \fIminor\fR argument to \fBTk_CreateErrorHandler\fR | |
304 | must have been -1, or the \fIminor\fR argument must match | |
305 | the \fIminor_code\fR field from the error event. | |
306 | .IP [5] | |
307 | The protocol request to which the error pertains must have been | |
308 | made when the handler was active (see below for more information). | |
309 | .PP | |
310 | \fIProc\fR should have arguments and result that match the | |
311 | following type: | |
312 | .CS | |
313 | typedef int Tk_ErrorProc( | |
314 | ClientData \fIclientData\fR, | |
315 | XErrorEvent *\fIerrEventPtr\fR); | |
316 | .CE | |
317 | The \fIclientData\fR parameter to \fIproc\fR is a copy of the \fIclientData\fR | |
318 | argument given to \fBTcl_CreateErrorHandler\fR when the callback | |
319 | was created. Typically, \fIclientData\fR points to a data | |
320 | structure containing application-specific information that is | |
321 | needed to deal with the error. \fIErrEventPtr\fR is | |
322 | a pointer to the X error event. | |
323 | The procedure \fIproc\fR should return an integer value. If it | |
324 | returns 0 it means that \fIproc\fR handled the error completely and there | |
325 | is no need to take any other action for the error. If it returns | |
326 | non-zero it means \fIproc\fR was unable to handle the error. | |
327 | .PP | |
328 | If a value of NULL is specified for \fIproc\fR, all matching errors | |
329 | will be ignored: this will produce the same result as if a procedure | |
330 | had been specified that always returns 0. | |
331 | .PP | |
332 | If more than more than one handler matches a particular error, then | |
333 | they are invoked in turn. The handlers will be invoked in reverse | |
334 | order of creation: most recently declared handler first. | |
335 | If any handler returns 0, then subsequent (older) handlers will | |
336 | not be invoked. If no handler returns 0, then Tk invokes X'es | |
337 | default error handler, which prints an error message and aborts the | |
338 | program. If you wish to have a default handler that deals with errors | |
339 | that no other handler can deal with, then declare it first. | |
340 | .PP | |
341 | The X documentation states that ``the error handler should not call | |
342 | any functions (directly or indirectly) on the display that will | |
343 | generate protocol requests or that will look for input events.'' | |
344 | This restriction applies to handlers declared by \fBTk_CreateErrorHandler\fR; | |
345 | disobey it at your own risk. | |
346 | .PP | |
347 | \fBTk_DeleteErrorHandler\fR may be called to delete a | |
348 | previously-created error handler. The \fIhandler\fR argument | |
349 | identifies the error handler, and should be a value returned by | |
350 | a previous call to \fBTk_CreateEventHandler\fR. | |
351 | .PP | |
352 | A particular error handler applies to errors resulting | |
353 | from protocol requests generated between | |
354 | the call to \fBTk_CreateErrorHandler\fR and the call to | |
355 | \fBTk_DeleteErrorHandler\fR. However, the actual callback | |
356 | to \fIproc\fR may not occur until after the \fBTk_DeleteErrorHandler\fR | |
357 | call, due to buffering in the client and server. | |
358 | If an error event pertains to | |
359 | a protocol request made just before calling \fBTk_DeleteErrorHandler\fR, | |
360 | then the error event may not have been processed | |
361 | before the \fBTk_DeleteErrorHandler\fR | |
362 | call. When this situation arises, Tk will save information about | |
363 | the handler and | |
364 | invoke the handler's \fIproc\fR later when the error event | |
365 | finally arrives. | |
366 | If an application wishes to delete an error handler and know | |
367 | for certain that all relevant errors have been processed, | |
368 | it should first call \fBTk_DeleteErrorHandler\fR and then | |
369 | call \fBXSync\fR; this will flush out any buffered requests and errors, | |
370 | but will result in a performance penalty because | |
371 | it requires communication to and from the X server. After the | |
372 | \fBXSync\fR call Tk is guaranteed not to call any error | |
373 | handlers deleted before the \fBXSync\fR call. | |
374 | .PP | |
375 | For the Tk error handling mechanism to work properly, it is essential | |
376 | that application code never calls \fBXSetErrorHandler\fR directly; | |
377 | applications should use only \fBTk_CreateErrorHandler\fR. | |
378 | ||
379 | .SH KEYWORDS | |
380 | callback, error, event, handler |