doc/fcpattern.sgml

   1 <!--
   2    fontconfig/doc/func.sgml
   3
   4    Copyright © 2003 Keith Packard
   5
   6    Permission to use, copy, modify, distribute, and sell this software and its
   7    documentation for any purpose is hereby granted without fee, provided that
   8    the above copyright notice appear in all copies and that both that
   9    copyright notice and this permission notice appear in supporting
  10    documentation, and that the name of the author(s) not be used in
  11    advertising or publicity pertaining to distribution of the software without
  12    specific, written prior permission.  The authors make no
  13    representations about the suitability of this software for any purpose.  It
  14    is provided "as is" without express or implied warranty.
  15
  16    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  17    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  18    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  19    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  20    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  21    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  22    PERFORMANCE OF THIS SOFTWARE.
  23  -->
  24     <refentry id="FcPatternCreate">
  25         <refmeta>
  26             <refentrytitle>FcPatternCreate</refentrytitle>
  27             <manvolnum>3</manvolnum>
  28             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
  29         </refmeta>
  30         <refnamediv>
  31             <refname>FcPatternCreate</refname>
  32             <refpurpose>Create a pattern</refpurpose>
  33         </refnamediv>
  34         <refsynopsisdiv>
  35         <funcsynopsis>
  36         <funcsynopsisinfo>
  37 #include &lt;fontconfig/fontconfig.h&gt;
  38         </funcsynopsisinfo>
  39         <funcprototype>
  40             <funcdef>FcPattern * <function>FcPatternCreate</function></funcdef>
  41                 <paramdef>void<parameter></parameter></paramdef>
  42         </funcprototype>
  43         </funcsynopsis>
  44         </refsynopsisdiv>
  45         <refsect1><title>Description</title>
  46             <para>
  47 Creates a pattern with no properties; used to build patterns from scratch.
  48             </para>
  49         </refsect1>
  50     </refentry>
  51 <!--
  52    fontconfig/doc/func.sgml
  53
  54    Copyright © 2003 Keith Packard
  55
  56    Permission to use, copy, modify, distribute, and sell this software and its
  57    documentation for any purpose is hereby granted without fee, provided that
  58    the above copyright notice appear in all copies and that both that
  59    copyright notice and this permission notice appear in supporting
  60    documentation, and that the name of the author(s) not be used in
  61    advertising or publicity pertaining to distribution of the software without
  62    specific, written prior permission.  The authors make no
  63    representations about the suitability of this software for any purpose.  It
  64    is provided "as is" without express or implied warranty.
  65
  66    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  67    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  68    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  69    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  70    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  71    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  72    PERFORMANCE OF THIS SOFTWARE.
  73  -->
  74     <refentry id="FcPatternDuplicate">
  75         <refmeta>
  76             <refentrytitle>FcPatternDuplicate</refentrytitle>
  77             <manvolnum>3</manvolnum>
  78             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
  79         </refmeta>
  80         <refnamediv>
  81             <refname>FcPatternDuplicate</refname>
  82             <refpurpose>Copy a pattern</refpurpose>
  83         </refnamediv>
  84         <refsynopsisdiv>
  85         <funcsynopsis>
  86         <funcsynopsisinfo>
  87 #include &lt;fontconfig/fontconfig.h&gt;
  88         </funcsynopsisinfo>
  89         <funcprototype>
  90             <funcdef>FcPattern * <function>FcPatternDuplicate</function></funcdef>
  91                 <paramdef>const FcPattern *<parameter>p</parameter></paramdef>
  92         </funcprototype>
  93         </funcsynopsis>
  94         </refsynopsisdiv>
  95         <refsect1><title>Description</title>
  96             <para>
  97 Copy a pattern, returning a new pattern that matches
  98 <parameter>p</parameter>. Each pattern may be modified without affecting the
  99 other.
 100             </para>
 101         </refsect1>
 102     </refentry>
 103 <!--
 104    fontconfig/doc/func.sgml
 105
 106    Copyright © 2003 Keith Packard
 107
 108    Permission to use, copy, modify, distribute, and sell this software and its
 109    documentation for any purpose is hereby granted without fee, provided that
 110    the above copyright notice appear in all copies and that both that
 111    copyright notice and this permission notice appear in supporting
 112    documentation, and that the name of the author(s) not be used in
 113    advertising or publicity pertaining to distribution of the software without
 114    specific, written prior permission.  The authors make no
 115    representations about the suitability of this software for any purpose.  It
 116    is provided "as is" without express or implied warranty.
 117
 118    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 119    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 120    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 121    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 122    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 123    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 124    PERFORMANCE OF THIS SOFTWARE.
 125  -->
 126     <refentry id="FcPatternReference">
 127         <refmeta>
 128             <refentrytitle>FcPatternReference</refentrytitle>
 129             <manvolnum>3</manvolnum>
 130             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 131         </refmeta>
 132         <refnamediv>
 133             <refname>FcPatternReference</refname>
 134             <refpurpose>Increment pattern reference count</refpurpose>
 135         </refnamediv>
 136         <refsynopsisdiv>
 137         <funcsynopsis>
 138         <funcsynopsisinfo>
 139 #include &lt;fontconfig/fontconfig.h&gt;
 140         </funcsynopsisinfo>
 141         <funcprototype>
 142             <funcdef>void <function>FcPatternReference</function></funcdef>
 143                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 144         </funcprototype>
 145         </funcsynopsis>
 146         </refsynopsisdiv>
 147         <refsect1><title>Description</title>
 148             <para>
 149 Add another reference to <parameter>p</parameter>. Patterns are freed only
 150 when the reference count reaches zero.
 151             </para>
 152         </refsect1>
 153     </refentry>
 154 <!--
 155    fontconfig/doc/func.sgml
 156
 157    Copyright © 2003 Keith Packard
 158
 159    Permission to use, copy, modify, distribute, and sell this software and its
 160    documentation for any purpose is hereby granted without fee, provided that
 161    the above copyright notice appear in all copies and that both that
 162    copyright notice and this permission notice appear in supporting
 163    documentation, and that the name of the author(s) not be used in
 164    advertising or publicity pertaining to distribution of the software without
 165    specific, written prior permission.  The authors make no
 166    representations about the suitability of this software for any purpose.  It
 167    is provided "as is" without express or implied warranty.
 168
 169    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 170    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 171    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 172    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 173    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 174    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 175    PERFORMANCE OF THIS SOFTWARE.
 176  -->
 177     <refentry id="FcPatternDestroy">
 178         <refmeta>
 179             <refentrytitle>FcPatternDestroy</refentrytitle>
 180             <manvolnum>3</manvolnum>
 181             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 182         </refmeta>
 183         <refnamediv>
 184             <refname>FcPatternDestroy</refname>
 185             <refpurpose>Destroy a pattern</refpurpose>
 186         </refnamediv>
 187         <refsynopsisdiv>
 188         <funcsynopsis>
 189         <funcsynopsisinfo>
 190 #include &lt;fontconfig/fontconfig.h&gt;
 191         </funcsynopsisinfo>
 192         <funcprototype>
 193             <funcdef>void <function>FcPatternDestroy</function></funcdef>
 194                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 195         </funcprototype>
 196         </funcsynopsis>
 197         </refsynopsisdiv>
 198         <refsect1><title>Description</title>
 199             <para>
 200 Decrement the pattern reference count. If all references are gone, destroys
 201 the pattern, in the process destroying all related values.
 202             </para>
 203         </refsect1>
 204     </refentry>
 205 <!--
 206    fontconfig/doc/func.sgml
 207
 208    Copyright © 2003 Keith Packard
 209
 210    Permission to use, copy, modify, distribute, and sell this software and its
 211    documentation for any purpose is hereby granted without fee, provided that
 212    the above copyright notice appear in all copies and that both that
 213    copyright notice and this permission notice appear in supporting
 214    documentation, and that the name of the author(s) not be used in
 215    advertising or publicity pertaining to distribution of the software without
 216    specific, written prior permission.  The authors make no
 217    representations about the suitability of this software for any purpose.  It
 218    is provided "as is" without express or implied warranty.
 219
 220    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 221    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 222    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 223    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 224    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 225    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 226    PERFORMANCE OF THIS SOFTWARE.
 227  -->
 228     <refentry id="FcPatternEqual">
 229         <refmeta>
 230             <refentrytitle>FcPatternEqual</refentrytitle>
 231             <manvolnum>3</manvolnum>
 232             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 233         </refmeta>
 234         <refnamediv>
 235             <refname>FcPatternEqual</refname>
 236             <refpurpose>Compare patterns</refpurpose>
 237         </refnamediv>
 238         <refsynopsisdiv>
 239         <funcsynopsis>
 240         <funcsynopsisinfo>
 241 #include &lt;fontconfig/fontconfig.h&gt;
 242         </funcsynopsisinfo>
 243         <funcprototype>
 244             <funcdef>FcBool <function>FcPatternEqual</function></funcdef>
 245                 <paramdef>const FcPattern *<parameter>pa</parameter></paramdef>
 246                 <paramdef>const FcPattern *<parameter>pb</parameter></paramdef>
 247         </funcprototype>
 248         </funcsynopsis>
 249         </refsynopsisdiv>
 250         <refsect1><title>Description</title>
 251             <para>
 252 Returns whether <parameter>pa</parameter> and <parameter>pb</parameter> are exactly alike.
 253             </para>
 254         </refsect1>
 255     </refentry>
 256 <!--
 257    fontconfig/doc/func.sgml
 258
 259    Copyright © 2003 Keith Packard
 260
 261    Permission to use, copy, modify, distribute, and sell this software and its
 262    documentation for any purpose is hereby granted without fee, provided that
 263    the above copyright notice appear in all copies and that both that
 264    copyright notice and this permission notice appear in supporting
 265    documentation, and that the name of the author(s) not be used in
 266    advertising or publicity pertaining to distribution of the software without
 267    specific, written prior permission.  The authors make no
 268    representations about the suitability of this software for any purpose.  It
 269    is provided "as is" without express or implied warranty.
 270
 271    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 272    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 273    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 274    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 275    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 276    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 277    PERFORMANCE OF THIS SOFTWARE.
 278  -->
 279     <refentry id="FcPatternEqualSubset">
 280         <refmeta>
 281             <refentrytitle>FcPatternEqualSubset</refentrytitle>
 282             <manvolnum>3</manvolnum>
 283             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 284         </refmeta>
 285         <refnamediv>
 286             <refname>FcPatternEqualSubset</refname>
 287             <refpurpose>Compare portions of patterns</refpurpose>
 288         </refnamediv>
 289         <refsynopsisdiv>
 290         <funcsynopsis>
 291         <funcsynopsisinfo>
 292 #include &lt;fontconfig/fontconfig.h&gt;
 293         </funcsynopsisinfo>
 294         <funcprototype>
 295             <funcdef>FcBool <function>FcPatternEqualSubset</function></funcdef>
 296                 <paramdef>const FcPattern *<parameter>pa</parameter></paramdef>
 297                 <paramdef>const FcPattern *<parameter>pb</parameter></paramdef>
 298                 <paramdef>const FcObjectSet *<parameter>os</parameter></paramdef>
 299         </funcprototype>
 300         </funcsynopsis>
 301         </refsynopsisdiv>
 302         <refsect1><title>Description</title>
 303             <para>
 304 Returns whether <parameter>pa</parameter> and <parameter>pb</parameter> have exactly the same values for all of the
 305 objects in <parameter>os</parameter>.
 306             </para>
 307         </refsect1>
 308     </refentry>
 309 <!--
 310    fontconfig/doc/func.sgml
 311
 312    Copyright © 2003 Keith Packard
 313
 314    Permission to use, copy, modify, distribute, and sell this software and its
 315    documentation for any purpose is hereby granted without fee, provided that
 316    the above copyright notice appear in all copies and that both that
 317    copyright notice and this permission notice appear in supporting
 318    documentation, and that the name of the author(s) not be used in
 319    advertising or publicity pertaining to distribution of the software without
 320    specific, written prior permission.  The authors make no
 321    representations about the suitability of this software for any purpose.  It
 322    is provided "as is" without express or implied warranty.
 323
 324    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 325    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 326    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 327    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 328    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 329    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 330    PERFORMANCE OF THIS SOFTWARE.
 331  -->
 332     <refentry id="FcPatternFilter">
 333         <refmeta>
 334             <refentrytitle>FcPatternFilter</refentrytitle>
 335             <manvolnum>3</manvolnum>
 336             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 337         </refmeta>
 338         <refnamediv>
 339             <refname>FcPatternFilter</refname>
 340             <refpurpose>Filter the objects of pattern</refpurpose>
 341         </refnamediv>
 342         <refsynopsisdiv>
 343         <funcsynopsis>
 344         <funcsynopsisinfo>
 345 #include &lt;fontconfig/fontconfig.h&gt;
 346         </funcsynopsisinfo>
 347         <funcprototype>
 348             <funcdef>FcPattern * <function>FcPatternFilter</function></funcdef>
 349                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 350                 <paramdef>const FcObjectSet *<parameter></parameter></paramdef>
 351         </funcprototype>
 352         </funcsynopsis>
 353         </refsynopsisdiv>
 354         <refsect1><title>Description</title>
 355             <para>
 356 Returns a new pattern that only has those objects from
 357 <parameter>p</parameter> that are in <parameter>os</parameter>.
 358 If <parameter>os</parameter> is NULL, a duplicate of
 359 <parameter>p</parameter> is returned.
 360             </para>
 361         </refsect1>
 362     </refentry>
 363 <!--
 364    fontconfig/doc/func.sgml
 365
 366    Copyright © 2003 Keith Packard
 367
 368    Permission to use, copy, modify, distribute, and sell this software and its
 369    documentation for any purpose is hereby granted without fee, provided that
 370    the above copyright notice appear in all copies and that both that
 371    copyright notice and this permission notice appear in supporting
 372    documentation, and that the name of the author(s) not be used in
 373    advertising or publicity pertaining to distribution of the software without
 374    specific, written prior permission.  The authors make no
 375    representations about the suitability of this software for any purpose.  It
 376    is provided "as is" without express or implied warranty.
 377
 378    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 379    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 380    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 381    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 382    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 383    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 384    PERFORMANCE OF THIS SOFTWARE.
 385  -->
 386     <refentry id="FcPatternHash">
 387         <refmeta>
 388             <refentrytitle>FcPatternHash</refentrytitle>
 389             <manvolnum>3</manvolnum>
 390             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 391         </refmeta>
 392         <refnamediv>
 393             <refname>FcPatternHash</refname>
 394             <refpurpose>Compute a pattern hash value</refpurpose>
 395         </refnamediv>
 396         <refsynopsisdiv>
 397         <funcsynopsis>
 398         <funcsynopsisinfo>
 399 #include &lt;fontconfig/fontconfig.h&gt;
 400         </funcsynopsisinfo>
 401         <funcprototype>
 402             <funcdef>FcChar32 <function>FcPatternHash</function></funcdef>
 403                 <paramdef>const FcPattern *<parameter>p</parameter></paramdef>
 404         </funcprototype>
 405         </funcsynopsis>
 406         </refsynopsisdiv>
 407         <refsect1><title>Description</title>
 408             <para>
 409 Returns a 32-bit number which is the same for any two patterns which are
 410 equal.
 411             </para>
 412         </refsect1>
 413     </refentry>
 414 <!--
 415    fontconfig/doc/func.sgml
 416
 417    Copyright © 2003 Keith Packard
 418
 419    Permission to use, copy, modify, distribute, and sell this software and its
 420    documentation for any purpose is hereby granted without fee, provided that
 421    the above copyright notice appear in all copies and that both that
 422    copyright notice and this permission notice appear in supporting
 423    documentation, and that the name of the author(s) not be used in
 424    advertising or publicity pertaining to distribution of the software without
 425    specific, written prior permission.  The authors make no
 426    representations about the suitability of this software for any purpose.  It
 427    is provided "as is" without express or implied warranty.
 428
 429    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 430    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 431    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 432    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 433    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 434    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 435    PERFORMANCE OF THIS SOFTWARE.
 436  -->
 437     <refentry id="FcPatternAdd">
 438         <refmeta>
 439             <refentrytitle>FcPatternAdd</refentrytitle>
 440             <manvolnum>3</manvolnum>
 441             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 442         </refmeta>
 443         <refnamediv>
 444             <refname>FcPatternAdd</refname>
 445             <refpurpose>Add a value to a pattern</refpurpose>
 446         </refnamediv>
 447         <refsynopsisdiv>
 448         <funcsynopsis>
 449         <funcsynopsisinfo>
 450 #include &lt;fontconfig/fontconfig.h&gt;
 451         </funcsynopsisinfo>
 452         <funcprototype>
 453             <funcdef>FcBool <function>FcPatternAdd</function></funcdef>
 454                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 455                 <paramdef>const char *<parameter>object</parameter></paramdef>
 456                 <paramdef>FcValue <parameter>value</parameter></paramdef>
 457                 <paramdef>FcBool <parameter>append</parameter></paramdef>
 458         </funcprototype>
 459         </funcsynopsis>
 460         </refsynopsisdiv>
 461         <refsect1><title>Description</title>
 462             <para>
 463 Adds a single value to the list of values associated with the property named
 464 `object<parameter>.  If `append</parameter> is FcTrue, the value is added at the end of any
 465 existing list, otherwise it is inserted at the beginning.  `value' is saved
 466 (with FcValueSave) when inserted into the pattern so that the library
 467 retains no reference to any application-supplied data structure.
 468             </para>
 469         </refsect1>
 470     </refentry>
 471 <!--
 472    fontconfig/doc/func.sgml
 473
 474    Copyright © 2003 Keith Packard
 475
 476    Permission to use, copy, modify, distribute, and sell this software and its
 477    documentation for any purpose is hereby granted without fee, provided that
 478    the above copyright notice appear in all copies and that both that
 479    copyright notice and this permission notice appear in supporting
 480    documentation, and that the name of the author(s) not be used in
 481    advertising or publicity pertaining to distribution of the software without
 482    specific, written prior permission.  The authors make no
 483    representations about the suitability of this software for any purpose.  It
 484    is provided "as is" without express or implied warranty.
 485
 486    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 487    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 488    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 489    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 490    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 491    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 492    PERFORMANCE OF THIS SOFTWARE.
 493  -->
 494     <refentry id="FcPatternAddWeak">
 495         <refmeta>
 496             <refentrytitle>FcPatternAddWeak</refentrytitle>
 497             <manvolnum>3</manvolnum>
 498             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 499         </refmeta>
 500         <refnamediv>
 501             <refname>FcPatternAddWeak</refname>
 502             <refpurpose>Add a value to a pattern with weak binding</refpurpose>
 503         </refnamediv>
 504         <refsynopsisdiv>
 505         <funcsynopsis>
 506         <funcsynopsisinfo>
 507 #include &lt;fontconfig/fontconfig.h&gt;
 508         </funcsynopsisinfo>
 509         <funcprototype>
 510             <funcdef>FcBool <function>FcPatternAddWeak</function></funcdef>
 511                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 512                 <paramdef>const char *<parameter>object</parameter></paramdef>
 513                 <paramdef>FcValue <parameter>value</parameter></paramdef>
 514                 <paramdef>FcBool <parameter>append</parameter></paramdef>
 515         </funcprototype>
 516         </funcsynopsis>
 517         </refsynopsisdiv>
 518         <refsect1><title>Description</title>
 519             <para>
 520 FcPatternAddWeak is essentially the same as FcPatternAdd except that any
 521 values added to the list have binding <parameter>weak</parameter> instead of <parameter>strong</parameter>.
 522             </para>
 523         </refsect1>
 524     </refentry>
 525 <!--
 526    fontconfig/doc/func.sgml
 527
 528    Copyright © 2003 Keith Packard
 529
 530    Permission to use, copy, modify, distribute, and sell this software and its
 531    documentation for any purpose is hereby granted without fee, provided that
 532    the above copyright notice appear in all copies and that both that
 533    copyright notice and this permission notice appear in supporting
 534    documentation, and that the name of the author(s) not be used in
 535    advertising or publicity pertaining to distribution of the software without
 536    specific, written prior permission.  The authors make no
 537    representations about the suitability of this software for any purpose.  It
 538    is provided "as is" without express or implied warranty.
 539
 540    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 541    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 542    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 543    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 544    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 545    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 546    PERFORMANCE OF THIS SOFTWARE.
 547  -->
 548     <refentry id="FcPatternAdd-Type">
 549         <refmeta>
 550             <refentrytitle>FcPatternAdd-Type</refentrytitle>
 551             <manvolnum>3</manvolnum>
 552             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 553         </refmeta>
 554         <refnamediv>
 555             <refname>FcPatternAddInteger</refname>
 556             <refname>FcPatternAddDouble</refname>
 557             <refname>FcPatternAddString</refname>
 558             <refname>FcPatternAddMatrix</refname>
 559             <refname>FcPatternAddCharSet</refname>
 560             <refname>FcPatternAddBool</refname>
 561             <refname>FcPatternAddFTFace</refname>
 562             <refname>FcPatternAddLangSet</refname>
 563             <refname>FcPatternAddRange</refname>
 564             <refpurpose>Add a typed value to a pattern</refpurpose>
 565         </refnamediv>
 566         <refsynopsisdiv>
 567         <funcsynopsis>
 568         <funcsynopsisinfo>
 569 #include &lt;fontconfig/fontconfig.h&gt;
 570         </funcsynopsisinfo>
 571         <funcprototype>
 572             <funcdef>FcBool <function>FcPatternAddInteger</function></funcdef>
 573                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 574                 <paramdef>const char *<parameter>object</parameter></paramdef>
 575                 <paramdef>int <parameter>i</parameter></paramdef>
 576         </funcprototype>
 577         <funcprototype>
 578             <funcdef>FcBool <function>FcPatternAddDouble</function></funcdef>
 579                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 580                 <paramdef>const char *<parameter>object</parameter></paramdef>
 581                 <paramdef>double <parameter>d</parameter></paramdef>
 582         </funcprototype>
 583         <funcprototype>
 584             <funcdef>FcBool <function>FcPatternAddString</function></funcdef>
 585                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 586                 <paramdef>const char *<parameter>object</parameter></paramdef>
 587                 <paramdef>const FcChar8 *<parameter>s</parameter></paramdef>
 588         </funcprototype>
 589         <funcprototype>
 590             <funcdef>FcBool <function>FcPatternAddMatrix</function></funcdef>
 591                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 592                 <paramdef>const char *<parameter>object</parameter></paramdef>
 593                 <paramdef>const FcMatrix *<parameter>m</parameter></paramdef>
 594         </funcprototype>
 595         <funcprototype>
 596             <funcdef>FcBool <function>FcPatternAddCharSet</function></funcdef>
 597                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 598                 <paramdef>const char *<parameter>object</parameter></paramdef>
 599                 <paramdef>const FcCharSet *<parameter>c</parameter></paramdef>
 600         </funcprototype>
 601         <funcprototype>
 602             <funcdef>FcBool <function>FcPatternAddBool</function></funcdef>
 603                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 604                 <paramdef>const char *<parameter>object</parameter></paramdef>
 605                 <paramdef>FcBool <parameter>b</parameter></paramdef>
 606         </funcprototype>
 607         <funcprototype>
 608             <funcdef>FcBool <function>FcPatternAddFTFace</function></funcdef>
 609                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 610                 <paramdef>const char *<parameter>object</parameter></paramdef>
 611                 <paramdef>const FT_Face<parameter>f</parameter></paramdef>
 612         </funcprototype>
 613         <funcprototype>
 614             <funcdef>FcBool <function>FcPatternAddLangSet</function></funcdef>
 615                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 616                 <paramdef>const char *<parameter>object</parameter></paramdef>
 617                 <paramdef>const FcLangSet *<parameter>l</parameter></paramdef>
 618         </funcprototype>
 619         <funcprototype>
 620             <funcdef>FcBool <function>FcPatternAddRange</function></funcdef>
 621                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 622                 <paramdef>const char *<parameter>object</parameter></paramdef>
 623                 <paramdef>const FcRange *<parameter>r</parameter></paramdef>
 624         </funcprototype>
 625         </funcsynopsis>
 626         </refsynopsisdiv>
 627         <refsect1><title>Description</title>
 628             <para>
 629 These are all convenience functions that insert objects of the specified
 630 type into the pattern.  Use these in preference to FcPatternAdd as they
 631 will provide compile-time typechecking.  These all append values to
 632 any existing list of values.
 633
 634 <function>FcPatternAddRange</function> are available since 2.11.91.
 635             </para>
 636         </refsect1>
 637     </refentry>
 638 <!--
 639    fontconfig/doc/func.sgml
 640
 641    Copyright © 2003 Keith Packard
 642
 643    Permission to use, copy, modify, distribute, and sell this software and its
 644    documentation for any purpose is hereby granted without fee, provided that
 645    the above copyright notice appear in all copies and that both that
 646    copyright notice and this permission notice appear in supporting
 647    documentation, and that the name of the author(s) not be used in
 648    advertising or publicity pertaining to distribution of the software without
 649    specific, written prior permission.  The authors make no
 650    representations about the suitability of this software for any purpose.  It
 651    is provided "as is" without express or implied warranty.
 652
 653    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 654    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 655    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 656    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 657    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 658    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 659    PERFORMANCE OF THIS SOFTWARE.
 660  -->
 661     <refentry id="FcPatternGetWithBinding">
 662         <refmeta>
 663             <refentrytitle>FcPatternGetWithBinding</refentrytitle>
 664             <manvolnum>3</manvolnum>
 665             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 666         </refmeta>
 667         <refnamediv>
 668             <refname>FcPatternGetWithBinding</refname>
 669             <refpurpose>Return a value with binding from a pattern</refpurpose>
 670         </refnamediv>
 671         <refsynopsisdiv>
 672         <funcsynopsis>
 673         <funcsynopsisinfo>
 674 #include &lt;fontconfig/fontconfig.h&gt;
 675         </funcsynopsisinfo>
 676         <funcprototype>
 677             <funcdef>FcResult <function>FcPatternGetWithBinding</function></funcdef>
 678                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 679                 <paramdef>const char *<parameter>object</parameter></paramdef>
 680                 <paramdef>int <parameter>id</parameter></paramdef>
 681                 <paramdef>FcValue *<parameter>v</parameter></paramdef>
 682                 <paramdef>FcValueBinding *<parameter>b</parameter></paramdef>
 683         </funcprototype>
 684         </funcsynopsis>
 685         </refsynopsisdiv>
 686         <refsect1><title>Description</title>
 687             <para>
 688 Returns in <parameter>v</parameter> the <parameter>id</parameter>'th value
 689 and <parameter>b</parameter> binding for that associated with the property
 690 <parameter>object</parameter>.
 691 The Value returned is not a copy, but rather refers to the data stored
 692 within the pattern directly.  Applications must not free this value.
 693             </para>
 694         </refsect1>
 695         <refsect1><title>Since</title>
 696             <para>version 2.12.5</para>
 697         </refsect1>
 698     </refentry>
 699 <!--
 700    fontconfig/doc/func.sgml
 701
 702    Copyright © 2003 Keith Packard
 703
 704    Permission to use, copy, modify, distribute, and sell this software and its
 705    documentation for any purpose is hereby granted without fee, provided that
 706    the above copyright notice appear in all copies and that both that
 707    copyright notice and this permission notice appear in supporting
 708    documentation, and that the name of the author(s) not be used in
 709    advertising or publicity pertaining to distribution of the software without
 710    specific, written prior permission.  The authors make no
 711    representations about the suitability of this software for any purpose.  It
 712    is provided "as is" without express or implied warranty.
 713
 714    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 715    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 716    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 717    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 718    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 719    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 720    PERFORMANCE OF THIS SOFTWARE.
 721  -->
 722     <refentry id="FcPatternGet">
 723         <refmeta>
 724             <refentrytitle>FcPatternGet</refentrytitle>
 725             <manvolnum>3</manvolnum>
 726             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 727         </refmeta>
 728         <refnamediv>
 729             <refname>FcPatternGet</refname>
 730             <refpurpose>Return a value from a pattern</refpurpose>
 731         </refnamediv>
 732         <refsynopsisdiv>
 733         <funcsynopsis>
 734         <funcsynopsisinfo>
 735 #include &lt;fontconfig/fontconfig.h&gt;
 736         </funcsynopsisinfo>
 737         <funcprototype>
 738             <funcdef>FcResult <function>FcPatternGet</function></funcdef>
 739                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 740                 <paramdef>const char *<parameter>object</parameter></paramdef>
 741                 <paramdef>int <parameter>id</parameter></paramdef>
 742                 <paramdef>FcValue *<parameter>v</parameter></paramdef>
 743         </funcprototype>
 744         </funcsynopsis>
 745         </refsynopsisdiv>
 746         <refsect1><title>Description</title>
 747             <para>
 748 Returns in <parameter>v</parameter> the <parameter>id</parameter>'th value
 749 associated with the property <parameter>object</parameter>.
 750 The value returned is not a copy, but rather refers to the data stored
 751 within the pattern directly.  Applications must not free this value.
 752             </para>
 753         </refsect1>
 754     </refentry>
 755 <!--
 756    fontconfig/doc/func.sgml
 757
 758    Copyright © 2003 Keith Packard
 759
 760    Permission to use, copy, modify, distribute, and sell this software and its
 761    documentation for any purpose is hereby granted without fee, provided that
 762    the above copyright notice appear in all copies and that both that
 763    copyright notice and this permission notice appear in supporting
 764    documentation, and that the name of the author(s) not be used in
 765    advertising or publicity pertaining to distribution of the software without
 766    specific, written prior permission.  The authors make no
 767    representations about the suitability of this software for any purpose.  It
 768    is provided "as is" without express or implied warranty.
 769
 770    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 771    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 772    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 773    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 774    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 775    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 776    PERFORMANCE OF THIS SOFTWARE.
 777  -->
 778     <refentry id="FcPatternGet-Type">
 779         <refmeta>
 780             <refentrytitle>FcPatternGet-Type</refentrytitle>
 781             <manvolnum>3</manvolnum>
 782             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 783         </refmeta>
 784         <refnamediv>
 785             <refname>FcPatternGetInteger</refname>
 786             <refname>FcPatternGetDouble</refname>
 787             <refname>FcPatternGetString</refname>
 788             <refname>FcPatternGetMatrix</refname>
 789             <refname>FcPatternGetCharSet</refname>
 790             <refname>FcPatternGetBool</refname>
 791             <refname>FcPatternGetFTFace</refname>
 792             <refname>FcPatternGetLangSet</refname>
 793             <refname>FcPatternGetRange</refname>
 794             <refpurpose>Return a typed value from a pattern</refpurpose>
 795         </refnamediv>
 796         <refsynopsisdiv>
 797         <funcsynopsis>
 798         <funcsynopsisinfo>
 799 #include &lt;fontconfig/fontconfig.h&gt;
 800         </funcsynopsisinfo>
 801         <funcprototype>
 802             <funcdef>FcResult <function>FcPatternGetInteger</function></funcdef>
 803                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 804                 <paramdef>const char *<parameter>object</parameter></paramdef>
 805                 <paramdef>int <parameter>n</parameter></paramdef>
 806                 <paramdef>int *<parameter>i</parameter></paramdef>
 807         </funcprototype>
 808         <funcprototype>
 809             <funcdef>FcResult <function>FcPatternGetDouble</function></funcdef>
 810                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 811                 <paramdef>const char *<parameter>object</parameter></paramdef>
 812                 <paramdef>int <parameter>n</parameter></paramdef>
 813                 <paramdef>double *<parameter>d</parameter></paramdef>
 814         </funcprototype>
 815         <funcprototype>
 816             <funcdef>FcResult <function>FcPatternGetString</function></funcdef>
 817                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 818                 <paramdef>const char *<parameter>object</parameter></paramdef>
 819                 <paramdef>int <parameter>n</parameter></paramdef>
 820                 <paramdef>FcChar8 **<parameter>s</parameter></paramdef>
 821         </funcprototype>
 822         <funcprototype>
 823             <funcdef>FcResult <function>FcPatternGetMatrix</function></funcdef>
 824                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 825                 <paramdef>const char *<parameter>object</parameter></paramdef>
 826                 <paramdef>int <parameter>n</parameter></paramdef>
 827                 <paramdef>FcMatrix **<parameter>s</parameter></paramdef>
 828         </funcprototype>
 829         <funcprototype>
 830             <funcdef>FcResult <function>FcPatternGetCharSet</function></funcdef>
 831                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 832                 <paramdef>const char *<parameter>object</parameter></paramdef>
 833                 <paramdef>int <parameter>n</parameter></paramdef>
 834                 <paramdef>FcCharSet **<parameter>c</parameter></paramdef>
 835         </funcprototype>
 836         <funcprototype>
 837             <funcdef>FcResult <function>FcPatternGetBool</function></funcdef>
 838                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 839                 <paramdef>const char *<parameter>object</parameter></paramdef>
 840                 <paramdef>int <parameter>n</parameter></paramdef>
 841                 <paramdef>FcBool *<parameter>b</parameter></paramdef>
 842         </funcprototype>
 843         <funcprototype>
 844             <funcdef>FcResult <function>FcPatternGetFTFace</function></funcdef>
 845                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 846                 <paramdef>const char *<parameter>object</parameter></paramdef>
 847                 <paramdef>int <parameter>n</parameter></paramdef>
 848                 <paramdef>FT_Face *<parameter>f</parameter></paramdef>
 849         </funcprototype>
 850         <funcprototype>
 851             <funcdef>FcResult <function>FcPatternGetLangSet</function></funcdef>
 852                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 853                 <paramdef>const char *<parameter>object</parameter></paramdef>
 854                 <paramdef>int <parameter>n</parameter></paramdef>
 855                 <paramdef>FcLangSet **<parameter>l</parameter></paramdef>
 856         </funcprototype>
 857         <funcprototype>
 858             <funcdef>FcResult <function>FcPatternGetRange</function></funcdef>
 859                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 860                 <paramdef>const char *<parameter>object</parameter></paramdef>
 861                 <paramdef>int <parameter>n</parameter></paramdef>
 862                 <paramdef>FcRange **<parameter>r</parameter></paramdef>
 863         </funcprototype>
 864         </funcsynopsis>
 865         </refsynopsisdiv>
 866         <refsect1><title>Description</title>
 867             <para>
 868 These are convenience functions that call FcPatternGet and verify that the
 869 returned data is of the expected type. They return FcResultTypeMismatch if
 870 this is not the case.  Note that these (like FcPatternGet) do not make a
 871 copy of any data structure referenced by the return value.  Use these
 872 in preference to FcPatternGet to provide compile-time typechecking.
 873
 874 <function>FcPatternGetRange</function> are available since 2.11.91.
 875             </para>
 876         </refsect1>
 877     </refentry>
 878 <!--
 879    fontconfig/doc/func.sgml
 880
 881    Copyright © 2003 Keith Packard
 882
 883    Permission to use, copy, modify, distribute, and sell this software and its
 884    documentation for any purpose is hereby granted without fee, provided that
 885    the above copyright notice appear in all copies and that both that
 886    copyright notice and this permission notice appear in supporting
 887    documentation, and that the name of the author(s) not be used in
 888    advertising or publicity pertaining to distribution of the software without
 889    specific, written prior permission.  The authors make no
 890    representations about the suitability of this software for any purpose.  It
 891    is provided "as is" without express or implied warranty.
 892
 893    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 894    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 895    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 896    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 897    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 898    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 899    PERFORMANCE OF THIS SOFTWARE.
 900  -->
 901     <refentry id="FcPatternBuild">
 902         <refmeta>
 903             <refentrytitle>FcPatternBuild</refentrytitle>
 904             <manvolnum>3</manvolnum>
 905             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 906         </refmeta>
 907         <refnamediv>
 908             <refname>FcPatternBuild</refname>
 909             <refname>FcPatternVaBuild</refname>
 910             <refname>FcPatternVapBuild</refname>
 911             <refpurpose>Create patterns from arguments</refpurpose>
 912         </refnamediv>
 913         <refsynopsisdiv>
 914         <funcsynopsis>
 915         <funcsynopsisinfo>
 916 #include &lt;fontconfig/fontconfig.h&gt;
 917         </funcsynopsisinfo>
 918         <funcprototype>
 919             <funcdef>FcPattern * <function>FcPatternBuild</function></funcdef>
 920                 <paramdef>FcPattern *<parameter>pattern</parameter></paramdef>
 921                 <paramdef>...<parameter></parameter></paramdef>
 922         </funcprototype>
 923         <funcprototype>
 924             <funcdef>FcPattern * <function>FcPatternVaBuild</function></funcdef>
 925                 <paramdef>FcPattern *<parameter>pattern</parameter></paramdef>
 926                 <paramdef>va_list <parameter>va</parameter></paramdef>
 927         </funcprototype>
 928         <funcprototype>
 929             <funcdef>void <function>FcPatternVapBuild</function></funcdef>
 930                 <paramdef>FcPattern *<parameter>result</parameter></paramdef>
 931                 <paramdef>FcPattern *<parameter>pattern</parameter></paramdef>
 932                 <paramdef>va_list <parameter>va</parameter></paramdef>
 933         </funcprototype>
 934         </funcsynopsis>
 935         </refsynopsisdiv>
 936         <refsect1><title>Description</title>
 937             <para>
 938 Builds a pattern using a list of objects, types and values.  Each
 939 value to be entered in the pattern is specified with three arguments:
 940 </para>
 941 <orderedlist>
 942 <listitem><para>
 943 Object name, a string describing the property to be added.
 944 </para></listitem><listitem><para>
 945 Object type, one of the FcType enumerated values
 946 </para></listitem><listitem><para>
 947 Value, not an FcValue, but the raw type as passed to any of the
 948 FcPatternAdd&lt;type&gt; functions.  Must match the type of the second
 949 argument.
 950 </para></listitem>
 951 </orderedlist>
 952 <para>
 953 The argument list is terminated by a null object name, no object type nor
 954 value need be passed for this.  The values are added to `pattern', if
 955 `pattern' is null, a new pattern is created.  In either case, the pattern is
 956 returned. Example
 957 </para>
 958 <programlisting>
 959 pattern = FcPatternBuild (0, FC_FAMILY, FcTypeString, "Times", (char *) 0);
 960 </programlisting>
 961 <para>
 962 FcPatternVaBuild is used when the arguments are already in the form of a
 963 varargs value. FcPatternVapBuild is a macro version of FcPatternVaBuild
 964 which returns its result directly in the <parameter>result</parameter>
 965 variable.
 966             </para>
 967         </refsect1>
 968     </refentry>
 969 <!--
 970    fontconfig/doc/func.sgml
 971
 972    Copyright © 2003 Keith Packard
 973
 974    Permission to use, copy, modify, distribute, and sell this software and its
 975    documentation for any purpose is hereby granted without fee, provided that
 976    the above copyright notice appear in all copies and that both that
 977    copyright notice and this permission notice appear in supporting
 978    documentation, and that the name of the author(s) not be used in
 979    advertising or publicity pertaining to distribution of the software without
 980    specific, written prior permission.  The authors make no
 981    representations about the suitability of this software for any purpose.  It
 982    is provided "as is" without express or implied warranty.
 983
 984    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 985    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 986    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 987    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 988    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 989    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 990    PERFORMANCE OF THIS SOFTWARE.
 991  -->
 992     <refentry id="FcPatternDel">
 993         <refmeta>
 994             <refentrytitle>FcPatternDel</refentrytitle>
 995             <manvolnum>3</manvolnum>
 996             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 997         </refmeta>
 998         <refnamediv>
 999             <refname>FcPatternDel</refname>
1000             <refpurpose>Delete a property from a pattern</refpurpose>
1001         </refnamediv>
1002         <refsynopsisdiv>
1003         <funcsynopsis>
1004         <funcsynopsisinfo>
1005 #include &lt;fontconfig/fontconfig.h&gt;
1006         </funcsynopsisinfo>
1007         <funcprototype>
1008             <funcdef>FcBool <function>FcPatternDel</function></funcdef>
1009                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
1010                 <paramdef>const char *<parameter>object</parameter></paramdef>
1011         </funcprototype>
1012         </funcsynopsis>
1013         </refsynopsisdiv>
1014         <refsect1><title>Description</title>
1015             <para>
1016 Deletes all values associated with the property `object', returning
1017 whether the property existed or not.
1018             </para>
1019         </refsect1>
1020     </refentry>
1021 <!--
1022    fontconfig/doc/func.sgml
1023
1024    Copyright © 2003 Keith Packard
1025
1026    Permission to use, copy, modify, distribute, and sell this software and its
1027    documentation for any purpose is hereby granted without fee, provided that
1028    the above copyright notice appear in all copies and that both that
1029    copyright notice and this permission notice appear in supporting
1030    documentation, and that the name of the author(s) not be used in
1031    advertising or publicity pertaining to distribution of the software without
1032    specific, written prior permission.  The authors make no
1033    representations about the suitability of this software for any purpose.  It
1034    is provided "as is" without express or implied warranty.
1035
1036    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1037    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1038    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1039    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1040    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1041    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1042    PERFORMANCE OF THIS SOFTWARE.
1043  -->
1044     <refentry id="FcPatternRemove">
1045         <refmeta>
1046             <refentrytitle>FcPatternRemove</refentrytitle>
1047             <manvolnum>3</manvolnum>
1048             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1049         </refmeta>
1050         <refnamediv>
1051             <refname>FcPatternRemove</refname>
1052             <refpurpose>Remove one object of the specified type from the pattern</refpurpose>
1053         </refnamediv>
1054         <refsynopsisdiv>
1055         <funcsynopsis>
1056         <funcsynopsisinfo>
1057 #include &lt;fontconfig/fontconfig.h&gt;
1058         </funcsynopsisinfo>
1059         <funcprototype>
1060             <funcdef>FcBool <function>FcPatternRemove</function></funcdef>
1061                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
1062                 <paramdef>const char *<parameter>object</parameter></paramdef>
1063                 <paramdef>int <parameter>id</parameter></paramdef>
1064         </funcprototype>
1065         </funcsynopsis>
1066         </refsynopsisdiv>
1067         <refsect1><title>Description</title>
1068             <para>
1069 Removes the value associated with the property `object' at position `id', returning
1070 whether the property existed and had a value at that position or not.
1071             </para>
1072         </refsect1>
1073     </refentry>
1074 <!--
1075    fontconfig/doc/func.sgml
1076
1077    Copyright © 2003 Keith Packard
1078
1079    Permission to use, copy, modify, distribute, and sell this software and its
1080    documentation for any purpose is hereby granted without fee, provided that
1081    the above copyright notice appear in all copies and that both that
1082    copyright notice and this permission notice appear in supporting
1083    documentation, and that the name of the author(s) not be used in
1084    advertising or publicity pertaining to distribution of the software without
1085    specific, written prior permission.  The authors make no
1086    representations about the suitability of this software for any purpose.  It
1087    is provided "as is" without express or implied warranty.
1088
1089    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1090    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1091    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1092    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1093    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1094    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1095    PERFORMANCE OF THIS SOFTWARE.
1096  -->
1097     <refentry id="FcPatternPrint">
1098         <refmeta>
1099             <refentrytitle>FcPatternPrint</refentrytitle>
1100             <manvolnum>3</manvolnum>
1101             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1102         </refmeta>
1103         <refnamediv>
1104             <refname>FcPatternPrint</refname>
1105             <refpurpose>Print a pattern for debugging</refpurpose>
1106         </refnamediv>
1107         <refsynopsisdiv>
1108         <funcsynopsis>
1109         <funcsynopsisinfo>
1110 #include &lt;fontconfig/fontconfig.h&gt;
1111         </funcsynopsisinfo>
1112         <funcprototype>
1113             <funcdef>void <function>FcPatternPrint</function></funcdef>
1114                 <paramdef>const FcPattern *<parameter>p</parameter></paramdef>
1115         </funcprototype>
1116         </funcsynopsis>
1117         </refsynopsisdiv>
1118         <refsect1><title>Description</title>
1119             <para>
1120 Prints an easily readable version of the pattern to stdout.  There is
1121 no provision for reparsing data in this format, it's just for diagnostics
1122 and debugging.
1123             </para>
1124         </refsect1>
1125     </refentry>
1126 <!--
1127    fontconfig/doc/func.sgml
1128
1129    Copyright © 2003 Keith Packard
1130
1131    Permission to use, copy, modify, distribute, and sell this software and its
1132    documentation for any purpose is hereby granted without fee, provided that
1133    the above copyright notice appear in all copies and that both that
1134    copyright notice and this permission notice appear in supporting
1135    documentation, and that the name of the author(s) not be used in
1136    advertising or publicity pertaining to distribution of the software without
1137    specific, written prior permission.  The authors make no
1138    representations about the suitability of this software for any purpose.  It
1139    is provided "as is" without express or implied warranty.
1140
1141    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1142    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1143    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1144    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1145    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1146    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1147    PERFORMANCE OF THIS SOFTWARE.
1148  -->
1149     <refentry id="FcDefaultSubstitute">
1150         <refmeta>
1151             <refentrytitle>FcDefaultSubstitute</refentrytitle>
1152             <manvolnum>3</manvolnum>
1153             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1154         </refmeta>
1155         <refnamediv>
1156             <refname>FcDefaultSubstitute</refname>
1157             <refpurpose>Perform default substitutions in a pattern</refpurpose>
1158         </refnamediv>
1159         <refsynopsisdiv>
1160         <funcsynopsis>
1161         <funcsynopsisinfo>
1162 #include &lt;fontconfig/fontconfig.h&gt;
1163         </funcsynopsisinfo>
1164         <funcprototype>
1165             <funcdef>void <function>FcDefaultSubstitute</function></funcdef>
1166                 <paramdef>FcPattern *<parameter>pattern</parameter></paramdef>
1167         </funcprototype>
1168         </funcsynopsis>
1169         </refsynopsisdiv>
1170         <refsect1><title>Description</title>
1171             <para>
1172 Supplies default values for underspecified font patterns:
1173 <itemizedlist>
1174 <listitem><para>
1175 Patterns without a specified style or weight are set to Medium
1176 </para></listitem>
1177 <listitem><para>
1178 Patterns without a specified style or slant are set to Roman
1179 </para></listitem>
1180 <listitem><para>
1181 Patterns without a specified pixel size are given one computed from any
1182 specified point size (default 12), dpi (default 75) and scale (default 1).
1183 </para></listitem>
1184 </itemizedlist>
1185             </para>
1186         </refsect1>
1187     </refentry>
1188 <!--
1189    fontconfig/doc/func.sgml
1190
1191    Copyright © 2003 Keith Packard
1192
1193    Permission to use, copy, modify, distribute, and sell this software and its
1194    documentation for any purpose is hereby granted without fee, provided that
1195    the above copyright notice appear in all copies and that both that
1196    copyright notice and this permission notice appear in supporting
1197    documentation, and that the name of the author(s) not be used in
1198    advertising or publicity pertaining to distribution of the software without
1199    specific, written prior permission.  The authors make no
1200    representations about the suitability of this software for any purpose.  It
1201    is provided "as is" without express or implied warranty.
1202
1203    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1204    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1205    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1206    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1207    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1208    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1209    PERFORMANCE OF THIS SOFTWARE.
1210  -->
1211     <refentry id="FcNameParse">
1212         <refmeta>
1213             <refentrytitle>FcNameParse</refentrytitle>
1214             <manvolnum>3</manvolnum>
1215             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1216         </refmeta>
1217         <refnamediv>
1218             <refname>FcNameParse</refname>
1219             <refpurpose>Parse a pattern string</refpurpose>
1220         </refnamediv>
1221         <refsynopsisdiv>
1222         <funcsynopsis>
1223         <funcsynopsisinfo>
1224 #include &lt;fontconfig/fontconfig.h&gt;
1225         </funcsynopsisinfo>
1226         <funcprototype>
1227             <funcdef>FcPattern * <function>FcNameParse</function></funcdef>
1228                 <paramdef>const FcChar8 *<parameter>name</parameter></paramdef>
1229         </funcprototype>
1230         </funcsynopsis>
1231         </refsynopsisdiv>
1232         <refsect1><title>Description</title>
1233             <para>
1234 Converts <parameter>name</parameter> from the standard text format described above into a pattern.
1235             </para>
1236         </refsect1>
1237     </refentry>
1238 <!--
1239    fontconfig/doc/func.sgml
1240
1241    Copyright © 2003 Keith Packard
1242
1243    Permission to use, copy, modify, distribute, and sell this software and its
1244    documentation for any purpose is hereby granted without fee, provided that
1245    the above copyright notice appear in all copies and that both that
1246    copyright notice and this permission notice appear in supporting
1247    documentation, and that the name of the author(s) not be used in
1248    advertising or publicity pertaining to distribution of the software without
1249    specific, written prior permission.  The authors make no
1250    representations about the suitability of this software for any purpose.  It
1251    is provided "as is" without express or implied warranty.
1252
1253    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1254    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1255    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1256    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1257    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1258    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1259    PERFORMANCE OF THIS SOFTWARE.
1260  -->
1261     <refentry id="FcNameUnparse">
1262         <refmeta>
1263             <refentrytitle>FcNameUnparse</refentrytitle>
1264             <manvolnum>3</manvolnum>
1265             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1266         </refmeta>
1267         <refnamediv>
1268             <refname>FcNameUnparse</refname>
1269             <refpurpose>Convert a pattern back into a string that can be parsed</refpurpose>
1270         </refnamediv>
1271         <refsynopsisdiv>
1272         <funcsynopsis>
1273         <funcsynopsisinfo>
1274 #include &lt;fontconfig/fontconfig.h&gt;
1275         </funcsynopsisinfo>
1276         <funcprototype>
1277             <funcdef>FcChar8 * <function>FcNameUnparse</function></funcdef>
1278                 <paramdef>FcPattern *<parameter>pat</parameter></paramdef>
1279         </funcprototype>
1280         </funcsynopsis>
1281         </refsynopsisdiv>
1282         <refsect1><title>Description</title>
1283             <para>
1284 Converts the given pattern into the standard text format described above.
1285 The return value is not static, but instead refers to newly allocated memory
1286 which should be freed by the caller using free().
1287             </para>
1288         </refsect1>
1289     </refentry>