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="FcPatternObjectCount">
 229         <refmeta>
 230             <refentrytitle>FcPatternObjectCount</refentrytitle>
 231             <manvolnum>3</manvolnum>
 232             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 233         </refmeta>
 234         <refnamediv>
 235             <refname>FcPatternObjectCount</refname>
 236             <refpurpose>Returns the number of the object</refpurpose>
 237         </refnamediv>
 238         <refsynopsisdiv>
 239         <funcsynopsis>
 240         <funcsynopsisinfo>
 241 #include &lt;fontconfig/fontconfig.h&gt;
 242         </funcsynopsisinfo>
 243         <funcprototype>
 244             <funcdef>int <function>FcPatternObjectCount</function></funcdef>
 245                 <paramdef>const FcPattern *<parameter>p</parameter></paramdef>
 246         </funcprototype>
 247         </funcsynopsis>
 248         </refsynopsisdiv>
 249         <refsect1><title>Description</title>
 250             <para>
 251 Returns the number of the object <parameter>p</parameter> has.
 252             </para>
 253         </refsect1>
 254         <refsect1><title>Since</title>
 255             <para>version 2.13.1</para>
 256         </refsect1>
 257     </refentry>
 258 <!--
 259    fontconfig/doc/func.sgml
 260
 261    Copyright © 2003 Keith Packard
 262
 263    Permission to use, copy, modify, distribute, and sell this software and its
 264    documentation for any purpose is hereby granted without fee, provided that
 265    the above copyright notice appear in all copies and that both that
 266    copyright notice and this permission notice appear in supporting
 267    documentation, and that the name of the author(s) not be used in
 268    advertising or publicity pertaining to distribution of the software without
 269    specific, written prior permission.  The authors make no
 270    representations about the suitability of this software for any purpose.  It
 271    is provided "as is" without express or implied warranty.
 272
 273    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 274    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 275    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 276    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 277    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 278    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 279    PERFORMANCE OF THIS SOFTWARE.
 280  -->
 281     <refentry id="FcPatternEqual">
 282         <refmeta>
 283             <refentrytitle>FcPatternEqual</refentrytitle>
 284             <manvolnum>3</manvolnum>
 285             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 286         </refmeta>
 287         <refnamediv>
 288             <refname>FcPatternEqual</refname>
 289             <refpurpose>Compare patterns</refpurpose>
 290         </refnamediv>
 291         <refsynopsisdiv>
 292         <funcsynopsis>
 293         <funcsynopsisinfo>
 294 #include &lt;fontconfig/fontconfig.h&gt;
 295         </funcsynopsisinfo>
 296         <funcprototype>
 297             <funcdef>FcBool <function>FcPatternEqual</function></funcdef>
 298                 <paramdef>const FcPattern *<parameter>pa</parameter></paramdef>
 299                 <paramdef>const FcPattern *<parameter>pb</parameter></paramdef>
 300         </funcprototype>
 301         </funcsynopsis>
 302         </refsynopsisdiv>
 303         <refsect1><title>Description</title>
 304             <para>
 305 Returns whether <parameter>pa</parameter> and <parameter>pb</parameter> are exactly alike.
 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="FcPatternEqualSubset">
 333         <refmeta>
 334             <refentrytitle>FcPatternEqualSubset</refentrytitle>
 335             <manvolnum>3</manvolnum>
 336             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 337         </refmeta>
 338         <refnamediv>
 339             <refname>FcPatternEqualSubset</refname>
 340             <refpurpose>Compare portions of patterns</refpurpose>
 341         </refnamediv>
 342         <refsynopsisdiv>
 343         <funcsynopsis>
 344         <funcsynopsisinfo>
 345 #include &lt;fontconfig/fontconfig.h&gt;
 346         </funcsynopsisinfo>
 347         <funcprototype>
 348             <funcdef>FcBool <function>FcPatternEqualSubset</function></funcdef>
 349                 <paramdef>const FcPattern *<parameter>pa</parameter></paramdef>
 350                 <paramdef>const FcPattern *<parameter>pb</parameter></paramdef>
 351                 <paramdef>const FcObjectSet *<parameter>os</parameter></paramdef>
 352         </funcprototype>
 353         </funcsynopsis>
 354         </refsynopsisdiv>
 355         <refsect1><title>Description</title>
 356             <para>
 357 Returns whether <parameter>pa</parameter> and <parameter>pb</parameter> have exactly the same values for all of the
 358 objects in <parameter>os</parameter>.
 359             </para>
 360         </refsect1>
 361     </refentry>
 362 <!--
 363    fontconfig/doc/func.sgml
 364
 365    Copyright © 2003 Keith Packard
 366
 367    Permission to use, copy, modify, distribute, and sell this software and its
 368    documentation for any purpose is hereby granted without fee, provided that
 369    the above copyright notice appear in all copies and that both that
 370    copyright notice and this permission notice appear in supporting
 371    documentation, and that the name of the author(s) not be used in
 372    advertising or publicity pertaining to distribution of the software without
 373    specific, written prior permission.  The authors make no
 374    representations about the suitability of this software for any purpose.  It
 375    is provided "as is" without express or implied warranty.
 376
 377    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 378    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 379    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 380    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 381    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 382    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 383    PERFORMANCE OF THIS SOFTWARE.
 384  -->
 385     <refentry id="FcPatternFilter">
 386         <refmeta>
 387             <refentrytitle>FcPatternFilter</refentrytitle>
 388             <manvolnum>3</manvolnum>
 389             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 390         </refmeta>
 391         <refnamediv>
 392             <refname>FcPatternFilter</refname>
 393             <refpurpose>Filter the objects of pattern</refpurpose>
 394         </refnamediv>
 395         <refsynopsisdiv>
 396         <funcsynopsis>
 397         <funcsynopsisinfo>
 398 #include &lt;fontconfig/fontconfig.h&gt;
 399         </funcsynopsisinfo>
 400         <funcprototype>
 401             <funcdef>FcPattern * <function>FcPatternFilter</function></funcdef>
 402                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 403                 <paramdef>const FcObjectSet *<parameter></parameter></paramdef>
 404         </funcprototype>
 405         </funcsynopsis>
 406         </refsynopsisdiv>
 407         <refsect1><title>Description</title>
 408             <para>
 409 Returns a new pattern that only has those objects from
 410 <parameter>p</parameter> that are in <parameter>os</parameter>.
 411 If <parameter>os</parameter> is NULL, a duplicate of
 412 <parameter>p</parameter> is returned.
 413             </para>
 414         </refsect1>
 415     </refentry>
 416 <!--
 417    fontconfig/doc/func.sgml
 418
 419    Copyright © 2003 Keith Packard
 420
 421    Permission to use, copy, modify, distribute, and sell this software and its
 422    documentation for any purpose is hereby granted without fee, provided that
 423    the above copyright notice appear in all copies and that both that
 424    copyright notice and this permission notice appear in supporting
 425    documentation, and that the name of the author(s) not be used in
 426    advertising or publicity pertaining to distribution of the software without
 427    specific, written prior permission.  The authors make no
 428    representations about the suitability of this software for any purpose.  It
 429    is provided "as is" without express or implied warranty.
 430
 431    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 432    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 433    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 434    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 435    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 436    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 437    PERFORMANCE OF THIS SOFTWARE.
 438  -->
 439     <refentry id="FcPatternHash">
 440         <refmeta>
 441             <refentrytitle>FcPatternHash</refentrytitle>
 442             <manvolnum>3</manvolnum>
 443             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 444         </refmeta>
 445         <refnamediv>
 446             <refname>FcPatternHash</refname>
 447             <refpurpose>Compute a pattern hash value</refpurpose>
 448         </refnamediv>
 449         <refsynopsisdiv>
 450         <funcsynopsis>
 451         <funcsynopsisinfo>
 452 #include &lt;fontconfig/fontconfig.h&gt;
 453         </funcsynopsisinfo>
 454         <funcprototype>
 455             <funcdef>FcChar32 <function>FcPatternHash</function></funcdef>
 456                 <paramdef>const FcPattern *<parameter>p</parameter></paramdef>
 457         </funcprototype>
 458         </funcsynopsis>
 459         </refsynopsisdiv>
 460         <refsect1><title>Description</title>
 461             <para>
 462 Returns a 32-bit number which is the same for any two patterns which are
 463 equal.
 464             </para>
 465         </refsect1>
 466     </refentry>
 467 <!--
 468    fontconfig/doc/func.sgml
 469
 470    Copyright © 2003 Keith Packard
 471
 472    Permission to use, copy, modify, distribute, and sell this software and its
 473    documentation for any purpose is hereby granted without fee, provided that
 474    the above copyright notice appear in all copies and that both that
 475    copyright notice and this permission notice appear in supporting
 476    documentation, and that the name of the author(s) not be used in
 477    advertising or publicity pertaining to distribution of the software without
 478    specific, written prior permission.  The authors make no
 479    representations about the suitability of this software for any purpose.  It
 480    is provided "as is" without express or implied warranty.
 481
 482    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 483    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 484    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 485    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 486    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 487    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 488    PERFORMANCE OF THIS SOFTWARE.
 489  -->
 490     <refentry id="FcPatternAdd">
 491         <refmeta>
 492             <refentrytitle>FcPatternAdd</refentrytitle>
 493             <manvolnum>3</manvolnum>
 494             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 495         </refmeta>
 496         <refnamediv>
 497             <refname>FcPatternAdd</refname>
 498             <refpurpose>Add a value to a pattern</refpurpose>
 499         </refnamediv>
 500         <refsynopsisdiv>
 501         <funcsynopsis>
 502         <funcsynopsisinfo>
 503 #include &lt;fontconfig/fontconfig.h&gt;
 504         </funcsynopsisinfo>
 505         <funcprototype>
 506             <funcdef>FcBool <function>FcPatternAdd</function></funcdef>
 507                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 508                 <paramdef>const char *<parameter>object</parameter></paramdef>
 509                 <paramdef>FcValue <parameter>value</parameter></paramdef>
 510                 <paramdef>FcBool <parameter>append</parameter></paramdef>
 511         </funcprototype>
 512         </funcsynopsis>
 513         </refsynopsisdiv>
 514         <refsect1><title>Description</title>
 515             <para>
 516 Adds a single value to the list of values associated with the property named
 517 `object<parameter>.  If `append</parameter> is FcTrue, the value is added at the end of any
 518 existing list, otherwise it is inserted at the beginning.  `value' is saved
 519 (with FcValueSave) when inserted into the pattern so that the library
 520 retains no reference to any application-supplied data structure.
 521             </para>
 522         </refsect1>
 523     </refentry>
 524 <!--
 525    fontconfig/doc/func.sgml
 526
 527    Copyright © 2003 Keith Packard
 528
 529    Permission to use, copy, modify, distribute, and sell this software and its
 530    documentation for any purpose is hereby granted without fee, provided that
 531    the above copyright notice appear in all copies and that both that
 532    copyright notice and this permission notice appear in supporting
 533    documentation, and that the name of the author(s) not be used in
 534    advertising or publicity pertaining to distribution of the software without
 535    specific, written prior permission.  The authors make no
 536    representations about the suitability of this software for any purpose.  It
 537    is provided "as is" without express or implied warranty.
 538
 539    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 540    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 541    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 542    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 543    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 544    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 545    PERFORMANCE OF THIS SOFTWARE.
 546  -->
 547     <refentry id="FcPatternAddWeak">
 548         <refmeta>
 549             <refentrytitle>FcPatternAddWeak</refentrytitle>
 550             <manvolnum>3</manvolnum>
 551             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 552         </refmeta>
 553         <refnamediv>
 554             <refname>FcPatternAddWeak</refname>
 555             <refpurpose>Add a value to a pattern with weak binding</refpurpose>
 556         </refnamediv>
 557         <refsynopsisdiv>
 558         <funcsynopsis>
 559         <funcsynopsisinfo>
 560 #include &lt;fontconfig/fontconfig.h&gt;
 561         </funcsynopsisinfo>
 562         <funcprototype>
 563             <funcdef>FcBool <function>FcPatternAddWeak</function></funcdef>
 564                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 565                 <paramdef>const char *<parameter>object</parameter></paramdef>
 566                 <paramdef>FcValue <parameter>value</parameter></paramdef>
 567                 <paramdef>FcBool <parameter>append</parameter></paramdef>
 568         </funcprototype>
 569         </funcsynopsis>
 570         </refsynopsisdiv>
 571         <refsect1><title>Description</title>
 572             <para>
 573 FcPatternAddWeak is essentially the same as FcPatternAdd except that any
 574 values added to the list have binding <parameter>weak</parameter> instead of <parameter>strong</parameter>.
 575             </para>
 576         </refsect1>
 577     </refentry>
 578 <!--
 579    fontconfig/doc/func.sgml
 580
 581    Copyright © 2003 Keith Packard
 582
 583    Permission to use, copy, modify, distribute, and sell this software and its
 584    documentation for any purpose is hereby granted without fee, provided that
 585    the above copyright notice appear in all copies and that both that
 586    copyright notice and this permission notice appear in supporting
 587    documentation, and that the name of the author(s) not be used in
 588    advertising or publicity pertaining to distribution of the software without
 589    specific, written prior permission.  The authors make no
 590    representations about the suitability of this software for any purpose.  It
 591    is provided "as is" without express or implied warranty.
 592
 593    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 594    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 595    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 596    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 597    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 598    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 599    PERFORMANCE OF THIS SOFTWARE.
 600  -->
 601     <refentry id="FcPatternAdd-Type">
 602         <refmeta>
 603             <refentrytitle>FcPatternAdd-Type</refentrytitle>
 604             <manvolnum>3</manvolnum>
 605             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 606         </refmeta>
 607         <refnamediv>
 608             <refname>FcPatternAddInteger</refname>
 609             <refname>FcPatternAddDouble</refname>
 610             <refname>FcPatternAddString</refname>
 611             <refname>FcPatternAddMatrix</refname>
 612             <refname>FcPatternAddCharSet</refname>
 613             <refname>FcPatternAddBool</refname>
 614             <refname>FcPatternAddFTFace</refname>
 615             <refname>FcPatternAddLangSet</refname>
 616             <refname>FcPatternAddRange</refname>
 617             <refpurpose>Add a typed value to a pattern</refpurpose>
 618         </refnamediv>
 619         <refsynopsisdiv>
 620         <funcsynopsis>
 621         <funcsynopsisinfo>
 622 #include &lt;fontconfig/fontconfig.h&gt;
 623         </funcsynopsisinfo>
 624         <funcprototype>
 625             <funcdef>FcBool <function>FcPatternAddInteger</function></funcdef>
 626                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 627                 <paramdef>const char *<parameter>object</parameter></paramdef>
 628                 <paramdef>int <parameter>i</parameter></paramdef>
 629         </funcprototype>
 630         <funcprototype>
 631             <funcdef>FcBool <function>FcPatternAddDouble</function></funcdef>
 632                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 633                 <paramdef>const char *<parameter>object</parameter></paramdef>
 634                 <paramdef>double <parameter>d</parameter></paramdef>
 635         </funcprototype>
 636         <funcprototype>
 637             <funcdef>FcBool <function>FcPatternAddString</function></funcdef>
 638                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 639                 <paramdef>const char *<parameter>object</parameter></paramdef>
 640                 <paramdef>const FcChar8 *<parameter>s</parameter></paramdef>
 641         </funcprototype>
 642         <funcprototype>
 643             <funcdef>FcBool <function>FcPatternAddMatrix</function></funcdef>
 644                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 645                 <paramdef>const char *<parameter>object</parameter></paramdef>
 646                 <paramdef>const FcMatrix *<parameter>m</parameter></paramdef>
 647         </funcprototype>
 648         <funcprototype>
 649             <funcdef>FcBool <function>FcPatternAddCharSet</function></funcdef>
 650                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 651                 <paramdef>const char *<parameter>object</parameter></paramdef>
 652                 <paramdef>const FcCharSet *<parameter>c</parameter></paramdef>
 653         </funcprototype>
 654         <funcprototype>
 655             <funcdef>FcBool <function>FcPatternAddBool</function></funcdef>
 656                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 657                 <paramdef>const char *<parameter>object</parameter></paramdef>
 658                 <paramdef>FcBool <parameter>b</parameter></paramdef>
 659         </funcprototype>
 660         <funcprototype>
 661             <funcdef>FcBool <function>FcPatternAddFTFace</function></funcdef>
 662                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 663                 <paramdef>const char *<parameter>object</parameter></paramdef>
 664                 <paramdef>const FT_Face<parameter>f</parameter></paramdef>
 665         </funcprototype>
 666         <funcprototype>
 667             <funcdef>FcBool <function>FcPatternAddLangSet</function></funcdef>
 668                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 669                 <paramdef>const char *<parameter>object</parameter></paramdef>
 670                 <paramdef>const FcLangSet *<parameter>l</parameter></paramdef>
 671         </funcprototype>
 672         <funcprototype>
 673             <funcdef>FcBool <function>FcPatternAddRange</function></funcdef>
 674                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 675                 <paramdef>const char *<parameter>object</parameter></paramdef>
 676                 <paramdef>const FcRange *<parameter>r</parameter></paramdef>
 677         </funcprototype>
 678         </funcsynopsis>
 679         </refsynopsisdiv>
 680         <refsect1><title>Description</title>
 681             <para>
 682 These are all convenience functions that insert objects of the specified
 683 type into the pattern.  Use these in preference to FcPatternAdd as they
 684 will provide compile-time typechecking.  These all append values to
 685 any existing list of values.
 686
 687 <function>FcPatternAddRange</function> are available since 2.11.91.
 688             </para>
 689         </refsect1>
 690     </refentry>
 691 <!--
 692    fontconfig/doc/func.sgml
 693
 694    Copyright © 2003 Keith Packard
 695
 696    Permission to use, copy, modify, distribute, and sell this software and its
 697    documentation for any purpose is hereby granted without fee, provided that
 698    the above copyright notice appear in all copies and that both that
 699    copyright notice and this permission notice appear in supporting
 700    documentation, and that the name of the author(s) not be used in
 701    advertising or publicity pertaining to distribution of the software without
 702    specific, written prior permission.  The authors make no
 703    representations about the suitability of this software for any purpose.  It
 704    is provided "as is" without express or implied warranty.
 705
 706    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 707    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 708    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 709    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 710    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 711    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 712    PERFORMANCE OF THIS SOFTWARE.
 713  -->
 714     <refentry id="FcPatternGetWithBinding">
 715         <refmeta>
 716             <refentrytitle>FcPatternGetWithBinding</refentrytitle>
 717             <manvolnum>3</manvolnum>
 718             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 719         </refmeta>
 720         <refnamediv>
 721             <refname>FcPatternGetWithBinding</refname>
 722             <refpurpose>Return a value with binding from a pattern</refpurpose>
 723         </refnamediv>
 724         <refsynopsisdiv>
 725         <funcsynopsis>
 726         <funcsynopsisinfo>
 727 #include &lt;fontconfig/fontconfig.h&gt;
 728         </funcsynopsisinfo>
 729         <funcprototype>
 730             <funcdef>FcResult <function>FcPatternGetWithBinding</function></funcdef>
 731                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 732                 <paramdef>const char *<parameter>object</parameter></paramdef>
 733                 <paramdef>int <parameter>id</parameter></paramdef>
 734                 <paramdef>FcValue *<parameter>v</parameter></paramdef>
 735                 <paramdef>FcValueBinding *<parameter>b</parameter></paramdef>
 736         </funcprototype>
 737         </funcsynopsis>
 738         </refsynopsisdiv>
 739         <refsect1><title>Description</title>
 740             <para>
 741 Returns in <parameter>v</parameter> the <parameter>id</parameter>'th value
 742 and <parameter>b</parameter> binding for that associated with the property
 743 <parameter>object</parameter>.
 744 The Value returned is not a copy, but rather refers to the data stored
 745 within the pattern directly.  Applications must not free this value.
 746             </para>
 747         </refsect1>
 748         <refsect1><title>Since</title>
 749             <para>version 2.12.5</para>
 750         </refsect1>
 751     </refentry>
 752 <!--
 753    fontconfig/doc/func.sgml
 754
 755    Copyright © 2003 Keith Packard
 756
 757    Permission to use, copy, modify, distribute, and sell this software and its
 758    documentation for any purpose is hereby granted without fee, provided that
 759    the above copyright notice appear in all copies and that both that
 760    copyright notice and this permission notice appear in supporting
 761    documentation, and that the name of the author(s) not be used in
 762    advertising or publicity pertaining to distribution of the software without
 763    specific, written prior permission.  The authors make no
 764    representations about the suitability of this software for any purpose.  It
 765    is provided "as is" without express or implied warranty.
 766
 767    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 768    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 769    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 770    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 771    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 772    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 773    PERFORMANCE OF THIS SOFTWARE.
 774  -->
 775     <refentry id="FcPatternGet">
 776         <refmeta>
 777             <refentrytitle>FcPatternGet</refentrytitle>
 778             <manvolnum>3</manvolnum>
 779             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 780         </refmeta>
 781         <refnamediv>
 782             <refname>FcPatternGet</refname>
 783             <refpurpose>Return a value from a pattern</refpurpose>
 784         </refnamediv>
 785         <refsynopsisdiv>
 786         <funcsynopsis>
 787         <funcsynopsisinfo>
 788 #include &lt;fontconfig/fontconfig.h&gt;
 789         </funcsynopsisinfo>
 790         <funcprototype>
 791             <funcdef>FcResult <function>FcPatternGet</function></funcdef>
 792                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 793                 <paramdef>const char *<parameter>object</parameter></paramdef>
 794                 <paramdef>int <parameter>id</parameter></paramdef>
 795                 <paramdef>FcValue *<parameter>v</parameter></paramdef>
 796         </funcprototype>
 797         </funcsynopsis>
 798         </refsynopsisdiv>
 799         <refsect1><title>Description</title>
 800             <para>
 801 Returns in <parameter>v</parameter> the <parameter>id</parameter>'th value
 802 associated with the property <parameter>object</parameter>.
 803 The value returned is not a copy, but rather refers to the data stored
 804 within the pattern directly.  Applications must not free this value.
 805             </para>
 806         </refsect1>
 807     </refentry>
 808 <!--
 809    fontconfig/doc/func.sgml
 810
 811    Copyright © 2003 Keith Packard
 812
 813    Permission to use, copy, modify, distribute, and sell this software and its
 814    documentation for any purpose is hereby granted without fee, provided that
 815    the above copyright notice appear in all copies and that both that
 816    copyright notice and this permission notice appear in supporting
 817    documentation, and that the name of the author(s) not be used in
 818    advertising or publicity pertaining to distribution of the software without
 819    specific, written prior permission.  The authors make no
 820    representations about the suitability of this software for any purpose.  It
 821    is provided "as is" without express or implied warranty.
 822
 823    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 824    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 825    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 826    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 827    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 828    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 829    PERFORMANCE OF THIS SOFTWARE.
 830  -->
 831     <refentry id="FcPatternGet-Type">
 832         <refmeta>
 833             <refentrytitle>FcPatternGet-Type</refentrytitle>
 834             <manvolnum>3</manvolnum>
 835             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 836         </refmeta>
 837         <refnamediv>
 838             <refname>FcPatternGetInteger</refname>
 839             <refname>FcPatternGetDouble</refname>
 840             <refname>FcPatternGetString</refname>
 841             <refname>FcPatternGetMatrix</refname>
 842             <refname>FcPatternGetCharSet</refname>
 843             <refname>FcPatternGetBool</refname>
 844             <refname>FcPatternGetFTFace</refname>
 845             <refname>FcPatternGetLangSet</refname>
 846             <refname>FcPatternGetRange</refname>
 847             <refpurpose>Return a typed value from a pattern</refpurpose>
 848         </refnamediv>
 849         <refsynopsisdiv>
 850         <funcsynopsis>
 851         <funcsynopsisinfo>
 852 #include &lt;fontconfig/fontconfig.h&gt;
 853         </funcsynopsisinfo>
 854         <funcprototype>
 855             <funcdef>FcResult <function>FcPatternGetInteger</function></funcdef>
 856                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 857                 <paramdef>const char *<parameter>object</parameter></paramdef>
 858                 <paramdef>int <parameter>n</parameter></paramdef>
 859                 <paramdef>int *<parameter>i</parameter></paramdef>
 860         </funcprototype>
 861         <funcprototype>
 862             <funcdef>FcResult <function>FcPatternGetDouble</function></funcdef>
 863                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 864                 <paramdef>const char *<parameter>object</parameter></paramdef>
 865                 <paramdef>int <parameter>n</parameter></paramdef>
 866                 <paramdef>double *<parameter>d</parameter></paramdef>
 867         </funcprototype>
 868         <funcprototype>
 869             <funcdef>FcResult <function>FcPatternGetString</function></funcdef>
 870                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 871                 <paramdef>const char *<parameter>object</parameter></paramdef>
 872                 <paramdef>int <parameter>n</parameter></paramdef>
 873                 <paramdef>FcChar8 **<parameter>s</parameter></paramdef>
 874         </funcprototype>
 875         <funcprototype>
 876             <funcdef>FcResult <function>FcPatternGetMatrix</function></funcdef>
 877                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 878                 <paramdef>const char *<parameter>object</parameter></paramdef>
 879                 <paramdef>int <parameter>n</parameter></paramdef>
 880                 <paramdef>FcMatrix **<parameter>s</parameter></paramdef>
 881         </funcprototype>
 882         <funcprototype>
 883             <funcdef>FcResult <function>FcPatternGetCharSet</function></funcdef>
 884                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 885                 <paramdef>const char *<parameter>object</parameter></paramdef>
 886                 <paramdef>int <parameter>n</parameter></paramdef>
 887                 <paramdef>FcCharSet **<parameter>c</parameter></paramdef>
 888         </funcprototype>
 889         <funcprototype>
 890             <funcdef>FcResult <function>FcPatternGetBool</function></funcdef>
 891                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 892                 <paramdef>const char *<parameter>object</parameter></paramdef>
 893                 <paramdef>int <parameter>n</parameter></paramdef>
 894                 <paramdef>FcBool *<parameter>b</parameter></paramdef>
 895         </funcprototype>
 896         <funcprototype>
 897             <funcdef>FcResult <function>FcPatternGetFTFace</function></funcdef>
 898                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 899                 <paramdef>const char *<parameter>object</parameter></paramdef>
 900                 <paramdef>int <parameter>n</parameter></paramdef>
 901                 <paramdef>FT_Face *<parameter>f</parameter></paramdef>
 902         </funcprototype>
 903         <funcprototype>
 904             <funcdef>FcResult <function>FcPatternGetLangSet</function></funcdef>
 905                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 906                 <paramdef>const char *<parameter>object</parameter></paramdef>
 907                 <paramdef>int <parameter>n</parameter></paramdef>
 908                 <paramdef>FcLangSet **<parameter>l</parameter></paramdef>
 909         </funcprototype>
 910         <funcprototype>
 911             <funcdef>FcResult <function>FcPatternGetRange</function></funcdef>
 912                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
 913                 <paramdef>const char *<parameter>object</parameter></paramdef>
 914                 <paramdef>int <parameter>n</parameter></paramdef>
 915                 <paramdef>FcRange **<parameter>r</parameter></paramdef>
 916         </funcprototype>
 917         </funcsynopsis>
 918         </refsynopsisdiv>
 919         <refsect1><title>Description</title>
 920             <para>
 921 These are convenience functions that call FcPatternGet and verify that the
 922 returned data is of the expected type. They return FcResultTypeMismatch if
 923 this is not the case.  Note that these (like FcPatternGet) do not make a
 924 copy of any data structure referenced by the return value.  Use these
 925 in preference to FcPatternGet to provide compile-time typechecking.
 926
 927 <function>FcPatternGetRange</function> are available since 2.11.91.
 928             </para>
 929         </refsect1>
 930     </refentry>
 931 <!--
 932    fontconfig/doc/func.sgml
 933
 934    Copyright © 2003 Keith Packard
 935
 936    Permission to use, copy, modify, distribute, and sell this software and its
 937    documentation for any purpose is hereby granted without fee, provided that
 938    the above copyright notice appear in all copies and that both that
 939    copyright notice and this permission notice appear in supporting
 940    documentation, and that the name of the author(s) not be used in
 941    advertising or publicity pertaining to distribution of the software without
 942    specific, written prior permission.  The authors make no
 943    representations about the suitability of this software for any purpose.  It
 944    is provided "as is" without express or implied warranty.
 945
 946    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 947    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 948    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 949    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 950    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 951    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 952    PERFORMANCE OF THIS SOFTWARE.
 953  -->
 954     <refentry id="FcPatternBuild">
 955         <refmeta>
 956             <refentrytitle>FcPatternBuild</refentrytitle>
 957             <manvolnum>3</manvolnum>
 958             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
 959         </refmeta>
 960         <refnamediv>
 961             <refname>FcPatternBuild</refname>
 962             <refname>FcPatternVaBuild</refname>
 963             <refname>FcPatternVapBuild</refname>
 964             <refpurpose>Create patterns from arguments</refpurpose>
 965         </refnamediv>
 966         <refsynopsisdiv>
 967         <funcsynopsis>
 968         <funcsynopsisinfo>
 969 #include &lt;fontconfig/fontconfig.h&gt;
 970         </funcsynopsisinfo>
 971         <funcprototype>
 972             <funcdef>FcPattern * <function>FcPatternBuild</function></funcdef>
 973                 <paramdef>FcPattern *<parameter>pattern</parameter></paramdef>
 974                 <paramdef>...<parameter></parameter></paramdef>
 975         </funcprototype>
 976         <funcprototype>
 977             <funcdef>FcPattern * <function>FcPatternVaBuild</function></funcdef>
 978                 <paramdef>FcPattern *<parameter>pattern</parameter></paramdef>
 979                 <paramdef>va_list <parameter>va</parameter></paramdef>
 980         </funcprototype>
 981         <funcprototype>
 982             <funcdef>void <function>FcPatternVapBuild</function></funcdef>
 983                 <paramdef>FcPattern *<parameter>result</parameter></paramdef>
 984                 <paramdef>FcPattern *<parameter>pattern</parameter></paramdef>
 985                 <paramdef>va_list <parameter>va</parameter></paramdef>
 986         </funcprototype>
 987         </funcsynopsis>
 988         </refsynopsisdiv>
 989         <refsect1><title>Description</title>
 990             <para>
 991 Builds a pattern using a list of objects, types and values.  Each
 992 value to be entered in the pattern is specified with three arguments:
 993 </para>
 994 <orderedlist>
 995 <listitem><para>
 996 Object name, a string describing the property to be added.
 997 </para></listitem><listitem><para>
 998 Object type, one of the FcType enumerated values
 999 </para></listitem><listitem><para>
1000 Value, not an FcValue, but the raw type as passed to any of the
1001 FcPatternAdd&lt;type&gt; functions.  Must match the type of the second
1002 argument.
1003 </para></listitem>
1004 </orderedlist>
1005 <para>
1006 The argument list is terminated by a null object name, no object type nor
1007 value need be passed for this.  The values are added to `pattern', if
1008 `pattern' is null, a new pattern is created.  In either case, the pattern is
1009 returned. Example
1010 </para>
1011 <programlisting>
1012 pattern = FcPatternBuild (0, FC_FAMILY, FcTypeString, "Times", (char *) 0);
1013 </programlisting>
1014 <para>
1015 FcPatternVaBuild is used when the arguments are already in the form of a
1016 varargs value. FcPatternVapBuild is a macro version of FcPatternVaBuild
1017 which returns its result directly in the <parameter>result</parameter>
1018 variable.
1019             </para>
1020         </refsect1>
1021     </refentry>
1022 <!--
1023    fontconfig/doc/func.sgml
1024
1025    Copyright © 2003 Keith Packard
1026
1027    Permission to use, copy, modify, distribute, and sell this software and its
1028    documentation for any purpose is hereby granted without fee, provided that
1029    the above copyright notice appear in all copies and that both that
1030    copyright notice and this permission notice appear in supporting
1031    documentation, and that the name of the author(s) not be used in
1032    advertising or publicity pertaining to distribution of the software without
1033    specific, written prior permission.  The authors make no
1034    representations about the suitability of this software for any purpose.  It
1035    is provided "as is" without express or implied warranty.
1036
1037    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1038    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1039    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1040    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1041    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1042    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1043    PERFORMANCE OF THIS SOFTWARE.
1044  -->
1045     <refentry id="FcPatternDel">
1046         <refmeta>
1047             <refentrytitle>FcPatternDel</refentrytitle>
1048             <manvolnum>3</manvolnum>
1049             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1050         </refmeta>
1051         <refnamediv>
1052             <refname>FcPatternDel</refname>
1053             <refpurpose>Delete a property from a pattern</refpurpose>
1054         </refnamediv>
1055         <refsynopsisdiv>
1056         <funcsynopsis>
1057         <funcsynopsisinfo>
1058 #include &lt;fontconfig/fontconfig.h&gt;
1059         </funcsynopsisinfo>
1060         <funcprototype>
1061             <funcdef>FcBool <function>FcPatternDel</function></funcdef>
1062                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
1063                 <paramdef>const char *<parameter>object</parameter></paramdef>
1064         </funcprototype>
1065         </funcsynopsis>
1066         </refsynopsisdiv>
1067         <refsect1><title>Description</title>
1068             <para>
1069 Deletes all values associated with the property `object', returning
1070 whether the property existed 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="FcPatternRemove">
1098         <refmeta>
1099             <refentrytitle>FcPatternRemove</refentrytitle>
1100             <manvolnum>3</manvolnum>
1101             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1102         </refmeta>
1103         <refnamediv>
1104             <refname>FcPatternRemove</refname>
1105             <refpurpose>Remove one object of the specified type from the pattern</refpurpose>
1106         </refnamediv>
1107         <refsynopsisdiv>
1108         <funcsynopsis>
1109         <funcsynopsisinfo>
1110 #include &lt;fontconfig/fontconfig.h&gt;
1111         </funcsynopsisinfo>
1112         <funcprototype>
1113             <funcdef>FcBool <function>FcPatternRemove</function></funcdef>
1114                 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
1115                 <paramdef>const char *<parameter>object</parameter></paramdef>
1116                 <paramdef>int <parameter>id</parameter></paramdef>
1117         </funcprototype>
1118         </funcsynopsis>
1119         </refsynopsisdiv>
1120         <refsect1><title>Description</title>
1121             <para>
1122 Removes the value associated with the property `object' at position `id', returning
1123 whether the property existed and had a value at that position or not.
1124             </para>
1125         </refsect1>
1126     </refentry>
1127 <!--
1128    fontconfig/doc/func.sgml
1129
1130    Copyright © 2003 Keith Packard
1131
1132    Permission to use, copy, modify, distribute, and sell this software and its
1133    documentation for any purpose is hereby granted without fee, provided that
1134    the above copyright notice appear in all copies and that both that
1135    copyright notice and this permission notice appear in supporting
1136    documentation, and that the name of the author(s) not be used in
1137    advertising or publicity pertaining to distribution of the software without
1138    specific, written prior permission.  The authors make no
1139    representations about the suitability of this software for any purpose.  It
1140    is provided "as is" without express or implied warranty.
1141
1142    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1143    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1144    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1145    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1146    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1147    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1148    PERFORMANCE OF THIS SOFTWARE.
1149  -->
1150     <refentry id="FcPatternIterStart">
1151         <refmeta>
1152             <refentrytitle>FcPatternIterStart</refentrytitle>
1153             <manvolnum>3</manvolnum>
1154             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1155         </refmeta>
1156         <refnamediv>
1157             <refname>FcPatternIterStart</refname>
1158             <refpurpose>Initialize the iterator with the first iterator in the pattern</refpurpose>
1159         </refnamediv>
1160         <refsynopsisdiv>
1161         <funcsynopsis>
1162         <funcsynopsisinfo>
1163 #include &lt;fontconfig/fontconfig.h&gt;
1164         </funcsynopsisinfo>
1165         <funcprototype>
1166             <funcdef>void <function>FcPatternIterStart</function></funcdef>
1167                 <paramdef>const FcPattern *<parameter>p</parameter></paramdef>
1168                 <paramdef>FcPatternIter *<parameter>iter</parameter></paramdef>
1169         </funcprototype>
1170         </funcsynopsis>
1171         </refsynopsisdiv>
1172         <refsect1><title>Description</title>
1173             <para>
1174 Initialize <parameter>iter</parameter> with the first iterator in <parameter>p</parameter>.
1175 If there are no objects in <parameter>p</parameter>, <parameter>iter</parameter>
1176 will not have any valid data.
1177             </para>
1178         </refsect1>
1179         <refsect1><title>Since</title>
1180             <para>version 2.13.1</para>
1181         </refsect1>
1182     </refentry>
1183 <!--
1184    fontconfig/doc/func.sgml
1185
1186    Copyright © 2003 Keith Packard
1187
1188    Permission to use, copy, modify, distribute, and sell this software and its
1189    documentation for any purpose is hereby granted without fee, provided that
1190    the above copyright notice appear in all copies and that both that
1191    copyright notice and this permission notice appear in supporting
1192    documentation, and that the name of the author(s) not be used in
1193    advertising or publicity pertaining to distribution of the software without
1194    specific, written prior permission.  The authors make no
1195    representations about the suitability of this software for any purpose.  It
1196    is provided "as is" without express or implied warranty.
1197
1198    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1199    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1200    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1201    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1202    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1203    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1204    PERFORMANCE OF THIS SOFTWARE.
1205  -->
1206     <refentry id="FcPatternIterNext">
1207         <refmeta>
1208             <refentrytitle>FcPatternIterNext</refentrytitle>
1209             <manvolnum>3</manvolnum>
1210             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1211         </refmeta>
1212         <refnamediv>
1213             <refname>FcPatternIterNext</refname>
1214             <refpurpose></refpurpose>
1215         </refnamediv>
1216         <refsynopsisdiv>
1217         <funcsynopsis>
1218         <funcsynopsisinfo>
1219 #include &lt;fontconfig/fontconfig.h&gt;
1220         </funcsynopsisinfo>
1221         <funcprototype>
1222             <funcdef>FcBool <function>FcPatternIterNext</function></funcdef>
1223                 <paramdef>const FcPattern *<parameter>p</parameter></paramdef>
1224                 <paramdef>FcPatternIter *<parameter>iter</parameter></paramdef>
1225         </funcprototype>
1226         </funcsynopsis>
1227         </refsynopsisdiv>
1228         <refsect1><title>Description</title>
1229             <para>
1230 Set <parameter>iter</parameter> to point to the next object in <parameter>p</parameter>
1231 and returns FcTrue if <parameter>iter</parameter> has been changed to the next object.
1232 returns FcFalse otherwise.
1233             </para>
1234         </refsect1>
1235         <refsect1><title>Since</title>
1236             <para>version 2.13.1</para>
1237         </refsect1>
1238     </refentry>
1239 <!--
1240    fontconfig/doc/func.sgml
1241
1242    Copyright © 2003 Keith Packard
1243
1244    Permission to use, copy, modify, distribute, and sell this software and its
1245    documentation for any purpose is hereby granted without fee, provided that
1246    the above copyright notice appear in all copies and that both that
1247    copyright notice and this permission notice appear in supporting
1248    documentation, and that the name of the author(s) not be used in
1249    advertising or publicity pertaining to distribution of the software without
1250    specific, written prior permission.  The authors make no
1251    representations about the suitability of this software for any purpose.  It
1252    is provided "as is" without express or implied warranty.
1253
1254    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1255    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1256    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1257    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1258    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1259    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1260    PERFORMANCE OF THIS SOFTWARE.
1261  -->
1262     <refentry id="FcPatternIterEqual">
1263         <refmeta>
1264             <refentrytitle>FcPatternIterEqual</refentrytitle>
1265             <manvolnum>3</manvolnum>
1266             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1267         </refmeta>
1268         <refnamediv>
1269             <refname>FcPatternIterEqual</refname>
1270             <refpurpose>Compare iterators</refpurpose>
1271         </refnamediv>
1272         <refsynopsisdiv>
1273         <funcsynopsis>
1274         <funcsynopsisinfo>
1275 #include &lt;fontconfig/fontconfig.h&gt;
1276         </funcsynopsisinfo>
1277         <funcprototype>
1278             <funcdef>FcBool <function>FcPatternIterEqual</function></funcdef>
1279                 <paramdef>const FcPattern *<parameter>p1</parameter></paramdef>
1280                 <paramdef>FcPatternIter *<parameter>i1</parameter></paramdef>
1281                 <paramdef>const FcPattern *<parameter>p2</parameter></paramdef>
1282                 <paramdef>FcPatternIter *<parameter>i2</parameter></paramdef>
1283         </funcprototype>
1284         </funcsynopsis>
1285         </refsynopsisdiv>
1286         <refsect1><title>Description</title>
1287             <para>
1288 Return FcTrue if both <parameter>i1</parameter> and <parameter>i2</parameter>
1289 point to same object and contains same values. return FcFalse otherwise.
1290             </para>
1291         </refsect1>
1292         <refsect1><title>Since</title>
1293             <para>version 2.13.1</para>
1294         </refsect1>
1295     </refentry>
1296 <!--
1297    fontconfig/doc/func.sgml
1298
1299    Copyright © 2003 Keith Packard
1300
1301    Permission to use, copy, modify, distribute, and sell this software and its
1302    documentation for any purpose is hereby granted without fee, provided that
1303    the above copyright notice appear in all copies and that both that
1304    copyright notice and this permission notice appear in supporting
1305    documentation, and that the name of the author(s) not be used in
1306    advertising or publicity pertaining to distribution of the software without
1307    specific, written prior permission.  The authors make no
1308    representations about the suitability of this software for any purpose.  It
1309    is provided "as is" without express or implied warranty.
1310
1311    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1312    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1313    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1314    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1315    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1316    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1317    PERFORMANCE OF THIS SOFTWARE.
1318  -->
1319     <refentry id="FcPatternFindIter">
1320         <refmeta>
1321             <refentrytitle>FcPatternFindIter</refentrytitle>
1322             <manvolnum>3</manvolnum>
1323             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1324         </refmeta>
1325         <refnamediv>
1326             <refname>FcPatternFindIter</refname>
1327             <refpurpose>Set the iterator to point to the object in the pattern</refpurpose>
1328         </refnamediv>
1329         <refsynopsisdiv>
1330         <funcsynopsis>
1331         <funcsynopsisinfo>
1332 #include &lt;fontconfig/fontconfig.h&gt;
1333         </funcsynopsisinfo>
1334         <funcprototype>
1335             <funcdef>FcBool <function>FcPatternFindIter</function></funcdef>
1336                 <paramdef>const FcPattern *<parameter>p</parameter></paramdef>
1337                 <paramdef>FcPatternIter *<parameter>iter</parameter></paramdef>
1338                 <paramdef>const char *<parameter>object</parameter></paramdef>
1339         </funcprototype>
1340         </funcsynopsis>
1341         </refsynopsisdiv>
1342         <refsect1><title>Description</title>
1343             <para>
1344 Set <parameter>iter</parameter> to point to <parameter>object</parameter> in
1345 <parameter>p</parameter> if any and returns FcTrue. returns FcFalse otherwise.
1346             </para>
1347         </refsect1>
1348         <refsect1><title>Since</title>
1349             <para>version 2.13.1</para>
1350         </refsect1>
1351     </refentry>
1352 <!--
1353    fontconfig/doc/func.sgml
1354
1355    Copyright © 2003 Keith Packard
1356
1357    Permission to use, copy, modify, distribute, and sell this software and its
1358    documentation for any purpose is hereby granted without fee, provided that
1359    the above copyright notice appear in all copies and that both that
1360    copyright notice and this permission notice appear in supporting
1361    documentation, and that the name of the author(s) not be used in
1362    advertising or publicity pertaining to distribution of the software without
1363    specific, written prior permission.  The authors make no
1364    representations about the suitability of this software for any purpose.  It
1365    is provided "as is" without express or implied warranty.
1366
1367    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1368    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1369    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1370    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1371    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1372    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1373    PERFORMANCE OF THIS SOFTWARE.
1374  -->
1375     <refentry id="FcPatternIterIsValid">
1376         <refmeta>
1377             <refentrytitle>FcPatternIterIsValid</refentrytitle>
1378             <manvolnum>3</manvolnum>
1379             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1380         </refmeta>
1381         <refnamediv>
1382             <refname>FcPatternIterIsValid</refname>
1383             <refpurpose>Check whether the iterator is valid or not</refpurpose>
1384         </refnamediv>
1385         <refsynopsisdiv>
1386         <funcsynopsis>
1387         <funcsynopsisinfo>
1388 #include &lt;fontconfig/fontconfig.h&gt;
1389         </funcsynopsisinfo>
1390         <funcprototype>
1391             <funcdef>FcBool <function>FcPatternIterIsValid</function></funcdef>
1392                 <paramdef>const FcPattern *<parameter>p</parameter></paramdef>
1393                 <paramdef>FcPatternIter :<parameter>iter</parameter></paramdef>
1394         </funcprototype>
1395         </funcsynopsis>
1396         </refsynopsisdiv>
1397         <refsect1><title>Description</title>
1398             <para>
1399 Returns FcTrue if <parameter>iter</parameter> point to the valid entry
1400 in <parameter>p</parameter>. returns FcFalse otherwise.
1401             </para>
1402         </refsect1>
1403         <refsect1><title>Since</title>
1404             <para>version 2.13.1</para>
1405         </refsect1>
1406     </refentry>
1407 <!--
1408    fontconfig/doc/func.sgml
1409
1410    Copyright © 2003 Keith Packard
1411
1412    Permission to use, copy, modify, distribute, and sell this software and its
1413    documentation for any purpose is hereby granted without fee, provided that
1414    the above copyright notice appear in all copies and that both that
1415    copyright notice and this permission notice appear in supporting
1416    documentation, and that the name of the author(s) not be used in
1417    advertising or publicity pertaining to distribution of the software without
1418    specific, written prior permission.  The authors make no
1419    representations about the suitability of this software for any purpose.  It
1420    is provided "as is" without express or implied warranty.
1421
1422    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1423    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1424    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1425    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1426    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1427    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1428    PERFORMANCE OF THIS SOFTWARE.
1429  -->
1430     <refentry id="FcPatternIterGetObject">
1431         <refmeta>
1432             <refentrytitle>FcPatternIterGetObject</refentrytitle>
1433             <manvolnum>3</manvolnum>
1434             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1435         </refmeta>
1436         <refnamediv>
1437             <refname>FcPatternIterGetObject</refname>
1438             <refpurpose>Returns an object name which the iterator point to</refpurpose>
1439         </refnamediv>
1440         <refsynopsisdiv>
1441         <funcsynopsis>
1442         <funcsynopsisinfo>
1443 #include &lt;fontconfig/fontconfig.h&gt;
1444         </funcsynopsisinfo>
1445         <funcprototype>
1446             <funcdef>const char * <function>FcPatternIterGetObject</function></funcdef>
1447                 <paramdef>const FcPattern *<parameter>p</parameter></paramdef>
1448                 <paramdef>FcPatternIter *<parameter>iter</parameter></paramdef>
1449         </funcprototype>
1450         </funcsynopsis>
1451         </refsynopsisdiv>
1452         <refsect1><title>Description</title>
1453             <para>
1454 Returns an object name in <parameter>p</parameter> which
1455 <parameter>iter</parameter> point to. returns NULL if
1456 <parameter>iter</parameter> isn't valid.
1457             </para>
1458         </refsect1>
1459         <refsect1><title>Since</title>
1460             <para>version 2.13.1</para>
1461         </refsect1>
1462     </refentry>
1463 <!--
1464    fontconfig/doc/func.sgml
1465
1466    Copyright © 2003 Keith Packard
1467
1468    Permission to use, copy, modify, distribute, and sell this software and its
1469    documentation for any purpose is hereby granted without fee, provided that
1470    the above copyright notice appear in all copies and that both that
1471    copyright notice and this permission notice appear in supporting
1472    documentation, and that the name of the author(s) not be used in
1473    advertising or publicity pertaining to distribution of the software without
1474    specific, written prior permission.  The authors make no
1475    representations about the suitability of this software for any purpose.  It
1476    is provided "as is" without express or implied warranty.
1477
1478    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1479    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1480    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1481    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1482    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1483    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1484    PERFORMANCE OF THIS SOFTWARE.
1485  -->
1486     <refentry id="FcPatternIterValueCount">
1487         <refmeta>
1488             <refentrytitle>FcPatternIterValueCount</refentrytitle>
1489             <manvolnum>3</manvolnum>
1490             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1491         </refmeta>
1492         <refnamediv>
1493             <refname>FcPatternIterValueCount</refname>
1494             <refpurpose>Returns the number of the values which the iterator point to</refpurpose>
1495         </refnamediv>
1496         <refsynopsisdiv>
1497         <funcsynopsis>
1498         <funcsynopsisinfo>
1499 #include &lt;fontconfig/fontconfig.h&gt;
1500         </funcsynopsisinfo>
1501         <funcprototype>
1502             <funcdef>int <function>FcPatternIterValueCount</function></funcdef>
1503                 <paramdef>const FcPattern *<parameter>p</parameter></paramdef>
1504                 <paramdef>FcPatternIter *<parameter>iter</parameter></paramdef>
1505         </funcprototype>
1506         </funcsynopsis>
1507         </refsynopsisdiv>
1508         <refsect1><title>Description</title>
1509             <para>
1510 Returns the number of the values in the object which <parameter>iter</parameter>
1511 point to. if <parameter>iter</parameter> isn't valid, returns 0.
1512             </para>
1513         </refsect1>
1514         <refsect1><title>Since</title>
1515             <para>version 2.13.1</para>
1516         </refsect1>
1517     </refentry>
1518 <!--
1519    fontconfig/doc/func.sgml
1520
1521    Copyright © 2003 Keith Packard
1522
1523    Permission to use, copy, modify, distribute, and sell this software and its
1524    documentation for any purpose is hereby granted without fee, provided that
1525    the above copyright notice appear in all copies and that both that
1526    copyright notice and this permission notice appear in supporting
1527    documentation, and that the name of the author(s) not be used in
1528    advertising or publicity pertaining to distribution of the software without
1529    specific, written prior permission.  The authors make no
1530    representations about the suitability of this software for any purpose.  It
1531    is provided "as is" without express or implied warranty.
1532
1533    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1534    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1535    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1536    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1537    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1538    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1539    PERFORMANCE OF THIS SOFTWARE.
1540  -->
1541     <refentry id="FcPatternIterGetValue">
1542         <refmeta>
1543             <refentrytitle>FcPatternIterGetValue</refentrytitle>
1544             <manvolnum>3</manvolnum>
1545             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1546         </refmeta>
1547         <refnamediv>
1548             <refname>FcPatternIterGetValue</refname>
1549             <refpurpose>Returns a value which the iterator point to</refpurpose>
1550         </refnamediv>
1551         <refsynopsisdiv>
1552         <funcsynopsis>
1553         <funcsynopsisinfo>
1554 #include &lt;fontconfig/fontconfig.h&gt;
1555         </funcsynopsisinfo>
1556         <funcprototype>
1557             <funcdef>FcResult <function>FcPatternIterGetValue</function></funcdef>
1558                 <paramdef>const FcPattern *<parameter>p</parameter></paramdef>
1559                 <paramdef>FcPatternIter *<parameter>iter</parameter></paramdef>
1560                 <paramdef>int<parameter>id</parameter></paramdef>
1561                 <paramdef>FcValue *<parameter>v</parameter></paramdef>
1562                 <paramdef>FcValueBinding *<parameter>b</parameter></paramdef>
1563         </funcprototype>
1564         </funcsynopsis>
1565         </refsynopsisdiv>
1566         <refsect1><title>Description</title>
1567             <para>
1568 Returns in <parameter>v</parameter> the <parameter>id</parameter>'th value
1569 which <parameter>iter</parameter> point to. also binding to <parameter>b</parameter>
1570 if given.
1571 The value returned is not a copy, but rather refers to the data stored
1572 within the pattern directly.  Applications must not free this value.
1573             </para>
1574         </refsect1>
1575         <refsect1><title>Since</title>
1576             <para>version 2.13.1</para>
1577         </refsect1>
1578     </refentry>
1579 <!--
1580    fontconfig/doc/func.sgml
1581
1582    Copyright © 2003 Keith Packard
1583
1584    Permission to use, copy, modify, distribute, and sell this software and its
1585    documentation for any purpose is hereby granted without fee, provided that
1586    the above copyright notice appear in all copies and that both that
1587    copyright notice and this permission notice appear in supporting
1588    documentation, and that the name of the author(s) not be used in
1589    advertising or publicity pertaining to distribution of the software without
1590    specific, written prior permission.  The authors make no
1591    representations about the suitability of this software for any purpose.  It
1592    is provided "as is" without express or implied warranty.
1593
1594    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1595    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1596    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1597    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1598    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1599    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1600    PERFORMANCE OF THIS SOFTWARE.
1601  -->
1602     <refentry id="FcPatternPrint">
1603         <refmeta>
1604             <refentrytitle>FcPatternPrint</refentrytitle>
1605             <manvolnum>3</manvolnum>
1606             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1607         </refmeta>
1608         <refnamediv>
1609             <refname>FcPatternPrint</refname>
1610             <refpurpose>Print a pattern for debugging</refpurpose>
1611         </refnamediv>
1612         <refsynopsisdiv>
1613         <funcsynopsis>
1614         <funcsynopsisinfo>
1615 #include &lt;fontconfig/fontconfig.h&gt;
1616         </funcsynopsisinfo>
1617         <funcprototype>
1618             <funcdef>void <function>FcPatternPrint</function></funcdef>
1619                 <paramdef>const FcPattern *<parameter>p</parameter></paramdef>
1620         </funcprototype>
1621         </funcsynopsis>
1622         </refsynopsisdiv>
1623         <refsect1><title>Description</title>
1624             <para>
1625 Prints an easily readable version of the pattern to stdout.  There is
1626 no provision for reparsing data in this format, it's just for diagnostics
1627 and debugging.
1628             </para>
1629         </refsect1>
1630     </refentry>
1631 <!--
1632    fontconfig/doc/func.sgml
1633
1634    Copyright © 2003 Keith Packard
1635
1636    Permission to use, copy, modify, distribute, and sell this software and its
1637    documentation for any purpose is hereby granted without fee, provided that
1638    the above copyright notice appear in all copies and that both that
1639    copyright notice and this permission notice appear in supporting
1640    documentation, and that the name of the author(s) not be used in
1641    advertising or publicity pertaining to distribution of the software without
1642    specific, written prior permission.  The authors make no
1643    representations about the suitability of this software for any purpose.  It
1644    is provided "as is" without express or implied warranty.
1645
1646    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1647    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1648    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1649    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1650    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1651    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1652    PERFORMANCE OF THIS SOFTWARE.
1653  -->
1654     <refentry id="FcDefaultSubstitute">
1655         <refmeta>
1656             <refentrytitle>FcDefaultSubstitute</refentrytitle>
1657             <manvolnum>3</manvolnum>
1658             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1659         </refmeta>
1660         <refnamediv>
1661             <refname>FcDefaultSubstitute</refname>
1662             <refpurpose>Perform default substitutions in a pattern</refpurpose>
1663         </refnamediv>
1664         <refsynopsisdiv>
1665         <funcsynopsis>
1666         <funcsynopsisinfo>
1667 #include &lt;fontconfig/fontconfig.h&gt;
1668         </funcsynopsisinfo>
1669         <funcprototype>
1670             <funcdef>void <function>FcDefaultSubstitute</function></funcdef>
1671                 <paramdef>FcPattern *<parameter>pattern</parameter></paramdef>
1672         </funcprototype>
1673         </funcsynopsis>
1674         </refsynopsisdiv>
1675         <refsect1><title>Description</title>
1676             <para>
1677 Supplies default values for underspecified font patterns:
1678 <itemizedlist>
1679 <listitem><para>
1680 Patterns without a specified style or weight are set to Medium
1681 </para></listitem>
1682 <listitem><para>
1683 Patterns without a specified style or slant are set to Roman
1684 </para></listitem>
1685 <listitem><para>
1686 Patterns without a specified pixel size are given one computed from any
1687 specified point size (default 12), dpi (default 75) and scale (default 1).
1688 </para></listitem>
1689 </itemizedlist>
1690             </para>
1691         </refsect1>
1692     </refentry>
1693 <!--
1694    fontconfig/doc/func.sgml
1695
1696    Copyright © 2003 Keith Packard
1697
1698    Permission to use, copy, modify, distribute, and sell this software and its
1699    documentation for any purpose is hereby granted without fee, provided that
1700    the above copyright notice appear in all copies and that both that
1701    copyright notice and this permission notice appear in supporting
1702    documentation, and that the name of the author(s) not be used in
1703    advertising or publicity pertaining to distribution of the software without
1704    specific, written prior permission.  The authors make no
1705    representations about the suitability of this software for any purpose.  It
1706    is provided "as is" without express or implied warranty.
1707
1708    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1709    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1710    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1711    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1712    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1713    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1714    PERFORMANCE OF THIS SOFTWARE.
1715  -->
1716     <refentry id="FcNameParse">
1717         <refmeta>
1718             <refentrytitle>FcNameParse</refentrytitle>
1719             <manvolnum>3</manvolnum>
1720             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1721         </refmeta>
1722         <refnamediv>
1723             <refname>FcNameParse</refname>
1724             <refpurpose>Parse a pattern string</refpurpose>
1725         </refnamediv>
1726         <refsynopsisdiv>
1727         <funcsynopsis>
1728         <funcsynopsisinfo>
1729 #include &lt;fontconfig/fontconfig.h&gt;
1730         </funcsynopsisinfo>
1731         <funcprototype>
1732             <funcdef>FcPattern * <function>FcNameParse</function></funcdef>
1733                 <paramdef>const FcChar8 *<parameter>name</parameter></paramdef>
1734         </funcprototype>
1735         </funcsynopsis>
1736         </refsynopsisdiv>
1737         <refsect1><title>Description</title>
1738             <para>
1739 Converts <parameter>name</parameter> from the standard text format described above into a pattern.
1740             </para>
1741         </refsect1>
1742     </refentry>
1743 <!--
1744    fontconfig/doc/func.sgml
1745
1746    Copyright © 2003 Keith Packard
1747
1748    Permission to use, copy, modify, distribute, and sell this software and its
1749    documentation for any purpose is hereby granted without fee, provided that
1750    the above copyright notice appear in all copies and that both that
1751    copyright notice and this permission notice appear in supporting
1752    documentation, and that the name of the author(s) not be used in
1753    advertising or publicity pertaining to distribution of the software without
1754    specific, written prior permission.  The authors make no
1755    representations about the suitability of this software for any purpose.  It
1756    is provided "as is" without express or implied warranty.
1757
1758    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1759    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1760    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1761    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1762    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1763    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1764    PERFORMANCE OF THIS SOFTWARE.
1765  -->
1766     <refentry id="FcNameUnparse">
1767         <refmeta>
1768             <refentrytitle>FcNameUnparse</refentrytitle>
1769             <manvolnum>3</manvolnum>
1770             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1771         </refmeta>
1772         <refnamediv>
1773             <refname>FcNameUnparse</refname>
1774             <refpurpose>Convert a pattern back into a string that can be parsed</refpurpose>
1775         </refnamediv>
1776         <refsynopsisdiv>
1777         <funcsynopsis>
1778         <funcsynopsisinfo>
1779 #include &lt;fontconfig/fontconfig.h&gt;
1780         </funcsynopsisinfo>
1781         <funcprototype>
1782             <funcdef>FcChar8 * <function>FcNameUnparse</function></funcdef>
1783                 <paramdef>FcPattern *<parameter>pat</parameter></paramdef>
1784         </funcprototype>
1785         </funcsynopsis>
1786         </refsynopsisdiv>
1787         <refsect1><title>Description</title>
1788             <para>
1789 Converts the given pattern into the standard text format described above.
1790 The return value is not static, but instead refers to newly allocated memory
1791 which should be freed by the caller using free().
1792             </para>
1793         </refsect1>
1794     </refentry>