2010-03-25 15:45:57 -06:00
|
|
|
.\\" auto-generated by docbook2man-spec $Revision: 1.2 $
|
|
|
|
.TH "FcFontSetSort" "3" "18 November 2009" "" ""
|
2009-04-05 10:43:35 -06:00
|
|
|
.SH NAME
|
|
|
|
FcFontSetSort \- Add to a font set
|
|
|
|
.SH SYNOPSIS
|
2010-03-25 15:45:57 -06:00
|
|
|
.nf
|
2009-04-05 10:43:35 -06:00
|
|
|
\fB#include <fontconfig.h>
|
|
|
|
.sp
|
2010-03-25 15:45:57 -06:00
|
|
|
FcFontSetSort(FcConfig *\fIconfig\fB);
|
|
|
|
(FcFontSet **\fIsets\fB);
|
|
|
|
(int\fInsets\fB);
|
|
|
|
(FcPattern *\fIpattern\fB);
|
|
|
|
(FcBool \fItrim\fB);
|
|
|
|
(FcCharSet **\fIcsp\fB);
|
|
|
|
(FcResult *\fIresult\fB);
|
|
|
|
\fR.fi
|
2009-04-05 10:43:35 -06:00
|
|
|
.SH "DESCRIPTION"
|
|
|
|
.PP
|
|
|
|
Returns the list of fonts from \fIsets\fR
|
2010-03-25 15:45:57 -06:00
|
|
|
sorted by closeness to \fIpattern\fR\&.
|
2009-04-05 10:43:35 -06:00
|
|
|
If \fItrim\fR is FcTrue,
|
|
|
|
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
|
2009-04-05 10:43:35 -06:00
|
|
|
all of the fonts is returned in \fIcsp\fR,
|
2010-03-25 15:45:57 -06:00
|
|
|
if \fIcsp\fR is not NULL. This function
|
2009-04-05 10:43:35 -06: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 cannot
|
2010-03-25 15:45:57 -06:00
|
|
|
modify these patterns. Instead, they should be passed, along with
|
2009-04-05 10:43:35 -06:00
|
|
|
\fIpattern\fR to
|
|
|
|
\fBFcFontRenderPrepare\fR which combines them into a complete pattern.
|
|
|
|
.PP
|
|
|
|
The FcFontSet returned by FcFontSetSort is destroyed by caling FcFontSetDestroy.
|
|
|
|
.SH "VERSION"
|
|
|
|
.PP
|
2010-03-25 15:45:57 -06:00
|
|
|
Fontconfig version 2.8.0
|