Commit | Line | Data |
---|---|---|
920dae64 AT |
1 | '\" |
2 | '\" Copyright (c) 1990 The Regents of the University of California. | |
3 | '\" Copyright (c) 1994-1998 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: GetCursor.3,v 1.5 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_AllocCursorFromObj 3 8.1 Tk "Tk Library Procedures" | |
247 | .BS | |
248 | .SH NAME | |
249 | Tk_AllocCursorFromObj, Tk_GetCursor, Tk_GetCursorFromObj, Tk_GetCursorFromData, Tk_NameOfCursor, Tk_FreeCursorFromObj, Tk_FreeCursor \- maintain database of cursors | |
250 | .SH SYNOPSIS | |
251 | .nf | |
252 | \fB#include <tk.h>\fR | |
253 | .sp | |
254 | .VS 8.1 | |
255 | Tk_Cursor | |
256 | \fBTk_AllocCursorFromObj(\fIinterp, tkwin, objPtr\fB)\fR | |
257 | .sp | |
258 | Tk_Cursor | |
259 | \fBTk_GetCursor(\fIinterp, tkwin, name\fB)\fR | |
260 | .sp | |
261 | Tk_Cursor | |
262 | \fBTk_GetCursorFromObj(\fItkwin, objPtr\fB)\fR | |
263 | .VE | |
264 | .sp | |
265 | Tk_Cursor | |
266 | \fBTk_GetCursorFromData(\fIinterp, tkwin, source, mask, width, height, xHot, yHot, fg, bg\fB)\fR | |
267 | .sp | |
268 | CONST char * | |
269 | \fBTk_NameOfCursor(\fIdisplay, cursor\fB)\fR | |
270 | .sp | |
271 | .VS 8.1 | |
272 | \fBTk_FreeCursorFromObj(\fItkwin, objPtr\fB)\fR | |
273 | .VE | |
274 | .sp | |
275 | \fBTk_FreeCursor(\fIdisplay, cursor\fB)\fR | |
276 | .SH ARGUMENTS | |
277 | .AS "unsigned long" *pixelPtr | |
278 | .AP Tcl_Interp *interp in | |
279 | Interpreter to use for error reporting. | |
280 | .AP Tk_Window tkwin in | |
281 | Token for window in which the cursor will be used. | |
282 | .VS 8.1 br | |
283 | .AP Tcl_Obj *objPtr in/out | |
284 | Description of cursor; see below for possible values. Internal rep will be | |
285 | modified to cache pointer to corresponding Tk_Cursor. | |
286 | .AP char *name in | |
287 | Same as \fIobjPtr\fR except description of cursor is passed as a string and | |
288 | resulting Tk_Cursor isn't cached. | |
289 | .VE | |
290 | .AP "CONST char" *source in | |
291 | Data for cursor cursor, in standard cursor format. | |
292 | .AP "CONST char" *mask in | |
293 | Data for mask cursor, in standard cursor format. | |
294 | .AP "int" width in | |
295 | Width of \fIsource\fR and \fImask\fR. | |
296 | .AP "int" height in | |
297 | Height of \fIsource\fR and \fImask\fR. | |
298 | .AP "int" xHot in | |
299 | X-location of cursor hot-spot. | |
300 | .AP "int" yHot in | |
301 | Y-location of cursor hot-spot. | |
302 | .AP Tk_Uid fg in | |
303 | Textual description of foreground color for cursor. | |
304 | .AP Tk_Uid bg in | |
305 | Textual description of background color for cursor. | |
306 | .AP Display *display in | |
307 | Display for which \fIcursor\fR was allocated. | |
308 | .AP Tk_Cursor cursor in | |
309 | Opaque Tk identifier for cursor. If passed to \fBTk_FreeCursor\fR, must | |
310 | have been returned by some previous call to \fBTk_GetCursor\fR or | |
311 | \fBTk_GetCursorFromData\fR. | |
312 | .BE | |
313 | ||
314 | .SH DESCRIPTION | |
315 | .PP | |
316 | These procedures manage a collection of cursors | |
317 | being used by an application. The procedures allow cursors to be | |
318 | re-used efficiently, thereby avoiding server overhead, and also | |
319 | allow cursors to be named with character strings. | |
320 | .PP | |
321 | .VS 8.1 | |
322 | \fBTk_AllocCursorFromObj\fR takes as argument an object describing a | |
323 | cursor, and returns an opaque Tk identifier for a cursor corresponding | |
324 | to the description. It re-uses an existing cursor if possible and | |
325 | creates a new one otherwise. \fBTk_AllocCursorFromObj\fR caches | |
326 | information about the return value in \fIobjPtr\fR, which speeds up | |
327 | future calls to procedures such as \fBTk_AllocCursorFromObj\fR and | |
328 | \fBTk_GetCursorFromObj\fR. If an error occurs in creating the cursor, | |
329 | such as when \fIobjPtr\fR refers to a non-existent file, then \fBNone\fR | |
330 | is returned and an error message will be stored in \fIinterp\fR's result | |
331 | if \fIinterp\fR isn't NULL. \fIObjPtr\fR must contain a standard Tcl | |
332 | list with one of the following forms: | |
333 | .VE | |
334 | .TP | |
335 | \fIname\fR\0[\fIfgColor\fR\0[\fIbgColor\fR]] | |
336 | \fIName\fR is the name of a cursor in the standard X cursor cursor, | |
337 | i.e., any of the names defined in \fBcursorcursor.h\fR, without | |
338 | the \fBXC_\fR. Some example values are \fBX_cursor\fR, \fBhand2\fR, | |
339 | or \fBleft_ptr\fR. Appendix B of ``The X Window System'' | |
340 | by Scheifler & Gettys has illustrations showing what each of these | |
341 | cursors looks like. If \fIfgColor\fR and \fIbgColor\fR are both | |
342 | specified, they give the foreground and background colors to use | |
343 | for the cursor (any of the forms acceptable to \fBTk_GetColor\fR | |
344 | may be used). If only \fIfgColor\fR is specified, then there | |
345 | will be no background color: the background will be transparent. | |
346 | If no colors are specified, then the cursor | |
347 | will use black for its foreground color and white for its background | |
348 | color. | |
349 | .RS | |
350 | .PP | |
351 | The Macintosh version of Tk supports all of the X cursors and | |
352 | will also accept any of the standard Mac cursors | |
353 | including \fBibeam\fR, \fBcrosshair\fR, \fBwatch\fR, \fBplus\fR, and | |
354 | \fBarrow\fR. In addition, Tk will load Macintosh cursor resources of | |
355 | the types \fBcrsr\fR (color) and \fBCURS\fR (black and white) by the | |
356 | name of the of the resource. The application and all its open | |
357 | dynamic library's resource files will be searched for the named | |
358 | cursor. If there are conflicts color cursors will always be loaded | |
359 | in preference to black and white cursors. | |
360 | .RE | |
361 | .TP | |
362 | \fB@\fIsourceName\0maskName\0fgColor\0bgColor\fR | |
363 | In this form, \fIsourceName\fR and \fImaskName\fR are the names of | |
364 | files describing cursors for the cursor's source bits and mask. | |
365 | Each file must be in standard X11 or X10 cursor format. | |
366 | \fIFgColor\fR and \fIbgColor\fR | |
367 | indicate the colors to use for the | |
368 | cursor, in any of the forms acceptable to \fBTk_GetColor\fR. This | |
369 | form of the command will not work on Macintosh or Windows computers. | |
370 | .TP | |
371 | \fB@\fIsourceName\0fgColor\fR | |
372 | This form is similar to the one above, except that the source is | |
373 | used as mask also. This means that the cursor's background is | |
374 | transparent. This form of the command will not work on Macintosh | |
375 | or Windows computers. | |
376 | .TP | |
377 | \fB@\fIsourceName\fR | |
378 | This form only works on Windows, and will load a Windows system | |
379 | cursor (\fB.ani\fR or \fB.cur\fR) from the file specified in | |
380 | \fIsourceName\fR. | |
381 | .PP | |
382 | .VS 8.1 | |
383 | \fBTk_GetCursor\fR is identical to \fBTk_AllocCursorFromObj\fR except | |
384 | that the description of the cursor is specified with a string instead | |
385 | of an object. This prevents \fBTk_GetCursor\fR from caching the | |
386 | return value, so \fBTk_GetCursor\fR is less efficient than | |
387 | \fBTk_AllocCursorFromObj\fR. | |
388 | .PP | |
389 | \fBTk_GetCursorFromObj\fR returns the token for an existing cursor, given | |
390 | the window and description used to create the cursor. | |
391 | \fBTk_GetCursorFromObj\fR doesn't actually create the cursor; the cursor | |
392 | must already have been created with a previous call to | |
393 | \fBTk_AllocCursorFromObj\fR or \fBTk_GetCursor\fR. The return | |
394 | value is cached in \fIobjPtr\fR, which speeds up | |
395 | future calls to \fBTk_GetCursorFromObj\fR with the same \fIobjPtr\fR | |
396 | and \fItkwin\fR. | |
397 | .VE | |
398 | .PP | |
399 | \fBTk_GetCursorFromData\fR allows cursors to be created from | |
400 | in-memory descriptions of their source and mask cursors. \fISource\fR | |
401 | points to standard cursor data for the cursor's source bits, and | |
402 | \fImask\fR points to standard cursor data describing | |
403 | which pixels of \fIsource\fR are to be drawn and which are to be | |
404 | considered transparent. \fIWidth\fR and \fIheight\fR give the | |
405 | dimensions of the cursor, \fIxHot\fR and \fIyHot\fR indicate the | |
406 | location of the cursor's hot-spot (the point that is reported when | |
407 | an event occurs), and \fIfg\fR and \fIbg\fR describe the cursor's | |
408 | foreground and background colors textually (any of the forms | |
409 | suitable for \fBTk_GetColor\fR may be used). Typically, the | |
410 | arguments to \fBTk_GetCursorFromData\fR are created by including | |
411 | a cursor file directly into the source code for a program, as in | |
412 | the following example: | |
413 | .CS | |
414 | Tk_Cursor cursor; | |
415 | #include "source.cursor" | |
416 | #include "mask.cursor" | |
417 | cursor = Tk_GetCursorFromData(interp, tkwin, source_bits, | |
418 | mask_bits, source_width, source_height, source_x_hot, | |
419 | source_y_hot, Tk_GetUid("red"), Tk_GetUid("blue")); | |
420 | .CE | |
421 | .PP | |
422 | Under normal conditions \fBTk_GetCursorFromData\fR | |
423 | will return an identifier for the requested cursor. If an error | |
424 | occurs in creating the cursor then \fBNone\fR is returned and an error | |
425 | message will be stored in \fIinterp\fR's result. | |
426 | .PP | |
427 | \fBTk_AllocCursorFromObj\fR, \fBTk_GetCursor\fR, and | |
428 | \fBTk_GetCursorFromData\fR maintain a | |
429 | database of all the cursors they have created. Whenever possible, | |
430 | a call to \fBTk_AllocCursorFromObj\fR, \fBTk_GetCursor\fR, or | |
431 | \fBTk_GetCursorFromData\fR will | |
432 | return an existing cursor rather than creating a new one. This | |
433 | approach can substantially reduce server overhead, so the Tk | |
434 | procedures should generally be used in preference to Xlib procedures | |
435 | like \fBXCreateFontCursor\fR or \fBXCreatePixmapCursor\fR, which | |
436 | create a new cursor on each call. The Tk procedures are also more | |
437 | portable than the lower-level X procedures. | |
438 | .PP | |
439 | The procedure \fBTk_NameOfCursor\fR is roughly the inverse of | |
440 | \fBTk_GetCursor\fR. If its \fIcursor\fR argument was created | |
441 | by \fBTk_GetCursor\fR, then the return value is the \fIname\fR | |
442 | argument that was passed to \fBTk_GetCursor\fR to create the | |
443 | cursor. If \fIcursor\fR was created by a call to \fBTk_GetCursorFromData\fR, | |
444 | or by any other mechanism, then the return value is a hexadecimal string | |
445 | giving the X identifier for the cursor. | |
446 | Note: the string returned by \fBTk_NameOfCursor\fR is | |
447 | only guaranteed to persist until the next call to | |
448 | \fBTk_NameOfCursor\fR. Also, this call is not portable except for | |
449 | cursors returned by \fBTk_GetCursor\fR. | |
450 | .PP | |
451 | .VS 8.1 | |
452 | When a cursor returned by \fBTk_AllocCursorFromObj\fR, \fBTk_GetCursor\fR, | |
453 | or \fBTk_GetCursorFromData\fR | |
454 | is no longer needed, \fBTk_FreeCursorFromObj\fR or | |
455 | \fBTk_FreeCursor\fR should be called to release it. | |
456 | For \fBTk_FreeCursorFromObj\fR the cursor to release is specified | |
457 | with the same information used to create it; for | |
458 | \fBTk_FreeCursor\fR the cursor to release is specified | |
459 | with its Tk_Cursor token. | |
460 | There should be exactly one call to \fBTk_FreeCursor\fR for | |
461 | each call to \fBTk_AllocCursorFromObj\fR, \fBTk_GetCursor\fR, | |
462 | or \fBTk_GetCursorFromData\fR. | |
463 | .VE | |
464 | ||
465 | .SH BUGS | |
466 | In determining whether an existing cursor can be used to satisfy | |
467 | a new request, \fBTk_AllocCursorFromObj\fR, \fBTk_GetCursor\fR, | |
468 | and \fBTk_GetCursorFromData\fR | |
469 | consider only the immediate values of their arguments. For | |
470 | example, when a file name is passed to \fBTk_GetCursor\fR, | |
471 | \fBTk_GetCursor\fR will assume it is safe to re-use an existing | |
472 | cursor created from the same file name: it will not check to | |
473 | see whether the file itself has changed, or whether the current | |
474 | directory has changed, thereby causing the name to refer to | |
475 | a different file. Similarly, \fBTk_GetCursorFromData\fR assumes | |
476 | that if the same \fIsource\fR pointer is used in two different calls, | |
477 | then the pointers refer to the same data; it does not check to | |
478 | see if the actual data values have changed. | |
479 | ||
480 | .SH KEYWORDS | |
481 | cursor |