Mercurial > cpython-lru_cache-weakref

annotate Doc/lib/libfm.tex @ 21467:4e35fa5d5708 legacy-trunk

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add documentation for the help() built-in; contributed by Ka-Ping Yee. This is part of SF patch #494622.
author Fred Drake <fdrake@acm.org>
date Tue, 18 Dec 2001 16:31:08 +0000
parents 5db2c0427cad
children 06145fbc7ab9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8918
acfffe14628e New section header style.
Fred Drake <fdrake@acm.org>
parents: 8716
diff changeset
1 \section{\module{fm} ---
10252
c27c10c6b9f2 Shorten section title.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
2 \emph{Font Manager} interface}
c27c10c6b9f2 Shorten section title.
Fred Drake <fdrake@acm.org>
parents: 8918
diff changeset
3
8716
760dcf197048 Adjusted to use the new module synopsis support macros.
Fred Drake <fdrake@acm.org>
parents: 7877
diff changeset
4 \declaremodule{builtin}{fm}
10334
61224459bb09 Added \platform annotations.
Fred Drake <fdrake@acm.org>
parents: 10252
diff changeset
5 \platform{IRIX}
8716
760dcf197048 Adjusted to use the new module synopsis support macros.
Fred Drake <fdrake@acm.org>
parents: 7877
diff changeset
6 \modulesynopsis{\emph{Font Manager} interface for SGI workstations.}
760dcf197048 Adjusted to use the new module synopsis support macros.
Fred Drake <fdrake@acm.org>
parents: 7877
diff changeset
7
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
8
7096
5bb884527446 Consistency: "{\bf ...}" ==> "\strong{...}"
Fred Drake <fdrake@acm.org>
parents: 5818
diff changeset
9 This module provides access to the IRIS \emph{Font Manager} library.
7872
b5ede133d921 Added index entries.
Fred Drake <fdrake@acm.org>
parents: 7691
diff changeset
10 \index{Font Manager, IRIS}
b5ede133d921 Added index entries.
Fred Drake <fdrake@acm.org>
parents: 7691
diff changeset
11 \index{IRIS Font Manager}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
12 It is available only on Silicon Graphics machines.
10785
5db2c0427cad Always use "section" when referring to sections of a document, not "Section".
Fred Drake <fdrake@acm.org>
parents: 10334
diff changeset
13 See also: \emph{4Sight User's Guide}, section 1, chapter 5: ``Using
7691
9bf81d93b995 Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
14 the IRIS Font Manager.''
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
15
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
16 This is not yet a full interface to the IRIS Font Manager.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
17 Among the unsupported features are: matrix operations; cache
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
18 operations; character operations (use string operations instead); some
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
19 details of font info; individual glyph metrics; and printer matching.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
20
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
21 It supports the following operations:
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
22
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
23 \begin{funcdesc}{init}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
24 Initialization function.
7691
9bf81d93b995 Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
25 Calls \cfunction{fminit()}.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
26 It is normally not necessary to call this function, since it is called
7691
9bf81d93b995 Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
27 automatically the first time the \module{fm} module is imported.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
28 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
29
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
30 \begin{funcdesc}{findfont}{fontname}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
31 Return a font handle object.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
32 Calls \code{fmfindfont(\var{fontname})}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
33 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
34
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
35 \begin{funcdesc}{enumerate}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
36 Returns a list of available font names.
7691
9bf81d93b995 Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
37 This is an interface to \cfunction{fmenumerate()}.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
38 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
39
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
40 \begin{funcdesc}{prstr}{string}
7691
9bf81d93b995 Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
41 Render a string using the current font (see the \function{setfont()} font
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
42 handle method below).
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
43 Calls \code{fmprstr(\var{string})}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
44 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
45
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
46 \begin{funcdesc}{setpath}{string}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
47 Sets the font search path.
7691
9bf81d93b995 Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
48 Calls \code{fmsetpath(\var{string})}.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
49 (XXX Does not work!?!)
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
50 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
51
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
52 \begin{funcdesc}{fontpath}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
53 Returns the current font search path.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
54 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
55
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
56 Font handle objects support the following operations:
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
57
7277
bf4e790bd61a Remove all \bcode / \ecode cruft; this is no longer needed. See previous
Fred Drake <fdrake@acm.org>
parents: 7108
diff changeset
58 \setindexsubitem{(font handle method)}
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
59 \begin{funcdesc}{scalefont}{factor}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
60 Returns a handle for a scaled version of this font.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
61 Calls \code{fmscalefont(\var{fh}, \var{factor})}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
62 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
63
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
64 \begin{funcdesc}{setfont}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
65 Makes this font the current font.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
66 Note: the effect is undone silently when the font handle object is
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
67 deleted.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
68 Calls \code{fmsetfont(\var{fh})}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
69 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
70
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
71 \begin{funcdesc}{getfontname}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
72 Returns this font's name.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
73 Calls \code{fmgetfontname(\var{fh})}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
74 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
75
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
76 \begin{funcdesc}{getcomment}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
77 Returns the comment string associated with this font.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
78 Raises an exception if there is none.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
79 Calls \code{fmgetcomment(\var{fh})}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
80 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
81
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
82 \begin{funcdesc}{getfontinfo}{}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
83 Returns a tuple giving some pertinent data about this font.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
84 This is an interface to \code{fmgetfontinfo()}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
85 The returned tuple contains the following numbers:
7691
9bf81d93b995 Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
86 \code{(}\var{printermatched}, \var{fixed_width}, \var{xorig},
9bf81d93b995 Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
87 \var{yorig}, \var{xsize}, \var{ysize}, \var{height},
9bf81d93b995 Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
88 \var{nglyphs}\code{)}.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
89 \end{funcdesc}
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
90
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
91 \begin{funcdesc}{getstrwidth}{string}
7691
9bf81d93b995 Logical markup.
Fred Drake <fdrake@acm.org>
parents: 7277
diff changeset
92 Returns the width, in pixels, of \var{string} when drawn in this font.
1471
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
93 Calls \code{fmgetstrwidth(\var{fh}, \var{string})}.
2ec96140a36b Restructured library documentation
Guido van Rossum <guido@python.org>
parents:
diff changeset
94 \end{funcdesc}