1
.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
3
.\" Permission is hereby granted, free of charge, to any person obtaining
4
.\" a copy of this software and associated documentation files (the
5
.\" "Software"), to deal in the Software without restriction, including
6
.\" without limitation the rights to use, copy, modify, merge, publish,
7
.\" distribute, sublicense, and/or sell copies of the Software, and to
8
.\" permit persons to whom the Software is furnished to do so, subject to
9
.\" the following conditions:
11
.\" The above copyright notice and this permission notice shall be included
12
.\" in all copies or substantial portions of the Software.
14
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17
.\" IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR
18
.\" OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19
.\" ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20
.\" OTHER DEALINGS IN THE SOFTWARE.
22
.\" Except as contained in this notice, the name of the X Consortium shall
23
.\" not be used in advertising or otherwise to promote the sale, use or
24
.\" other dealings in this Software without prior written authorization
25
.\" from the X Consortium.
27
.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991 by
28
.\" Digital Equipment Corporation
30
.\" Portions Copyright \(co 1990, 1991 by
33
.\" Permission to use, copy, modify and distribute this documentation for
34
.\" any purpose and without fee is hereby granted, provided that the above
35
.\" copyright notice appears in all copies and that both that copyright notice
36
.\" and this permission notice appear in all copies, and that the names of
37
.\" Digital and Tektronix not be used in in advertising or publicity pertaining
38
.\" to this documentation without specific, written prior permission.
39
.\" Digital and Tektronix makes no representations about the suitability
40
.\" of this documentation for any purpose.
41
.\" It is provided ``as is'' without express or implied warranty.
43
.\" $XFree86: xc/doc/man/X11/XListFont.man,v 1.2 2001/01/27 18:20:01 dawes Exp $
45
.ds xT X Toolkit Intrinsics \- C Language Interface
46
.ds xW Athena X Widgets \- C Language X Toolkit Interface
47
.ds xL Xlib \- C Language X Interface
48
.ds xC Inter-Client Communication Conventions Manual
55
.\".if \\n(VS>=40 .vs \\n(VSu
56
.\".if \\n(VS<=39 .vs \\n(VSp
79
.de IN \" send an index entry to the stderr
86
.\" choose appropriate monospace font
87
.\" the imagen conditional, 480,
88
.\" may be changed to L if LB is too
89
.\" heavy for your eyes...
91
.ie "\\*(.T"480" .ft L
92
.el .ie "\\*(.T"300" .ft L
93
.el .ie "\\*(.T"202" .ft PO
94
.el .ie "\\*(.T"aps" .ft CW
97
.ie \\n(VS>40 .vs \\n(VSu
105
.ie t \\$1\fB\^\\$2\^\fR\\$3
106
.el \\$1\fI\^\\$2\^\fP\\$3
109
.ie t \fB\^\\$1\^\fR\\$2
110
.el \fI\^\\$1\^\fP\\$2
113
.ie t <\fB\\$1\fR>\\$2
119
.if \\n(.$>$1 .if !'\\$2'C' .ds NO \\$2
120
.if \\n(.$ .if !'\\$1'C' .ds NO \\$1
134
. \" Note End -- doug kraft 3/85
143
.TH XListFonts 3X11 __xorgversion__ "XLIB FUNCTIONS"
145
XListFonts, XFreeFontNames, XListFontsWithInfo, XFreeFontInfo \- obtain or free font names and information
147
char **XListFonts\^(\^\fIdisplay\fP, \fIpattern\fP\^, \fImaxnames\fP, \fIactual_count_return\fP\^)
149
Display *\^\fIdisplay\fP\^;
151
char *\^\fIpattern\fP\^;
153
int \fImaxnames\fP\^;
155
int *\^\fIactual_count_return\fP\^;
157
XFreeFontNames\^(\^\fIlist\fP\^)
159
char *\fIlist\fP\^[\^]\^;
161
char **XListFontsWithInfo\^(\^\fIdisplay\fP, \fIpattern\fP, \fImaxnames\fP, \fIcount_return\fP, \fIinfo_return\fP\^)
163
Display *\fIdisplay\fP\^;
165
char *\fIpattern\fP\^;
167
int \fImaxnames\fP\^;
169
int *\fIcount_return\fP\^;
171
XFontStruct **\fIinfo_return\fP\^;
173
XFreeFontInfo(\^\fInames\fP, \fIfree_info\fP, \fIactual_count\fP\^)
175
char **\fInames\fP\^;
177
XFontStruct *\fIfree_info\fP;
179
int \fIactual_count\fP\^;
181
.IP \fIactual_count\fP 1i
182
Specifies the actual number of font names.
184
.IP \fIactual_count_return\fP 1i
185
Returns the actual number of font names.
186
.IP \fIcount_return\fP 1i
187
Returns the actual number of matched font names.
189
Specifies the connection to the X server.
190
.IP \fIinfo_return\fP 1i
191
Returns the font information.
192
.IP \fIfree_info\fP 1i
193
Specifies the font information.
196
Specifies the array of strings you want to free.
197
.IP \fImaxnames\fP 1i
198
Specifies the maximum number of names to be returned.
200
Specifies the list of font names.
203
Specifies the null-terminated pattern string that can contain wildcard
208
function returns an array of available font names
209
(as controlled by the font search path; see
211
that match the string you passed to the pattern argument.
212
The pattern string can contain any characters,
213
but each asterisk (*) is a wildcard for any number of characters,
214
and each question mark (?) is a wildcard for a single character.
215
If the pattern string is not in the Host Portable Character Encoding,
216
the result is implementation-dependent.
217
Use of uppercase or lowercase does not matter.
218
Each returned string is null-terminated.
219
If the data returned by the server is in the Latin Portable Character Encoding,
220
then the returned strings are in the Host Portable Character Encoding.
221
Otherwise, the result is implementation-dependent.
222
If there are no matching font names,
225
The client should call
227
when finished with the result to free the memory.
231
function frees the array and strings returned by
234
.ZN XListFontsWithInfo .
237
.ZN XListFontsWithInfo
238
function returns a list of font names that match the specified pattern and their
239
associated font information.
240
The list of names is limited to size specified by maxnames.
241
The information returned for each font is identical to what
243
would return except that the per-character metrics are not returned.
244
The pattern string can contain any characters,
245
but each asterisk (*) is a wildcard for any number of characters,
246
and each question mark (?) is a wildcard for a single character.
247
If the pattern string is not in the Host Portable Character Encoding,
248
the result is implementation-dependent.
249
Use of uppercase or lowercase does not matter.
250
Each returned string is null-terminated.
251
If the data returned by the server is in the Latin Portable Character Encoding,
252
then the returned strings are in the Host Portable Character Encoding.
253
Otherwise, the result is implementation-dependent.
254
If there are no matching font names,
255
.ZN XListFontsWithInfo
258
To free only the allocated name array,
259
the client should call
261
To free both the name array and the font information array
262
or to free just the font information array,
263
the client should call
268
function frees a font structure or an array of font structures
269
and optionally an array of font names.
270
If NULL is passed for names, no font names are freed.
271
If a font structure for an open font (returned by
273
is passed, the structure is freed,
274
but the font is not closed; use