Home | History | Annotate | Line # | Download | only in fontconfig-devel 
      1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/loose.dtd">
      2 <HTML
      3 ><HEAD
      4 ><TITLE
      5 >FcFontSetSort</TITLE
      6 ><META
      7 NAME="GENERATOR"
      8 CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
      9 REL="HOME"
     10 HREF="t1.html"><LINK
     11 REL="UP"
     12 TITLE="FcFontSet"
     13 HREF="x103.html#AEN1316"><LINK
     14 REL="PREVIOUS"
     15 TITLE="FcFontSetPrint"
     16 HREF="fcfontsetprint.html"><LINK
     17 REL="NEXT"
     18 TITLE="FcFontSetSortDestroy"
     19 HREF="fcfontsetsortdestroy.html"></HEAD
     20 ><BODY
     21 CLASS="REFENTRY"
     22 BGCOLOR="#FFFFFF"
     23 TEXT="#000000"
     24 LINK="#0000FF"
     25 VLINK="#840084"
     26 ALINK="#0000FF"
     27 ><DIV
     28 CLASS="NAVHEADER"
     29 ><TABLE
     30 SUMMARY="Header navigation table"
     31 WIDTH="100%"
     32 BORDER="0"
     33 CELLPADDING="0"
     34 CELLSPACING="0"
     35 ><TR
     36 ><TH
     37 COLSPAN="3"
     38 ALIGN="center"
     39 ></TH
     40 ></TR
     41 ><TR
     42 ><TD
     43 WIDTH="10%"
     44 ALIGN="left"
     45 VALIGN="bottom"
     46 ><A
     47 HREF="fcfontsetprint.html"
     48 ACCESSKEY="P"
     49 >&#60;&#60;&#60; Previous</A
     50 ></TD
     51 ><TD
     52 WIDTH="80%"
     53 ALIGN="center"
     54 VALIGN="bottom"
     55 ></TD
     56 ><TD
     57 WIDTH="10%"
     58 ALIGN="right"
     59 VALIGN="bottom"
     60 ><A
     61 HREF="fcfontsetsortdestroy.html"
     62 ACCESSKEY="N"
     63 >Next &#62;&#62;&#62;</A
     64 ></TD
     65 ></TR
     66 ></TABLE
     67 ><HR
     68 ALIGN="LEFT"
     69 WIDTH="100%"></DIV
     70 ><H1
     71 ><A
     72 NAME="FCFONTSETSORT"
     73 ></A
     74 >FcFontSetSort</H1
     75 ><DIV
     76 CLASS="REFNAMEDIV"
     77 ><A
     78 NAME="AEN1468"
     79 ></A
     80 ><H2
     81 >Name</H2
     82 >FcFontSetSort&nbsp;--&nbsp;Add to a font set</DIV
     83 ><DIV
     84 CLASS="REFSYNOPSISDIV"
     85 ><A
     86 NAME="AEN1471"
     87 ></A
     88 ><H2
     89 >Synopsis</H2
     90 ><DIV
     91 CLASS="FUNCSYNOPSIS"
     92 ><P
     93 ></P
     94 ><A
     95 NAME="AEN1472"
     96 ></A
     97 ><TABLE
     98 BORDER="0"
     99 BGCOLOR="#E0E0E0"
    100 WIDTH="100%"
    101 ><TR
    102 ><TD
    103 ><PRE
    104 CLASS="FUNCSYNOPSISINFO"
    105 >#include &#60;fontconfig/fontconfig.h&#62;
    106         </PRE
    107 ></TD
    108 ></TR
    109 ></TABLE
    110 ><P
    111 ><CODE
    112 ><CODE
    113 CLASS="FUNCDEF"
    114 >FcFontSet * <TT
    115 CLASS="FUNCTION"
    116 >FcFontSetSort</TT
    117 ></CODE
    118 >(FcConfig *<TT
    119 CLASS="PARAMETER"
    120 ><I
    121 >config</I
    122 ></TT
    123 >, FcFontSet **<TT
    124 CLASS="PARAMETER"
    125 ><I
    126 >sets</I
    127 ></TT
    128 >, int<TT
    129 CLASS="PARAMETER"
    130 ><I
    131 >nsets</I
    132 ></TT
    133 >, FcPattern *<TT
    134 CLASS="PARAMETER"
    135 ><I
    136 >pattern</I
    137 ></TT
    138 >, FcBool <TT
    139 CLASS="PARAMETER"
    140 ><I
    141 >trim</I
    142 ></TT
    143 >, FcCharSet **<TT
    144 CLASS="PARAMETER"
    145 ><I
    146 >csp</I
    147 ></TT
    148 >, FcResult *<TT
    149 CLASS="PARAMETER"
    150 ><I
    151 >result</I
    152 ></TT
    153 >);</CODE
    154 ></P
    155 ><P
    156 ></P
    157 ></DIV
    158 ></DIV
    159 ><DIV
    160 CLASS="REFSECT1"
    161 ><A
    162 NAME="AEN1491"
    163 ></A
    164 ><H2
    165 >Description</H2
    166 ><P
    167 >Returns the list of fonts from <TT
    168 CLASS="PARAMETER"
    169 ><I
    170 >sets</I
    171 ></TT
    172 >
    173 sorted by closeness to <TT
    174 CLASS="PARAMETER"
    175 ><I
    176 >pattern</I
    177 ></TT
    178 >.
    179 If <TT
    180 CLASS="PARAMETER"
    181 ><I
    182 >trim</I
    183 ></TT
    184 > is FcTrue,
    185 elements in the list which don't include Unicode coverage not provided by
    186 earlier elements in the list are elided.  The union of Unicode coverage of
    187 all of the fonts is returned in <TT
    188 CLASS="PARAMETER"
    189 ><I
    190 >csp</I
    191 ></TT
    192 >,
    193 if <TT
    194 CLASS="PARAMETER"
    195 ><I
    196 >csp</I
    197 ></TT
    198 > is not NULL.  This function
    199 should be called only after FcConfigSubstitute and FcDefaultSubstitute have
    200 been called for <TT
    201 CLASS="PARAMETER"
    202 ><I
    203 >p</I
    204 ></TT
    205 >;
    206 otherwise the results will not be correct.
    207     </P
    208 ><P
    209 >The returned FcFontSet references FcPattern structures which may be shared
    210 by the return value from multiple FcFontSort calls, applications cannot
    211 modify these patterns.  Instead, they should be passed, along with
    212 <TT
    213 CLASS="PARAMETER"
    214 ><I
    215 >pattern</I
    216 ></TT
    217 > to
    218 <TT
    219 CLASS="FUNCTION"
    220 >FcFontRenderPrepare</TT
    221 > which combines them into a complete pattern.
    222     </P
    223 ><P
    224 >The FcFontSet returned by FcFontSetSort is destroyed by calling FcFontSetDestroy.
    225             </P
    226 ></DIV
    227 ><DIV
    228 CLASS="NAVFOOTER"
    229 ><HR
    230 ALIGN="LEFT"
    231 WIDTH="100%"><TABLE
    232 SUMMARY="Footer navigation table"
    233 WIDTH="100%"
    234 BORDER="0"
    235 CELLPADDING="0"
    236 CELLSPACING="0"
    237 ><TR
    238 ><TD
    239 WIDTH="33%"
    240 ALIGN="left"
    241 VALIGN="top"
    242 ><A
    243 HREF="fcfontsetprint.html"
    244 ACCESSKEY="P"
    245 >&#60;&#60;&#60; Previous</A
    246 ></TD
    247 ><TD
    248 WIDTH="34%"
    249 ALIGN="center"
    250 VALIGN="top"
    251 ><A
    252 HREF="t1.html"
    253 ACCESSKEY="H"
    254 >Home</A
    255 ></TD
    256 ><TD
    257 WIDTH="33%"
    258 ALIGN="right"
    259 VALIGN="top"
    260 ><A
    261 HREF="fcfontsetsortdestroy.html"
    262 ACCESSKEY="N"
    263 >Next &#62;&#62;&#62;</A
    264 ></TD
    265 ></TR
    266 ><TR
    267 ><TD
    268 WIDTH="33%"
    269 ALIGN="left"
    270 VALIGN="top"
    271 >FcFontSetPrint</TD
    272 ><TD
    273 WIDTH="34%"
    274 ALIGN="center"
    275 VALIGN="top"
    276 ><A
    277 HREF="x103.html#AEN1316"
    278 ACCESSKEY="U"
    279 >Up</A
    280 ></TD
    281 ><TD
    282 WIDTH="33%"
    283 ALIGN="right"
    284 VALIGN="top"
    285 >FcFontSetSortDestroy</TD
    286 ></TR
    287 ></TABLE
    288 ></DIV
    289 ></BODY
    290 ></HTML
    291 >