| 1 |
578 |
markom |
'\"
|
| 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: InternAtom.3,v 1.1.1.1 2002-01-16 10:25:48 markom Exp $
|
| 9 |
|
|
'\"
|
| 10 |
|
|
.so man.macros
|
| 11 |
|
|
.TH Tk_InternAtom 3 "" Tk "Tk Library Procedures"
|
| 12 |
|
|
.BS
|
| 13 |
|
|
.SH NAME
|
| 14 |
|
|
Tk_InternAtom, Tk_GetAtomName \- manage cache of X atoms
|
| 15 |
|
|
.SH SYNOPSIS
|
| 16 |
|
|
.nf
|
| 17 |
|
|
\fB#include \fR
|
| 18 |
|
|
.sp
|
| 19 |
|
|
Atom
|
| 20 |
|
|
\fBTk_InternAtom(\fItkwin, name\fR)
|
| 21 |
|
|
.sp
|
| 22 |
|
|
char *
|
| 23 |
|
|
\fBTk_GetAtomName(\fItkwin, atom\fR)
|
| 24 |
|
|
.SH ARGUMENTS
|
| 25 |
|
|
.AS Tk_Window parent
|
| 26 |
|
|
.AP Tk_Window tkwin in
|
| 27 |
|
|
Token for window. Used to map atom or name relative to a particular display.
|
| 28 |
|
|
.AP char *name in
|
| 29 |
|
|
String name for which atom is desired.
|
| 30 |
|
|
.AP Atom atom in
|
| 31 |
|
|
Atom for which corresponding string name is desired.
|
| 32 |
|
|
.BE
|
| 33 |
|
|
|
| 34 |
|
|
.SH DESCRIPTION
|
| 35 |
|
|
.PP
|
| 36 |
|
|
These procedures are similar to the Xlib procedures
|
| 37 |
|
|
\fBXInternAtom\fR and \fBXGetAtomName\fR. \fBTk_InternAtom\fR
|
| 38 |
|
|
returns the atom identifier associated with string given by
|
| 39 |
|
|
\fIname\fR; the atom identifier is only valid for the display
|
| 40 |
|
|
associated with \fItkwin\fR.
|
| 41 |
|
|
\fBTk_GetAtomName\fR returns the string associated
|
| 42 |
|
|
with \fIatom\fR on \fItkwin\fR's display. The string returned
|
| 43 |
|
|
by \fBTk_GetAtomName\fR is in Tk's storage: the caller need
|
| 44 |
|
|
not free this space when finished with the string, and the caller
|
| 45 |
|
|
should not modify the contents of the returned string.
|
| 46 |
|
|
If there is no atom \fIatom\fR on \fItkwin\fR's display,
|
| 47 |
|
|
then \fBTk_GetAtomName\fR returns the string ``?bad atom?''.
|
| 48 |
|
|
.PP
|
| 49 |
|
|
Tk caches
|
| 50 |
|
|
the information returned by \fBTk_InternAtom\fR and \fBTk_GetAtomName\fR
|
| 51 |
|
|
so that future calls
|
| 52 |
|
|
for the same information can be serviced from the cache without
|
| 53 |
|
|
contacting the server. Thus \fBTk_InternAtom\fR and \fBTk_GetAtomName\fR
|
| 54 |
|
|
are generally much faster than their Xlib counterparts, and they
|
| 55 |
|
|
should be used in place of the Xlib procedures.
|
| 56 |
|
|
|
| 57 |
|
|
.SH KEYWORDS
|
| 58 |
|
|
atom, cache, display
|
