2010-03-25 15:45:57 -06:00
|
|
|
.\\" auto-generated by docbook2man-spec $Revision: 1.3 $
|
|
|
|
.TH "FcFontSort" "3" "18 November 2009" "" ""
|
2006-11-25 11:41:30 -07:00
|
|
|
.SH NAME
|
|
|
|
FcFontSort \- Return list of matching fonts
|
|
|
|
.SH SYNOPSIS
|
2010-03-25 15:45:57 -06:00
|
|
|
.nf
|
2006-11-25 11:41:30 -07:00
|
|
|
\fB#include <fontconfig.h>
|
|
|
|
.sp
|
2010-03-25 15:45:57 -06:00
|
|
|
FcFontSet * FcFontSort(FcConfig *\fIconfig\fB);
|
|
|
|
(FcPattern *\fIp\fB);
|
|
|
|
(FcBool \fItrim\fB);
|
|
|
|
(FcCharSet **\fIcsp\fB);
|
|
|
|
(FcResult *\fIresult\fB);
|
|
|
|
\fR.fi
|
2006-11-25 11:41:30 -07:00
|
|
|
.SH "DESCRIPTION"
|
|
|
|
.PP
|
2010-03-25 15:45:57 -06:00
|
|
|
Returns the list of fonts sorted by closeness to \fIp\fR\&. If \fItrim\fR is FcTrue,
|
2006-11-25 11:41:30 -07:00
|
|
|
elements in the list which don't include Unicode coverage not provided by
|
2010-03-25 15:45:57 -06:00
|
|
|
earlier elements in the list are elided. The union of Unicode coverage of
|
|
|
|
all of the fonts is returned in \fIcsp\fR, if \fIcsp\fR is not NULL. This function
|
2006-11-25 11:41:30 -07:00
|
|
|
should be called only after FcConfigSubstitute and FcDefaultSubstitute have
|
|
|
|
been called for \fIp\fR; otherwise the results will not be correct.
|
|
|
|
.PP
|
|
|
|
The returned FcFontSet references FcPattern structures which may be shared
|
|
|
|
by the return value from multiple FcFontSort calls, applications must not
|
2010-03-25 15:45:57 -06:00
|
|
|
modify these patterns. Instead, they should be passed, along with \fIp\fR to
|
2009-04-05 10:43:35 -06:00
|
|
|
\fBFcFontRenderPrepare\fR which combines them into a complete pattern.
|
2006-11-25 11:41:30 -07:00
|
|
|
.PP
|
|
|
|
The FcFontSet returned by FcFontSort is destroyed by caling FcFontSetDestroy.
|
2010-03-25 15:45:57 -06:00
|
|
|
If \fIconfig\fR is NULL, the current configuration is used.
|
2006-11-25 11:41:30 -07:00
|
|
|
.SH "VERSION"
|
|
|
|
.PP
|
2010-03-25 15:45:57 -06:00
|
|
|
Fontconfig version 2.8.0
|