doc/fontconfig-devel/fcfontsort.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>FcFontSort</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
HREF="t1.html"><LINK
REL="UP"
TITLE="FcConfig"
HREF="x103.html#AEN3038"><LINK
REL="PREVIOUS"
TITLE="FcFontMatch"
HREF="fcfontmatch.html"><LINK
REL="NEXT"
TITLE="FcFontRenderPrepare"
HREF="fcfontrenderprepare.html"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
></TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="fcfontmatch.html"
ACCESSKEY="P"
>&#60;&#60;&#60; Previous</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="fcfontrenderprepare.html"
ACCESSKEY="N"
>Next &#62;&#62;&#62;</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="FCFONTSORT"
></A
>FcFontSort</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3569"
></A
><H2
>Name</H2
>FcFontSort&nbsp;--&nbsp;Return list of matching fonts</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3572"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3573"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
        </PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcFontSet * <TT
CLASS="FUNCTION"
>FcFontSort</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>, FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, FcBool <TT
CLASS="PARAMETER"
><I
>trim</I
></TT
>, FcCharSet **<TT
CLASS="PARAMETER"
><I
>csp</I
></TT
>, FcResult *<TT
CLASS="PARAMETER"
><I
>result</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3588"
></A
><H2
>Description</H2
><P
>Returns the list of fonts sorted by closeness to <TT
CLASS="PARAMETER"
><I
>p</I
></TT
>.  If <TT
CLASS="PARAMETER"
><I
>trim</I
></TT
> is FcTrue,
elements in the list which don't include Unicode coverage not provided by
earlier elements in the list are elided.  The union of Unicode coverage of
all of the fonts is returned in <TT
CLASS="PARAMETER"
><I
>csp</I
></TT
>, if <TT
CLASS="PARAMETER"
><I
>csp</I
></TT
> is not NULL.  This function
should be called only after FcConfigSubstitute and FcDefaultSubstitute have
been called for <TT
CLASS="PARAMETER"
><I
>p</I
></TT
>; otherwise the results will not be correct.
    </P
><P
>The returned FcFontSet references FcPattern structures which may be shared
by the return value from multiple FcFontSort calls, applications must not
modify these patterns.  Instead, they should be passed, along with <TT
CLASS="PARAMETER"
><I
>p</I
></TT
> to
<TT
CLASS="FUNCTION"
>FcFontRenderPrepare</TT
> which combines them into a complete pattern.
    </P
><P
>The FcFontSet returned by FcFontSort is destroyed by calling FcFontSetDestroy.
If <TT
CLASS="PARAMETER"
><I
>config</I
></TT
> is NULL, the current configuration is used.
            </P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="fcfontmatch.html"
ACCESSKEY="P"
>&#60;&#60;&#60; Previous</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="t1.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="fcfontrenderprepare.html"
ACCESSKEY="N"
>Next &#62;&#62;&#62;</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>FcFontMatch</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="x103.html#AEN3038"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>FcFontRenderPrepare</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>