diff options
Diffstat (limited to 'doc/GetFont.3')
| -rw-r--r-- | doc/GetFont.3 | 19 |
1 files changed, 4 insertions, 15 deletions
diff --git a/doc/GetFont.3 b/doc/GetFont.3 index fbfa0e3..2ca1395 100644 --- a/doc/GetFont.3 +++ b/doc/GetFont.3 @@ -14,7 +14,6 @@ Tk_AllocFontFromObj, Tk_GetFont, Tk_GetFontFromObj, Tk_NameOfFont, Tk_FreeFontFr .nf \fB#include <tk.h>\fR .sp -.VS 8.1 Tk_Font \fBTk_AllocFontFromObj(\fIinterp, tkwin, objPtr\fB)\fR .sp @@ -23,15 +22,12 @@ Tk_Font .sp Tk_Font \fBTk_GetFontFromObj(\fItkwin, objPtr\fB)\fR -.VE .sp -CONST char * +const char * \fBTk_NameOfFont(\fItkfont\fB)\fR .sp -.VS 8.1 Tk_Font \fBTk_FreeFontFromObj(\fItkwin, objPtr\fB)\fR -.VE .sp void \fBTk_FreeFont(\fItkfont\fB)\fR @@ -43,21 +39,18 @@ Interpreter to use for error reporting. If \fBNULL\fR, then no error messages are left after errors. .AP Tk_Window tkwin in Token for window in which font will be used. -.VS 8.1 br .AP Tcl_Obj *objPtr in/out Gives name or description of font. See documentation for the \fBfont\fR command for details on acceptable formats. Internal rep will be modified to cache corresponding Tk_Font. .AP "const char" *string in Same as \fIobjPtr\fR except description of font is passed as a string and -resulting Tk_Font isn't cached. -.VE +resulting Tk_Font is not cached. .AP Tk_Font tkfont in Opaque font token. .BE .SH DESCRIPTION .PP -.VS 8.1 \fBTk_AllocFontFromObj\fR finds the font indicated by \fIobjPtr\fR and returns a token that represents the font. The return value can be used in subsequent calls to procedures such as \fBTk_GetFontMetrics\fR, @@ -69,7 +62,7 @@ the documentation for the \fBfont\fR command for a description of the valid formats. If \fBTk_AllocFontFromObj\fR is unsuccessful (because, for example, \fIobjPtr\fR did not contain a valid font specification) then it returns \fBNULL\fR and leaves an error message in \fIinterp\fR's result -if \fIinterp\fR isn't \fBNULL\fR. \fBTk_AllocFontFromObj\fR caches +if \fIinterp\fR is not \fBNULL\fR. \fBTk_AllocFontFromObj\fR caches information about the return value in \fIobjPtr\fR, which speeds up future calls to procedures such as \fBTk_AllocFontFromObj\fR and \fBTk_GetFontFromObj\fR. @@ -82,13 +75,12 @@ matching Tk_Font, so \fBTk_GetFont\fR is less efficient than .PP \fBTk_GetFontFromObj\fR returns the token for an existing font, given the window and description used to create the font. -\fBTk_GetFontFromObj\fR doesn't actually create the font; the font +\fBTk_GetFontFromObj\fR does not actually create the font; the font must already have been created with a previous call to \fBTk_AllocFontFromObj\fR or \fBTk_GetFont\fR. The return value is cached in \fIobjPtr\fR, which speeds up future calls to \fBTk_GetFontFromObj\fR with the same \fIobjPtr\fR and \fItkwin\fR. -.VE .PP \fBTk_AllocFontFromObj\fR and \fBTk_GetFont\fR maintain a database of all fonts they have allocated. If @@ -105,7 +97,6 @@ passed to \fBTk_GetFont\fR to create the font. The string returned by \fBTk_NameOfFont\fR is only guaranteed to persist until the \fItkfont\fR is deleted. The caller must not modify this string. .PP -.VS 8.1 When a font is no longer needed, \fBTk_FreeFontFromObj\fR or \fBTk_FreeFont\fR should be called to release it. For \fBTk_FreeFontFromObj\fR the font to release is specified @@ -114,10 +105,8 @@ with the same information used to create it; for with its Tk_Font token. There should be exactly one call to \fBTk_FreeFontFromObj\fR or \fBTk_FreeFont\fR for each call to \fBTk_AllocFontFromObj\fR or \fBTk_GetFont\fR. -.VE .SH "SEE ALSO" Tk_FontId(3) - .SH KEYWORDS font |