2 '\" Copyright (c) 1990 The Regents of the University of California.
3 '\" Copyright (c) 1994-1998 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 .TH Tk_AllocCursorFromObj 3 8.1 Tk "Tk Library Procedures"
9 .\" The -*- nroff -*- definitions below are for supplemental macros used
10 .\" in Tcl/Tk manual entries.
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 manpage
55 .\" argument defines where to look up the standard options; if
56 .\" omitted, defaults to "options". The options follow on successive
57 .\" lines, in three columns separated by tabs.
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.
72 .\" Print arg1 in quotes, then arg2 normally (for trailing punctuation).
75 .\" Print an open parenthesis, arg1 in quotes, then arg2 normally
76 .\" (for trailing punctuation) and then a closing parenthesis.
78 .\" # Set up traps and other miscellaneous stuff for Tcl/Tk man pages.
82 .\" # Start an argument description
86 . ie !"\\$2"" .TP \\n()Cu
91 \&\\$1 \\fI\\$2\\fP (\\$3)
104 .\" # define tabbing values for .AP
107 .if !"\\$1"" .nr )A \\w'\\$1'u+3n
110 .if !"\\$2"" .nr )B \\w'\\$2'u+\\n()Au+3n
111 .nr )C \\n()Bu+\\w'(in/out)'u+2n
113 .AS Tcl_Interp Tcl_CreateInterp in/out
114 .\" # BS - start boxed text
115 .\" # ^y = starting y location
123 .if n \l'\\n(.lu\(ul'
126 .\" # BE - end boxed text (draw box now)
131 .ie n \l'\\n(^lu\(ul'
133 .\" Draw four-sided box normally, but don't draw top of
134 .\" box if the box started on an earlier page.
136 \h'-1.5n'\L'|\\n(^yu-1v'\l'\\n(^lu+3n\(ul'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
139 \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\l'|0u-1.5n\(ul'
146 .\" # VS - start vertical sidebar
147 .\" # ^Y = starting y location
148 .\" # ^v = 1 (for troff; for nroff this doesn't matter)
152 .ie n 'mc \s12\(br\s0
155 .\" # VE - end of vertical sidebar
163 \h'|\\n(^lu+3n'\L'|\\n(^Yu-1v\(bv'\v'\\n(^tu+1v-\\n(^Yu'\h'-|\\n(^lu+3n'
170 .\" # Special macro to handle page bottom: finish off current
171 .\" # box/sidebar if in box/sidebar mode, then invoked standard
172 .\" # page bottom macro.
179 .\" Draw three-sided box if this is the box's first page,
180 .\" draw two sides but no top otherwise.
181 .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
182 .el \h'-1.5n'\L'|\\n(^yu-1v'\h'\\n(^lu+3n'\L'\\n(^tu+1v-\\n(^yu'\h'|0u'\c
185 .nr ^x \\n(^tu+1v-\\n(^Yu
186 \kx\h'-\\nxu'\h'|\\n(^lu+3n'\ky\L'-\\n(^xu'\v'\\n(^xu'\h'|0u'\c
199 .\" # DS - begin display
205 .\" # DE - end display
211 .\" # SO - start of list of standard options
213 'ie '\\$1'' .ds So \\fBoptions\\fR
214 'el .ds So \\fB\\$1\\fR
215 .SH "STANDARD OPTIONS"
221 .\" # SE - end of list of standard options
226 See the \\*(So manual entry for details on the standard options.
228 .\" # OP - start of full description for a single option
233 Command-Line Name: \\fB\\$1\\fR
234 Database Name: \\fB\\$2\\fR
235 Database Class: \\fB\\$3\\fR
239 .\" # CS - begin code excerpt
245 .\" # CE - end code excerpt
250 .\" # UL - underline word
254 .\" # QW - apply quotation marks to word
256 .ie '\\*(lq'"' ``\\$1''\\$2
257 .\"" fix emacs highlighting
258 .el \\*(lq\\$1\\*(rq\\$2
260 .\" # PQ - apply parens and quotation marks to word
262 .ie '\\*(lq'"' (``\\$1''\\$2)\\$3
263 .\"" fix emacs highlighting
264 .el (\\*(lq\\$1\\*(rq\\$2)\\$3
266 .\" # QR - quoted range
268 .ie '\\*(lq'"' ``\\$1''\\-``\\$2''\\$3
269 .\"" fix emacs highlighting
270 .el \\*(lq\\$1\\*(rq\\-\\*(lq\\$2\\*(rq\\$3
272 .\" # MT - "empty" string
278 Tk_AllocCursorFromObj, Tk_GetCursor, Tk_GetCursorFromObj, Tk_GetCursorFromData, Tk_NameOfCursor, Tk_FreeCursorFromObj, Tk_FreeCursor \- maintain database of cursors
281 \fB#include <tk.h>\fR
284 \fBTk_AllocCursorFromObj(\fIinterp, tkwin, objPtr\fB)\fR
287 \fBTk_GetCursor(\fIinterp, tkwin, name\fB)\fR
290 \fBTk_GetCursorFromObj(\fItkwin, objPtr\fB)\fR
293 \fBTk_GetCursorFromData(\fIinterp, tkwin, source, mask, width, height, xHot, yHot, fg, bg\fB)\fR
296 \fBTk_NameOfCursor(\fIdisplay, cursor\fB)\fR
298 \fBTk_FreeCursorFromObj(\fItkwin, objPtr\fB)\fR
300 \fBTk_FreeCursor(\fIdisplay, cursor\fB)\fR
302 .AS "unsigned long" *pixelPtr
303 .AP Tcl_Interp *interp in
304 Interpreter to use for error reporting.
305 .AP Tk_Window tkwin in
306 Token for window in which the cursor will be used.
307 .AP Tcl_Obj *objPtr in/out
308 Description of cursor; see below for possible values. Internal rep will be
309 modified to cache pointer to corresponding Tk_Cursor.
311 Same as \fIobjPtr\fR except description of cursor is passed as a string and
312 resulting Tk_Cursor is not cached.
313 .AP "const char" *source in
314 Data for cursor cursor, in standard cursor format.
315 .AP "const char" *mask in
316 Data for mask cursor, in standard cursor format.
318 Width of \fIsource\fR and \fImask\fR.
320 Height of \fIsource\fR and \fImask\fR.
322 X-location of cursor hot-spot.
324 Y-location of cursor hot-spot.
326 Textual description of foreground color for cursor.
328 Textual description of background color for cursor.
329 .AP Display *display in
330 Display for which \fIcursor\fR was allocated.
331 .AP Tk_Cursor cursor in
332 Opaque Tk identifier for cursor. If passed to \fBTk_FreeCursor\fR, must
333 have been returned by some previous call to \fBTk_GetCursor\fR or
334 \fBTk_GetCursorFromData\fR.
338 These procedures manage a collection of cursors
339 being used by an application. The procedures allow cursors to be
340 re-used efficiently, thereby avoiding server overhead, and also
341 allow cursors to be named with character strings.
343 \fBTk_AllocCursorFromObj\fR takes as argument an object describing a
344 cursor, and returns an opaque Tk identifier for a cursor corresponding
345 to the description. It re-uses an existing cursor if possible and
346 creates a new one otherwise. \fBTk_AllocCursorFromObj\fR caches
347 information about the return value in \fIobjPtr\fR, which speeds up
348 future calls to procedures such as \fBTk_AllocCursorFromObj\fR and
349 \fBTk_GetCursorFromObj\fR. If an error occurs in creating the cursor,
350 such as when \fIobjPtr\fR refers to a non-existent file, then \fBNone\fR
351 is returned and an error message will be stored in \fIinterp\fR's result
352 if \fIinterp\fR is not NULL. \fIObjPtr\fR must contain a standard Tcl
353 list with one of the following forms:
355 \fIname\fR\0[\fIfgColor\fR\0[\fIbgColor\fR]]
356 \fIName\fR is the name of a cursor in the standard X cursor cursor,
357 i.e., any of the names defined in \fBcursorcursor.h\fR, without
358 the \fBXC_\fR. Some example values are \fBX_cursor\fR, \fBhand2\fR,
359 or \fBleft_ptr\fR. Appendix B of
360 .QW "The X Window System"
361 by Scheifler & Gettys has illustrations showing what each of these
362 cursors looks like. If \fIfgColor\fR and \fIbgColor\fR are both
363 specified, they give the foreground and background colors to use
364 for the cursor (any of the forms acceptable to \fBTk_GetColor\fR
365 may be used). If only \fIfgColor\fR is specified, then there
366 will be no background color: the background will be transparent.
367 If no colors are specified, then the cursor
368 will use black for its foreground color and white for its background
372 The Macintosh version of Tk supports all of the X cursors and
373 will also accept any of the standard Mac cursors
374 including \fBibeam\fR, \fBcrosshair\fR, \fBwatch\fR, \fBplus\fR, and
375 \fBarrow\fR. In addition, Tk will load Macintosh cursor resources of
376 the types \fBcrsr\fR (color) and \fBCURS\fR (black and white) by the
377 name of the resource. The application and all its open
378 dynamic library's resource files will be searched for the named
379 cursor. If there are conflicts color cursors will always be loaded
380 in preference to black and white cursors.
383 \fB@\fIsourceName\0maskName\0fgColor\0bgColor\fR
384 In this form, \fIsourceName\fR and \fImaskName\fR are the names of
385 files describing cursors for the cursor's source bits and mask.
386 Each file must be in standard X11 cursor format.
387 \fIFgColor\fR and \fIbgColor\fR
388 indicate the colors to use for the
389 cursor, in any of the forms acceptable to \fBTk_GetColor\fR. This
390 form of the command will not work on Macintosh or Windows computers.
392 \fB@\fIsourceName\0fgColor\fR
393 This form is similar to the one above, except that the source is
394 used as mask also. This means that the cursor's background is
395 transparent. This form of the command will not work on Macintosh
396 or Windows computers.
399 This form only works on Windows, and will load a Windows system
400 cursor (\fB.ani\fR or \fB.cur\fR) from the file specified in
403 \fBTk_GetCursor\fR is identical to \fBTk_AllocCursorFromObj\fR except
404 that the description of the cursor is specified with a string instead
405 of an object. This prevents \fBTk_GetCursor\fR from caching the
406 return value, so \fBTk_GetCursor\fR is less efficient than
407 \fBTk_AllocCursorFromObj\fR.
409 \fBTk_GetCursorFromObj\fR returns the token for an existing cursor, given
410 the window and description used to create the cursor.
411 \fBTk_GetCursorFromObj\fR does not actually create the cursor; the cursor
412 must already have been created with a previous call to
413 \fBTk_AllocCursorFromObj\fR or \fBTk_GetCursor\fR. The return
414 value is cached in \fIobjPtr\fR, which speeds up
415 future calls to \fBTk_GetCursorFromObj\fR with the same \fIobjPtr\fR
418 \fBTk_GetCursorFromData\fR allows cursors to be created from
419 in-memory descriptions of their source and mask cursors. \fISource\fR
420 points to standard cursor data for the cursor's source bits, and
421 \fImask\fR points to standard cursor data describing
422 which pixels of \fIsource\fR are to be drawn and which are to be
423 considered transparent. \fIWidth\fR and \fIheight\fR give the
424 dimensions of the cursor, \fIxHot\fR and \fIyHot\fR indicate the
425 location of the cursor's hot-spot (the point that is reported when
426 an event occurs), and \fIfg\fR and \fIbg\fR describe the cursor's
427 foreground and background colors textually (any of the forms
428 suitable for \fBTk_GetColor\fR may be used). Typically, the
429 arguments to \fBTk_GetCursorFromData\fR are created by including
430 a cursor file directly into the source code for a program, as in
431 the following example:
434 #include "source.cursor"
435 #include "mask.cursor"
436 cursor = Tk_GetCursorFromData(interp, tkwin, source_bits,
437 mask_bits, source_width, source_height, source_x_hot,
438 source_y_hot, Tk_GetUid("red"), Tk_GetUid("blue"));
441 Under normal conditions \fBTk_GetCursorFromData\fR
442 will return an identifier for the requested cursor. If an error
443 occurs in creating the cursor then \fBNone\fR is returned and an error
444 message will be stored in \fIinterp\fR's result.
446 \fBTk_AllocCursorFromObj\fR, \fBTk_GetCursor\fR, and
447 \fBTk_GetCursorFromData\fR maintain a
448 database of all the cursors they have created. Whenever possible,
449 a call to \fBTk_AllocCursorFromObj\fR, \fBTk_GetCursor\fR, or
450 \fBTk_GetCursorFromData\fR will
451 return an existing cursor rather than creating a new one. This
452 approach can substantially reduce server overhead, so the Tk
453 procedures should generally be used in preference to Xlib procedures
454 like \fBXCreateFontCursor\fR or \fBXCreatePixmapCursor\fR, which
455 create a new cursor on each call. The Tk procedures are also more
456 portable than the lower-level X procedures.
458 The procedure \fBTk_NameOfCursor\fR is roughly the inverse of
459 \fBTk_GetCursor\fR. If its \fIcursor\fR argument was created
460 by \fBTk_GetCursor\fR, then the return value is the \fIname\fR
461 argument that was passed to \fBTk_GetCursor\fR to create the
462 cursor. If \fIcursor\fR was created by a call to \fBTk_GetCursorFromData\fR,
463 or by any other mechanism, then the return value is a hexadecimal string
464 giving the X identifier for the cursor.
465 Note: the string returned by \fBTk_NameOfCursor\fR is
466 only guaranteed to persist until the next call to
467 \fBTk_NameOfCursor\fR. Also, this call is not portable except for
468 cursors returned by \fBTk_GetCursor\fR.
470 When a cursor returned by \fBTk_AllocCursorFromObj\fR, \fBTk_GetCursor\fR,
471 or \fBTk_GetCursorFromData\fR
472 is no longer needed, \fBTk_FreeCursorFromObj\fR or
473 \fBTk_FreeCursor\fR should be called to release it.
474 For \fBTk_FreeCursorFromObj\fR the cursor to release is specified
475 with the same information used to create it; for
476 \fBTk_FreeCursor\fR the cursor to release is specified
477 with its Tk_Cursor token.
478 There should be exactly one call to \fBTk_FreeCursor\fR for
479 each call to \fBTk_AllocCursorFromObj\fR, \fBTk_GetCursor\fR,
480 or \fBTk_GetCursorFromData\fR.
483 In determining whether an existing cursor can be used to satisfy
484 a new request, \fBTk_AllocCursorFromObj\fR, \fBTk_GetCursor\fR,
485 and \fBTk_GetCursorFromData\fR
486 consider only the immediate values of their arguments. For
487 example, when a file name is passed to \fBTk_GetCursor\fR,
488 \fBTk_GetCursor\fR will assume it is safe to re-use an existing
489 cursor created from the same file name: it will not check to
490 see whether the file itself has changed, or whether the current
491 directory has changed, thereby causing the name to refer to
492 a different file. Similarly, \fBTk_GetCursorFromData\fR assumes
493 that if the same \fIsource\fR pointer is used in two different calls,
494 then the pointers refer to the same data; it does not check to
495 see if the actual data values have changed.
OSDN Git Service
