GetFont.3
上传用户:rrhhcc
上传日期:2015-12-11
资源大小:54129k
文件大小:4k
源码类别:

通讯编程

开发平台:

Visual C++

  1. '"
  2. '" Copyright (c) 1990-1992 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: GetFont.3,v 1.5.2.1 2005/11/22 11:55:19 dkf Exp $
  9. '" 
  10. .so man.macros
  11. .TH Tk_AllocFontFromObj 3 8.1 Tk "Tk Library Procedures"
  12. .BS
  13. .SH NAME
  14. Tk_AllocFontFromObj, Tk_GetFont, Tk_GetFontFromObj, Tk_NameOfFont, Tk_FreeFontFromObj, Tk_FreeFont - maintain database of fonts
  15. .SH SYNOPSIS
  16. .nf
  17. fB#include <tk.h>fR
  18. .sp
  19. .VS 8.1
  20. Tk_Font 
  21. fBTk_AllocFontFromObj(fIinterp, tkwin, objPtrfB)fR
  22. .sp
  23. Tk_Font 
  24. fBTk_GetFont(fIinterp, tkwin, stringfB)fR 
  25. .sp
  26. Tk_Font 
  27. fBTk_GetFontFromObj(fItkwin, objPtrfB)fR
  28. .VE
  29. .sp
  30. CONST char *
  31. fBTk_NameOfFont(fItkfontfB)fR
  32. .sp
  33. .VS 8.1
  34. Tk_Font 
  35. fBTk_FreeFontFromObj(fItkwin, objPtrfB)fR
  36. .VE
  37. .sp
  38. void
  39. fBTk_FreeFont(fItkfontfB)fR
  40. .SH ARGUMENTS
  41. .AS "const char" *tkfont
  42. .AP "Tcl_Interp" *interp in
  43. Interpreter to use for error reporting.  If fBNULLfR, then no error
  44. messages are left after errors.
  45. .AP Tk_Window tkwin in
  46. Token for window in which font will be used.
  47. .VS 8.1 br
  48. .AP Tcl_Obj *objPtr in/out
  49. Gives name or description of font.  See documentation
  50. for the fBfontfR command for details on acceptable formats.
  51. Internal rep will be modified to cache corresponding Tk_Font.
  52. .AP "const char" *string in
  53. Same as fIobjPtrfR except description of font is passed as a string and
  54. resulting Tk_Font isn't cached.
  55. .VE
  56. .AP Tk_Font tkfont in
  57. Opaque font token.
  58. .BE
  59. .SH DESCRIPTION
  60. .PP
  61. .VS 8.1
  62. fBTk_AllocFontFromObjfR finds the font indicated by fIobjPtrfR and
  63. returns a token that represents the font.  The return value can be used
  64. in subsequent calls to procedures such as fBTk_GetFontMetricsfR,
  65. fBTk_MeasureCharsfR, and fBTk_FreeFontfR.  The Tk_Font token
  66. will remain valid until
  67. fBTk_FreeFontFromObjfR or fBTk_FreeFontfR is called to release it. 
  68. fIObjPtrfR can contain either a symbolic name or a font description; see
  69. the documentation for the fBfontfR command for a description of the
  70. valid formats.  If fBTk_AllocFontFromObjfR is unsuccessful (because,
  71. for example, fIobjPtrfR did not contain a valid font specification) then it
  72. returns fBNULLfR and leaves an error message in fIinterpfR's result
  73. if fIinterpfR isn't fBNULLfR.  fBTk_AllocFontFromObjfR caches
  74. information about the return
  75. value in fIobjPtrfR, which speeds up future calls to procedures
  76. such as fBTk_AllocFontFromObjfR and fBTk_GetFontFromObjfR.
  77. .PP
  78. fBTk_GetFontfR is identical to fBTk_AllocFontFromObjfR except
  79. that the description of the font is specified with a string instead
  80. of an object.  This prevents fBTk_GetFontfR from caching the
  81. matching Tk_Font, so fBTk_GetFontfR is less efficient than
  82. fBTk_AllocFontFromObjfR.
  83. .PP
  84. fBTk_GetFontFromObjfR returns the token for an existing font, given
  85. the window and description used to create the font.
  86. fBTk_GetFontFromObjfR doesn't actually create the font; the font
  87. must already have been created with a previous call to
  88. fBTk_AllocFontFromObjfR or fBTk_GetFontfR.  The return
  89. value is cached in fIobjPtrfR, which speeds up
  90. future calls to fBTk_GetFontFromObjfR with the same fIobjPtrfR
  91. and fItkwinfR.
  92. .VE
  93. .PP
  94. fBTk_AllocFontFromObjfR and fBTk_GetFontfR maintain
  95. a database of all fonts they have allocated.  If
  96. the same font is requested multiple times (e.g. by different
  97. windows or for different purposes), then a single Tk_Font will be
  98. shared for all uses.  The underlying resources will be freed automatically
  99. when no-one is using the font anymore.
  100. .PP
  101. The procedure fBTk_NameOfFontfR is roughly the inverse of
  102. fBTk_GetFontfR.  Given a fItkfontfR that was created by
  103. fBTk_GetFontfR (or fBTk_AllocFontFromObjfR), the return value is
  104. the fIstringfR argument that was
  105. passed to fBTk_GetFontfR to create the font.  The string returned by
  106. fBTk_NameOfFontfR is only guaranteed to persist until the fItkfontfR
  107. is deleted.  The caller must not modify this string.
  108. .PP
  109. .VS 8.1
  110. When a font is no longer needed,
  111. fBTk_FreeFontFromObjfR or fBTk_FreeFontfR should be called to
  112. release it.  For fBTk_FreeFontFromObjfR the font to release is specified
  113. with the same information used to create it; for
  114. fBTk_FreeFontfR the font to release is specified
  115. with its Tk_Font token.  There should be
  116. exactly one call to fBTk_FreeFontFromObjfR or fBTk_FreeFontfR
  117. for each call to fBTk_AllocFontFromObjfR or fBTk_GetFontfR.
  118. .VE
  119. .SH "SEE ALSO"
  120. Tk_FontId(3)
  121. .SH KEYWORDS
  122. font