2 fontconfig/doc/func.sgml
4 Copyright © 2003 Keith Packard
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.
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.
24 <refentry id="FcConfigCreate">
26 <refentrytitle>FcConfigCreate</refentrytitle>
27 <manvolnum>3</manvolnum>
28 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
31 <refname>FcConfigCreate</refname>
32 <refpurpose>Create a configuration</refpurpose>
37 #include <fontconfig/fontconfig.h>
40 <funcdef>FcConfig * <function>FcConfigCreate</function></funcdef>
41 <paramdef>void<parameter></parameter></paramdef>
45 <refsect1><title>Description</title>
47 Creates an empty configuration.
52 fontconfig/doc/func.sgml
54 Copyright © 2003 Keith Packard
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.
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.
74 <refentry id="FcConfigReference">
76 <refentrytitle>FcConfigReference</refentrytitle>
77 <manvolnum>3</manvolnum>
78 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
81 <refname>FcConfigReference</refname>
82 <refpurpose>Increment config reference count</refpurpose>
87 #include <fontconfig/fontconfig.h>
90 <funcdef>FcConfig * <function>FcConfigReference</function></funcdef>
91 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
95 <refsect1><title>Description</title>
97 Add another reference to <parameter>config</parameter>. Configs are freed only
98 when the reference count reaches zero.
99 If <parameter>config</parameter> is NULL, the current configuration is used.
100 In that case this function will be similar to FcConfigGetCurrent() except that
101 it increments the reference count before returning and the user is responsible
102 for destroying the configuration when not needed anymore.
107 fontconfig/doc/func.sgml
109 Copyright © 2003 Keith Packard
111 Permission to use, copy, modify, distribute, and sell this software and its
112 documentation for any purpose is hereby granted without fee, provided that
113 the above copyright notice appear in all copies and that both that
114 copyright notice and this permission notice appear in supporting
115 documentation, and that the name of the author(s) not be used in
116 advertising or publicity pertaining to distribution of the software without
117 specific, written prior permission. The authors make no
118 representations about the suitability of this software for any purpose. It
119 is provided "as is" without express or implied warranty.
121 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
122 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
123 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
124 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
125 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
126 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
127 PERFORMANCE OF THIS SOFTWARE.
129 <refentry id="FcConfigDestroy">
131 <refentrytitle>FcConfigDestroy</refentrytitle>
132 <manvolnum>3</manvolnum>
133 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
136 <refname>FcConfigDestroy</refname>
137 <refpurpose>Destroy a configuration</refpurpose>
142 #include <fontconfig/fontconfig.h>
145 <funcdef>void <function>FcConfigDestroy</function></funcdef>
146 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
150 <refsect1><title>Description</title>
152 Decrements the config reference count. If all references are gone, destroys
153 the configuration and any data associated with it.
154 Note that calling this function with the return from FcConfigGetCurrent will
155 cause a new configuration to be created for use as current configuration.
160 fontconfig/doc/func.sgml
162 Copyright © 2003 Keith Packard
164 Permission to use, copy, modify, distribute, and sell this software and its
165 documentation for any purpose is hereby granted without fee, provided that
166 the above copyright notice appear in all copies and that both that
167 copyright notice and this permission notice appear in supporting
168 documentation, and that the name of the author(s) not be used in
169 advertising or publicity pertaining to distribution of the software without
170 specific, written prior permission. The authors make no
171 representations about the suitability of this software for any purpose. It
172 is provided "as is" without express or implied warranty.
174 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
175 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
176 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
177 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
178 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
179 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
180 PERFORMANCE OF THIS SOFTWARE.
182 <refentry id="FcConfigSetCurrent">
184 <refentrytitle>FcConfigSetCurrent</refentrytitle>
185 <manvolnum>3</manvolnum>
186 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
189 <refname>FcConfigSetCurrent</refname>
190 <refpurpose>Set configuration as default</refpurpose>
195 #include <fontconfig/fontconfig.h>
198 <funcdef>FcBool <function>FcConfigSetCurrent</function></funcdef>
199 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
203 <refsect1><title>Description</title>
205 Sets the current default configuration to <parameter>config</parameter>. Implicitly calls
206 FcConfigBuildFonts if necessary, and FcConfigReference() to inrease the reference count
207 in <parameter>config</parameter> since 2.12.0, returning FcFalse if that call fails.
212 fontconfig/doc/func.sgml
214 Copyright © 2003 Keith Packard
216 Permission to use, copy, modify, distribute, and sell this software and its
217 documentation for any purpose is hereby granted without fee, provided that
218 the above copyright notice appear in all copies and that both that
219 copyright notice and this permission notice appear in supporting
220 documentation, and that the name of the author(s) not be used in
221 advertising or publicity pertaining to distribution of the software without
222 specific, written prior permission. The authors make no
223 representations about the suitability of this software for any purpose. It
224 is provided "as is" without express or implied warranty.
226 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
227 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
228 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
229 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
230 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
231 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
232 PERFORMANCE OF THIS SOFTWARE.
234 <refentry id="FcConfigGetCurrent">
236 <refentrytitle>FcConfigGetCurrent</refentrytitle>
237 <manvolnum>3</manvolnum>
238 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
241 <refname>FcConfigGetCurrent</refname>
242 <refpurpose>Return current configuration</refpurpose>
247 #include <fontconfig/fontconfig.h>
250 <funcdef>FcConfig * <function>FcConfigGetCurrent</function></funcdef>
251 <paramdef>void<parameter></parameter></paramdef>
255 <refsect1><title>Description</title>
257 Returns the current default configuration.
262 fontconfig/doc/func.sgml
264 Copyright © 2003 Keith Packard
266 Permission to use, copy, modify, distribute, and sell this software and its
267 documentation for any purpose is hereby granted without fee, provided that
268 the above copyright notice appear in all copies and that both that
269 copyright notice and this permission notice appear in supporting
270 documentation, and that the name of the author(s) not be used in
271 advertising or publicity pertaining to distribution of the software without
272 specific, written prior permission. The authors make no
273 representations about the suitability of this software for any purpose. It
274 is provided "as is" without express or implied warranty.
276 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
277 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
278 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
279 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
280 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
281 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
282 PERFORMANCE OF THIS SOFTWARE.
284 <refentry id="FcConfigUptoDate">
286 <refentrytitle>FcConfigUptoDate</refentrytitle>
287 <manvolnum>3</manvolnum>
288 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
291 <refname>FcConfigUptoDate</refname>
292 <refpurpose>Check timestamps on config files</refpurpose>
297 #include <fontconfig/fontconfig.h>
300 <funcdef>FcBool <function>FcConfigUptoDate</function></funcdef>
301 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
305 <refsect1><title>Description</title>
307 Checks all of the files related to <parameter>config</parameter> and returns
308 whether any of them has been modified since the configuration was created.
309 If <parameter>config</parameter> is NULL, the current configuration is used.
314 fontconfig/doc/func.sgml
316 Copyright © 2003 Keith Packard
318 Permission to use, copy, modify, distribute, and sell this software and its
319 documentation for any purpose is hereby granted without fee, provided that
320 the above copyright notice appear in all copies and that both that
321 copyright notice and this permission notice appear in supporting
322 documentation, and that the name of the author(s) not be used in
323 advertising or publicity pertaining to distribution of the software without
324 specific, written prior permission. The authors make no
325 representations about the suitability of this software for any purpose. It
326 is provided "as is" without express or implied warranty.
328 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
329 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
330 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
331 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
332 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
333 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
334 PERFORMANCE OF THIS SOFTWARE.
336 <refentry id="FcConfigHome">
338 <refentrytitle>FcConfigHome</refentrytitle>
339 <manvolnum>3</manvolnum>
340 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
343 <refname>FcConfigHome</refname>
344 <refpurpose>return the current home directory.</refpurpose>
349 #include <fontconfig/fontconfig.h>
352 <funcdef>FcChar8 * <function>FcConfigHome</function></funcdef>
353 <paramdef>void<parameter></parameter></paramdef>
357 <refsect1><title>Description</title>
359 Return the current user's home directory, if it is available, and if using it
360 is enabled, and NULL otherwise.
361 See also <function>FcConfigEnableHome</function>).
366 fontconfig/doc/func.sgml
368 Copyright © 2003 Keith Packard
370 Permission to use, copy, modify, distribute, and sell this software and its
371 documentation for any purpose is hereby granted without fee, provided that
372 the above copyright notice appear in all copies and that both that
373 copyright notice and this permission notice appear in supporting
374 documentation, and that the name of the author(s) not be used in
375 advertising or publicity pertaining to distribution of the software without
376 specific, written prior permission. The authors make no
377 representations about the suitability of this software for any purpose. It
378 is provided "as is" without express or implied warranty.
380 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
381 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
382 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
383 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
384 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
385 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
386 PERFORMANCE OF THIS SOFTWARE.
388 <refentry id="FcConfigEnableHome">
390 <refentrytitle>FcConfigEnableHome</refentrytitle>
391 <manvolnum>3</manvolnum>
392 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
395 <refname>FcConfigEnableHome</refname>
396 <refpurpose>controls use of the home directory.</refpurpose>
401 #include <fontconfig/fontconfig.h>
404 <funcdef>FcBool <function>FcConfigEnableHome</function></funcdef>
405 <paramdef>FcBool <parameter>enable</parameter></paramdef>
409 <refsect1><title>Description</title>
411 If <parameter>enable</parameter> is FcTrue, then Fontconfig will use various
412 files which are specified relative to the user's home directory (using the ~
413 notation in the configuration). When <parameter>enable</parameter> is
414 FcFalse, then all use of the home directory in these contexts will be
415 disabled. The previous setting of the value is returned.
420 fontconfig/doc/func.sgml
422 Copyright © 2003 Keith Packard
424 Permission to use, copy, modify, distribute, and sell this software and its
425 documentation for any purpose is hereby granted without fee, provided that
426 the above copyright notice appear in all copies and that both that
427 copyright notice and this permission notice appear in supporting
428 documentation, and that the name of the author(s) not be used in
429 advertising or publicity pertaining to distribution of the software without
430 specific, written prior permission. The authors make no
431 representations about the suitability of this software for any purpose. It
432 is provided "as is" without express or implied warranty.
434 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
435 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
436 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
437 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
438 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
439 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
440 PERFORMANCE OF THIS SOFTWARE.
442 <refentry id="FcConfigBuildFonts">
444 <refentrytitle>FcConfigBuildFonts</refentrytitle>
445 <manvolnum>3</manvolnum>
446 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
449 <refname>FcConfigBuildFonts</refname>
450 <refpurpose>Build font database</refpurpose>
455 #include <fontconfig/fontconfig.h>
458 <funcdef>FcBool <function>FcConfigBuildFonts</function></funcdef>
459 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
463 <refsect1><title>Description</title>
465 Builds the set of available fonts for the given configuration. Note that
466 any changes to the configuration after this call have indeterminate effects.
467 Returns FcFalse if this operation runs out of memory.
468 If <parameter>config</parameter> is NULL, the current configuration is used.
473 fontconfig/doc/func.sgml
475 Copyright © 2003 Keith Packard
477 Permission to use, copy, modify, distribute, and sell this software and its
478 documentation for any purpose is hereby granted without fee, provided that
479 the above copyright notice appear in all copies and that both that
480 copyright notice and this permission notice appear in supporting
481 documentation, and that the name of the author(s) not be used in
482 advertising or publicity pertaining to distribution of the software without
483 specific, written prior permission. The authors make no
484 representations about the suitability of this software for any purpose. It
485 is provided "as is" without express or implied warranty.
487 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
488 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
489 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
490 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
491 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
492 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
493 PERFORMANCE OF THIS SOFTWARE.
495 <refentry id="FcConfigGetConfigDirs">
497 <refentrytitle>FcConfigGetConfigDirs</refentrytitle>
498 <manvolnum>3</manvolnum>
499 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
502 <refname>FcConfigGetConfigDirs</refname>
503 <refpurpose>Get config directories</refpurpose>
508 #include <fontconfig/fontconfig.h>
511 <funcdef>FcStrList * <function>FcConfigGetConfigDirs</function></funcdef>
512 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
516 <refsect1><title>Description</title>
518 Returns the list of font directories specified in the configuration files
519 for <parameter>config</parameter>. Does not include any subdirectories.
520 If <parameter>config</parameter> is NULL, the current configuration is used.
525 fontconfig/doc/func.sgml
527 Copyright © 2003 Keith Packard
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.
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.
547 <refentry id="FcConfigGetFontDirs">
549 <refentrytitle>FcConfigGetFontDirs</refentrytitle>
550 <manvolnum>3</manvolnum>
551 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
554 <refname>FcConfigGetFontDirs</refname>
555 <refpurpose>Get font directories</refpurpose>
560 #include <fontconfig/fontconfig.h>
563 <funcdef>FcStrList * <function>FcConfigGetFontDirs</function></funcdef>
564 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
568 <refsect1><title>Description</title>
570 Returns the list of font directories in <parameter>config</parameter>. This includes the
571 configured font directories along with any directories below those in the
573 If <parameter>config</parameter> is NULL, the current configuration is used.
578 fontconfig/doc/func.sgml
580 Copyright © 2003 Keith Packard
582 Permission to use, copy, modify, distribute, and sell this software and its
583 documentation for any purpose is hereby granted without fee, provided that
584 the above copyright notice appear in all copies and that both that
585 copyright notice and this permission notice appear in supporting
586 documentation, and that the name of the author(s) not be used in
587 advertising or publicity pertaining to distribution of the software without
588 specific, written prior permission. The authors make no
589 representations about the suitability of this software for any purpose. It
590 is provided "as is" without express or implied warranty.
592 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
593 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
594 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
595 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
596 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
597 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
598 PERFORMANCE OF THIS SOFTWARE.
600 <refentry id="FcConfigGetConfigFiles">
602 <refentrytitle>FcConfigGetConfigFiles</refentrytitle>
603 <manvolnum>3</manvolnum>
604 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
607 <refname>FcConfigGetConfigFiles</refname>
608 <refpurpose>Get config files</refpurpose>
613 #include <fontconfig/fontconfig.h>
616 <funcdef>FcStrList * <function>FcConfigGetConfigFiles</function></funcdef>
617 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
621 <refsect1><title>Description</title>
623 Returns the list of known configuration files used to generate <parameter>config</parameter>.
624 If <parameter>config</parameter> is NULL, the current configuration is used.
629 fontconfig/doc/func.sgml
631 Copyright © 2003 Keith Packard
633 Permission to use, copy, modify, distribute, and sell this software and its
634 documentation for any purpose is hereby granted without fee, provided that
635 the above copyright notice appear in all copies and that both that
636 copyright notice and this permission notice appear in supporting
637 documentation, and that the name of the author(s) not be used in
638 advertising or publicity pertaining to distribution of the software without
639 specific, written prior permission. The authors make no
640 representations about the suitability of this software for any purpose. It
641 is provided "as is" without express or implied warranty.
643 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
644 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
645 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
646 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
647 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
648 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
649 PERFORMANCE OF THIS SOFTWARE.
651 <refentry id="FcConfigGetCache">
653 <refentrytitle>FcConfigGetCache</refentrytitle>
654 <manvolnum>3</manvolnum>
655 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
658 <refname>FcConfigGetCache</refname>
659 <refpurpose>DEPRECATED used to return per-user cache filename</refpurpose>
664 #include <fontconfig/fontconfig.h>
667 <funcdef>FcChar8 * <function>FcConfigGetCache</function></funcdef>
668 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
672 <refsect1><title>Description</title>
674 With fontconfig no longer using per-user cache files, this function now
675 simply returns NULL to indicate that no per-user file exists.
680 fontconfig/doc/func.sgml
682 Copyright © 2003 Keith Packard
684 Permission to use, copy, modify, distribute, and sell this software and its
685 documentation for any purpose is hereby granted without fee, provided that
686 the above copyright notice appear in all copies and that both that
687 copyright notice and this permission notice appear in supporting
688 documentation, and that the name of the author(s) not be used in
689 advertising or publicity pertaining to distribution of the software without
690 specific, written prior permission. The authors make no
691 representations about the suitability of this software for any purpose. It
692 is provided "as is" without express or implied warranty.
694 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
695 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
696 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
697 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
698 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
699 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
700 PERFORMANCE OF THIS SOFTWARE.
702 <refentry id="FcConfigGetCacheDirs">
704 <refentrytitle>FcConfigGetCacheDirs</refentrytitle>
705 <manvolnum>3</manvolnum>
706 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
709 <refname>FcConfigGetCacheDirs</refname>
710 <refpurpose>return the list of directories searched for cache files</refpurpose>
715 #include <fontconfig/fontconfig.h>
718 <funcdef>FcStrList * <function>FcConfigGetCacheDirs</function></funcdef>
719 <paramdef>const FcConfig *<parameter>config</parameter></paramdef>
723 <refsect1><title>Description</title>
725 <function>FcConfigGetCacheDirs</function> returns a string list containing
726 all of the directories that fontconfig will search when attempting to load a
727 cache file for a font directory.
728 If <parameter>config</parameter> is NULL, the current configuration is used.
733 fontconfig/doc/func.sgml
735 Copyright © 2003 Keith Packard
737 Permission to use, copy, modify, distribute, and sell this software and its
738 documentation for any purpose is hereby granted without fee, provided that
739 the above copyright notice appear in all copies and that both that
740 copyright notice and this permission notice appear in supporting
741 documentation, and that the name of the author(s) not be used in
742 advertising or publicity pertaining to distribution of the software without
743 specific, written prior permission. The authors make no
744 representations about the suitability of this software for any purpose. It
745 is provided "as is" without express or implied warranty.
747 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
748 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
749 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
750 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
751 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
752 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
753 PERFORMANCE OF THIS SOFTWARE.
755 <refentry id="FcConfigGetFonts">
757 <refentrytitle>FcConfigGetFonts</refentrytitle>
758 <manvolnum>3</manvolnum>
759 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
762 <refname>FcConfigGetFonts</refname>
763 <refpurpose>Get config font set</refpurpose>
768 #include <fontconfig/fontconfig.h>
771 <funcdef>FcFontSet * <function>FcConfigGetFonts</function></funcdef>
772 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
773 <paramdef>FcSetName <parameter>set</parameter></paramdef>
777 <refsect1><title>Description</title>
779 Returns one of the two sets of fonts from the configuration as specified
780 by <parameter>set</parameter>. This font set is owned by the library and must
781 not be modified or freed.
782 If <parameter>config</parameter> is NULL, the current configuration is used.
787 fontconfig/doc/func.sgml
789 Copyright © 2003 Keith Packard
791 Permission to use, copy, modify, distribute, and sell this software and its
792 documentation for any purpose is hereby granted without fee, provided that
793 the above copyright notice appear in all copies and that both that
794 copyright notice and this permission notice appear in supporting
795 documentation, and that the name of the author(s) not be used in
796 advertising or publicity pertaining to distribution of the software without
797 specific, written prior permission. The authors make no
798 representations about the suitability of this software for any purpose. It
799 is provided "as is" without express or implied warranty.
801 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
802 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
803 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
804 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
805 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
806 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
807 PERFORMANCE OF THIS SOFTWARE.
809 <refentry id="FcConfigGetBlanks">
811 <refentrytitle>FcConfigGetBlanks</refentrytitle>
812 <manvolnum>3</manvolnum>
813 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
816 <refname>FcConfigGetBlanks</refname>
817 <refpurpose>Get config blanks</refpurpose>
822 #include <fontconfig/fontconfig.h>
825 <funcdef>FcBlanks * <function>FcConfigGetBlanks</function></funcdef>
826 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
830 <refsect1><title>Description</title>
832 FcBlanks is deprecated.
833 This function always returns NULL.
838 fontconfig/doc/func.sgml
840 Copyright © 2003 Keith Packard
842 Permission to use, copy, modify, distribute, and sell this software and its
843 documentation for any purpose is hereby granted without fee, provided that
844 the above copyright notice appear in all copies and that both that
845 copyright notice and this permission notice appear in supporting
846 documentation, and that the name of the author(s) not be used in
847 advertising or publicity pertaining to distribution of the software without
848 specific, written prior permission. The authors make no
849 representations about the suitability of this software for any purpose. It
850 is provided "as is" without express or implied warranty.
852 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
853 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
854 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
855 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
856 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
857 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
858 PERFORMANCE OF THIS SOFTWARE.
860 <refentry id="FcConfigGetRescanInterval">
862 <refentrytitle>FcConfigGetRescanInterval</refentrytitle>
863 <manvolnum>3</manvolnum>
864 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
867 <refname>FcConfigGetRescanInterval</refname>
868 <refpurpose>Get config rescan interval</refpurpose>
873 #include <fontconfig/fontconfig.h>
876 <funcdef>int <function>FcConfigGetRescanInterval</function></funcdef>
877 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
881 <refsect1><title>Description</title>
883 Returns the interval between automatic checks of the configuration (in
884 seconds) specified in <parameter>config</parameter>. The configuration is checked during
885 a call to FcFontList when this interval has passed since the last check.
886 An interval setting of zero disables automatic checks.
887 If <parameter>config</parameter> is NULL, the current configuration is used.
892 fontconfig/doc/func.sgml
894 Copyright © 2003 Keith Packard
896 Permission to use, copy, modify, distribute, and sell this software and its
897 documentation for any purpose is hereby granted without fee, provided that
898 the above copyright notice appear in all copies and that both that
899 copyright notice and this permission notice appear in supporting
900 documentation, and that the name of the author(s) not be used in
901 advertising or publicity pertaining to distribution of the software without
902 specific, written prior permission. The authors make no
903 representations about the suitability of this software for any purpose. It
904 is provided "as is" without express or implied warranty.
906 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
907 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
908 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
909 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
910 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
911 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
912 PERFORMANCE OF THIS SOFTWARE.
914 <refentry id="FcConfigSetRescanInterval">
916 <refentrytitle>FcConfigSetRescanInterval</refentrytitle>
917 <manvolnum>3</manvolnum>
918 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
921 <refname>FcConfigSetRescanInterval</refname>
922 <refpurpose>Set config rescan interval</refpurpose>
927 #include <fontconfig/fontconfig.h>
930 <funcdef>FcBool <function>FcConfigSetRescanInterval</function></funcdef>
931 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
932 <paramdef>int <parameter>rescanInterval</parameter></paramdef>
936 <refsect1><title>Description</title>
938 Sets the rescan interval. Returns FcFalse if the interval cannot be set (due
939 to allocation failure). Otherwise returns FcTrue.
940 An interval setting of zero disables automatic checks.
941 If <parameter>config</parameter> is NULL, the current configuration is used.
946 fontconfig/doc/func.sgml
948 Copyright © 2003 Keith Packard
950 Permission to use, copy, modify, distribute, and sell this software and its
951 documentation for any purpose is hereby granted without fee, provided that
952 the above copyright notice appear in all copies and that both that
953 copyright notice and this permission notice appear in supporting
954 documentation, and that the name of the author(s) not be used in
955 advertising or publicity pertaining to distribution of the software without
956 specific, written prior permission. The authors make no
957 representations about the suitability of this software for any purpose. It
958 is provided "as is" without express or implied warranty.
960 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
961 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
962 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
963 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
964 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
965 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
966 PERFORMANCE OF THIS SOFTWARE.
968 <refentry id="FcConfigAppFontAddFile">
970 <refentrytitle>FcConfigAppFontAddFile</refentrytitle>
971 <manvolnum>3</manvolnum>
972 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
975 <refname>FcConfigAppFontAddFile</refname>
976 <refpurpose>Add font file to font database</refpurpose>
981 #include <fontconfig/fontconfig.h>
984 <funcdef>FcBool <function>FcConfigAppFontAddFile</function></funcdef>
985 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
986 <paramdef>const FcChar8 *<parameter>file</parameter></paramdef>
990 <refsect1><title>Description</title>
992 Adds an application-specific font to the configuration. Returns FcFalse
993 if the fonts cannot be added (due to allocation failure or no fonts found).
994 Otherwise returns FcTrue. If <parameter>config</parameter> is NULL,
995 the current configuration is used.
1000 fontconfig/doc/func.sgml
1002 Copyright © 2003 Keith Packard
1004 Permission to use, copy, modify, distribute, and sell this software and its
1005 documentation for any purpose is hereby granted without fee, provided that
1006 the above copyright notice appear in all copies and that both that
1007 copyright notice and this permission notice appear in supporting
1008 documentation, and that the name of the author(s) not be used in
1009 advertising or publicity pertaining to distribution of the software without
1010 specific, written prior permission. The authors make no
1011 representations about the suitability of this software for any purpose. It
1012 is provided "as is" without express or implied warranty.
1014 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1015 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1016 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1017 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1018 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1019 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1020 PERFORMANCE OF THIS SOFTWARE.
1022 <refentry id="FcConfigAppFontAddDir">
1024 <refentrytitle>FcConfigAppFontAddDir</refentrytitle>
1025 <manvolnum>3</manvolnum>
1026 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1029 <refname>FcConfigAppFontAddDir</refname>
1030 <refpurpose>Add fonts from directory to font database</refpurpose>
1035 #include <fontconfig/fontconfig.h>
1038 <funcdef>FcBool <function>FcConfigAppFontAddDir</function></funcdef>
1039 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
1040 <paramdef>const FcChar8 *<parameter>dir</parameter></paramdef>
1044 <refsect1><title>Description</title>
1046 Scans the specified directory for fonts, adding each one found to the
1047 application-specific set of fonts. Returns FcFalse
1048 if the fonts cannot be added (due to allocation failure).
1049 Otherwise returns FcTrue. If <parameter>config</parameter> is NULL,
1050 the current configuration is used.
1055 fontconfig/doc/func.sgml
1057 Copyright © 2003 Keith Packard
1059 Permission to use, copy, modify, distribute, and sell this software and its
1060 documentation for any purpose is hereby granted without fee, provided that
1061 the above copyright notice appear in all copies and that both that
1062 copyright notice and this permission notice appear in supporting
1063 documentation, and that the name of the author(s) not be used in
1064 advertising or publicity pertaining to distribution of the software without
1065 specific, written prior permission. The authors make no
1066 representations about the suitability of this software for any purpose. It
1067 is provided "as is" without express or implied warranty.
1069 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1070 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1071 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1072 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1073 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1074 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1075 PERFORMANCE OF THIS SOFTWARE.
1077 <refentry id="FcConfigAppFontClear">
1079 <refentrytitle>FcConfigAppFontClear</refentrytitle>
1080 <manvolnum>3</manvolnum>
1081 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1084 <refname>FcConfigAppFontClear</refname>
1085 <refpurpose>Remove all app fonts from font database</refpurpose>
1090 #include <fontconfig/fontconfig.h>
1093 <funcdef>void <function>FcConfigAppFontClear</function></funcdef>
1094 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
1098 <refsect1><title>Description</title>
1100 Clears the set of application-specific fonts.
1101 If <parameter>config</parameter> is NULL, the current configuration is used.
1106 fontconfig/doc/func.sgml
1108 Copyright © 2003 Keith Packard
1110 Permission to use, copy, modify, distribute, and sell this software and its
1111 documentation for any purpose is hereby granted without fee, provided that
1112 the above copyright notice appear in all copies and that both that
1113 copyright notice and this permission notice appear in supporting
1114 documentation, and that the name of the author(s) not be used in
1115 advertising or publicity pertaining to distribution of the software without
1116 specific, written prior permission. The authors make no
1117 representations about the suitability of this software for any purpose. It
1118 is provided "as is" without express or implied warranty.
1120 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1121 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1122 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1123 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1124 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1125 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1126 PERFORMANCE OF THIS SOFTWARE.
1128 <refentry id="FcConfigSubstituteWithPat">
1130 <refentrytitle>FcConfigSubstituteWithPat</refentrytitle>
1131 <manvolnum>3</manvolnum>
1132 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1135 <refname>FcConfigSubstituteWithPat</refname>
1136 <refpurpose>Execute substitutions</refpurpose>
1141 #include <fontconfig/fontconfig.h>
1144 <funcdef>FcBool <function>FcConfigSubstituteWithPat</function></funcdef>
1145 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
1146 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
1147 <paramdef>FcPattern *<parameter>p_pat</parameter></paramdef>
1148 <paramdef>FcMatchKind <parameter>kind</parameter></paramdef>
1152 <refsect1><title>Description</title>
1154 Performs the sequence of pattern modification operations, if <parameter>kind</parameter> is
1155 FcMatchPattern, then those tagged as pattern operations are applied, else
1156 if <parameter>kind</parameter> is FcMatchFont, those tagged as font operations are applied and
1157 p_pat is used for <test> elements with target=pattern. Returns FcFalse
1158 if the substitution cannot be performed (due to allocation failure). Otherwise returns FcTrue.
1159 If <parameter>config</parameter> is NULL, the current configuration is used.
1164 fontconfig/doc/func.sgml
1166 Copyright © 2003 Keith Packard
1168 Permission to use, copy, modify, distribute, and sell this software and its
1169 documentation for any purpose is hereby granted without fee, provided that
1170 the above copyright notice appear in all copies and that both that
1171 copyright notice and this permission notice appear in supporting
1172 documentation, and that the name of the author(s) not be used in
1173 advertising or publicity pertaining to distribution of the software without
1174 specific, written prior permission. The authors make no
1175 representations about the suitability of this software for any purpose. It
1176 is provided "as is" without express or implied warranty.
1178 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1179 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1180 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1181 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1182 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1183 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1184 PERFORMANCE OF THIS SOFTWARE.
1186 <refentry id="FcConfigSubstitute">
1188 <refentrytitle>FcConfigSubstitute</refentrytitle>
1189 <manvolnum>3</manvolnum>
1190 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1193 <refname>FcConfigSubstitute</refname>
1194 <refpurpose>Execute substitutions</refpurpose>
1199 #include <fontconfig/fontconfig.h>
1202 <funcdef>FcBool <function>FcConfigSubstitute</function></funcdef>
1203 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
1204 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
1205 <paramdef>FcMatchKind <parameter>kind</parameter></paramdef>
1209 <refsect1><title>Description</title>
1211 Calls FcConfigSubstituteWithPat setting p_pat to NULL. Returns FcFalse
1212 if the substitution cannot be performed (due to allocation failure). Otherwise returns FcTrue.
1213 If <parameter>config</parameter> is NULL, the current configuration is used.
1218 fontconfig/doc/func.sgml
1220 Copyright © 2003 Keith Packard
1222 Permission to use, copy, modify, distribute, and sell this software and its
1223 documentation for any purpose is hereby granted without fee, provided that
1224 the above copyright notice appear in all copies and that both that
1225 copyright notice and this permission notice appear in supporting
1226 documentation, and that the name of the author(s) not be used in
1227 advertising or publicity pertaining to distribution of the software without
1228 specific, written prior permission. The authors make no
1229 representations about the suitability of this software for any purpose. It
1230 is provided "as is" without express or implied warranty.
1232 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1233 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1234 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1235 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1236 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1237 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1238 PERFORMANCE OF THIS SOFTWARE.
1240 <refentry id="FcFontMatch">
1242 <refentrytitle>FcFontMatch</refentrytitle>
1243 <manvolnum>3</manvolnum>
1244 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1247 <refname>FcFontMatch</refname>
1248 <refpurpose>Return best font</refpurpose>
1253 #include <fontconfig/fontconfig.h>
1256 <funcdef>FcPattern * <function>FcFontMatch</function></funcdef>
1257 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
1258 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
1259 <paramdef>FcResult *<parameter>result</parameter></paramdef>
1263 <refsect1><title>Description</title>
1265 Finds the font in <parameter>sets</parameter> most closely matching
1266 <parameter>pattern</parameter> and returns the result of
1267 <function>FcFontRenderPrepare</function> for that font and the provided
1268 pattern. This function should be called only after
1269 <function>FcConfigSubstitute</function> and
1270 <function>FcDefaultSubstitute</function> have been called for
1271 <parameter>p</parameter>; otherwise the results will not be correct.
1272 If <parameter>config</parameter> is NULL, the current configuration is used.
1277 fontconfig/doc/func.sgml
1279 Copyright © 2003 Keith Packard
1281 Permission to use, copy, modify, distribute, and sell this software and its
1282 documentation for any purpose is hereby granted without fee, provided that
1283 the above copyright notice appear in all copies and that both that
1284 copyright notice and this permission notice appear in supporting
1285 documentation, and that the name of the author(s) not be used in
1286 advertising or publicity pertaining to distribution of the software without
1287 specific, written prior permission. The authors make no
1288 representations about the suitability of this software for any purpose. It
1289 is provided "as is" without express or implied warranty.
1291 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1292 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1293 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1294 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1295 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1296 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1297 PERFORMANCE OF THIS SOFTWARE.
1299 <refentry id="FcFontSort">
1301 <refentrytitle>FcFontSort</refentrytitle>
1302 <manvolnum>3</manvolnum>
1303 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1306 <refname>FcFontSort</refname>
1307 <refpurpose>Return list of matching fonts</refpurpose>
1312 #include <fontconfig/fontconfig.h>
1315 <funcdef>FcFontSet * <function>FcFontSort</function></funcdef>
1316 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
1317 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
1318 <paramdef>FcBool <parameter>trim</parameter></paramdef>
1319 <paramdef>FcCharSet **<parameter>csp</parameter></paramdef>
1320 <paramdef>FcResult *<parameter>result</parameter></paramdef>
1324 <refsect1><title>Description</title>
1326 Returns the list of fonts sorted by closeness to <parameter>p</parameter>. If <parameter>trim</parameter> is FcTrue,
1327 elements in the list which don't include Unicode coverage not provided by
1328 earlier elements in the list are elided. The union of Unicode coverage of
1329 all of the fonts is returned in <parameter>csp</parameter>, if <parameter>csp</parameter> is not NULL. This function
1330 should be called only after FcConfigSubstitute and FcDefaultSubstitute have
1331 been called for <parameter>p</parameter>; otherwise the results will not be correct.
1333 The returned FcFontSet references FcPattern structures which may be shared
1334 by the return value from multiple FcFontSort calls, applications must not
1335 modify these patterns. Instead, they should be passed, along with <parameter>p</parameter> to
1336 <function>FcFontRenderPrepare</function> which combines them into a complete pattern.
1338 The FcFontSet returned by FcFontSort is destroyed by calling FcFontSetDestroy.
1339 If <parameter>config</parameter> is NULL, the current configuration is used.
1344 fontconfig/doc/func.sgml
1346 Copyright © 2003 Keith Packard
1348 Permission to use, copy, modify, distribute, and sell this software and its
1349 documentation for any purpose is hereby granted without fee, provided that
1350 the above copyright notice appear in all copies and that both that
1351 copyright notice and this permission notice appear in supporting
1352 documentation, and that the name of the author(s) not be used in
1353 advertising or publicity pertaining to distribution of the software without
1354 specific, written prior permission. The authors make no
1355 representations about the suitability of this software for any purpose. It
1356 is provided "as is" without express or implied warranty.
1358 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1359 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1360 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1361 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1362 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1363 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1364 PERFORMANCE OF THIS SOFTWARE.
1366 <refentry id="FcFontRenderPrepare">
1368 <refentrytitle>FcFontRenderPrepare</refentrytitle>
1369 <manvolnum>3</manvolnum>
1370 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1373 <refname>FcFontRenderPrepare</refname>
1374 <refpurpose>Prepare pattern for loading font file</refpurpose>
1379 #include <fontconfig/fontconfig.h>
1382 <funcdef>FcPattern * <function>FcFontRenderPrepare</function></funcdef>
1383 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
1384 <paramdef>FcPattern *<parameter>pat</parameter></paramdef>
1385 <paramdef>FcPattern *<parameter>font</parameter></paramdef>
1389 <refsect1><title>Description</title>
1391 Creates a new pattern consisting of elements of <parameter>font</parameter> not appearing
1392 in <parameter>pat</parameter>, elements of <parameter>pat</parameter> not appearing in <parameter>font</parameter> and the best matching
1393 value from <parameter>pat</parameter> for elements appearing in both. The result is passed to
1394 FcConfigSubstituteWithPat with <parameter>kind</parameter> FcMatchFont and then returned.
1399 fontconfig/doc/func.sgml
1401 Copyright © 2003 Keith Packard
1403 Permission to use, copy, modify, distribute, and sell this software and its
1404 documentation for any purpose is hereby granted without fee, provided that
1405 the above copyright notice appear in all copies and that both that
1406 copyright notice and this permission notice appear in supporting
1407 documentation, and that the name of the author(s) not be used in
1408 advertising or publicity pertaining to distribution of the software without
1409 specific, written prior permission. The authors make no
1410 representations about the suitability of this software for any purpose. It
1411 is provided "as is" without express or implied warranty.
1413 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1414 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1415 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1416 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1417 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1418 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1419 PERFORMANCE OF THIS SOFTWARE.
1421 <refentry id="FcFontList">
1423 <refentrytitle>FcFontList</refentrytitle>
1424 <manvolnum>3</manvolnum>
1425 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1428 <refname>FcFontList</refname>
1429 <refpurpose>List fonts</refpurpose>
1434 #include <fontconfig/fontconfig.h>
1437 <funcdef>FcFontSet * <function>FcFontList</function></funcdef>
1438 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
1439 <paramdef>FcPattern *<parameter>p</parameter></paramdef>
1440 <paramdef>FcObjectSet *<parameter>os</parameter></paramdef>
1444 <refsect1><title>Description</title>
1446 Selects fonts matching <parameter>p</parameter>, creates patterns from those fonts containing
1447 only the objects in <parameter>os</parameter> and returns the set of unique such patterns.
1448 If <parameter>config</parameter> is NULL, the default configuration is checked
1449 to be up to date, and used.
1454 fontconfig/doc/func.sgml
1456 Copyright © 2003 Keith Packard
1458 Permission to use, copy, modify, distribute, and sell this software and its
1459 documentation for any purpose is hereby granted without fee, provided that
1460 the above copyright notice appear in all copies and that both that
1461 copyright notice and this permission notice appear in supporting
1462 documentation, and that the name of the author(s) not be used in
1463 advertising or publicity pertaining to distribution of the software without
1464 specific, written prior permission. The authors make no
1465 representations about the suitability of this software for any purpose. It
1466 is provided "as is" without express or implied warranty.
1468 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1469 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1470 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1471 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1472 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1473 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1474 PERFORMANCE OF THIS SOFTWARE.
1476 <refentry id="FcConfigFilename">
1478 <refentrytitle>FcConfigFilename</refentrytitle>
1479 <manvolnum>3</manvolnum>
1480 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1483 <refname>FcConfigFilename</refname>
1484 <refpurpose>Find a config file</refpurpose>
1489 #include <fontconfig/fontconfig.h>
1492 <funcdef>FcChar8 * <function>FcConfigFilename</function></funcdef>
1493 <paramdef>const FcChar8 *<parameter>name</parameter></paramdef>
1497 <refsect1><title>Description</title>
1499 Given the specified external entity name, return the associated filename.
1500 This provides applications a way to convert various configuration file
1501 references into filename form.
1503 A null or empty <parameter>name</parameter> indicates that the default configuration file should
1504 be used; which file this references can be overridden with the
1505 FONTCONFIG_FILE environment variable. Next, if the name starts with <parameter>~</parameter>, it
1506 refers to a file in the current users home directory. Otherwise if the name
1507 doesn't start with '/', it refers to a file in the default configuration
1508 directory; the built-in default directory can be overridden with the
1509 FONTCONFIG_PATH environment variable.
1514 fontconfig/doc/func.sgml
1516 Copyright © 2003 Keith Packard
1518 Permission to use, copy, modify, distribute, and sell this software and its
1519 documentation for any purpose is hereby granted without fee, provided that
1520 the above copyright notice appear in all copies and that both that
1521 copyright notice and this permission notice appear in supporting
1522 documentation, and that the name of the author(s) not be used in
1523 advertising or publicity pertaining to distribution of the software without
1524 specific, written prior permission. The authors make no
1525 representations about the suitability of this software for any purpose. It
1526 is provided "as is" without express or implied warranty.
1528 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1529 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1530 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1531 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1532 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1533 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1534 PERFORMANCE OF THIS SOFTWARE.
1536 <refentry id="FcConfigParseAndLoad">
1538 <refentrytitle>FcConfigParseAndLoad</refentrytitle>
1539 <manvolnum>3</manvolnum>
1540 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1543 <refname>FcConfigParseAndLoad</refname>
1544 <refpurpose>load a configuration file</refpurpose>
1549 #include <fontconfig/fontconfig.h>
1552 <funcdef>FcBool <function>FcConfigParseAndLoad</function></funcdef>
1553 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
1554 <paramdef>const FcChar8 *<parameter>file</parameter></paramdef>
1555 <paramdef>FcBool <parameter>complain</parameter></paramdef>
1559 <refsect1><title>Description</title>
1561 Walks the configuration in 'file' and constructs the internal representation
1562 in 'config'. Any include files referenced from within 'file' will be loaded
1563 and parsed. If 'complain' is FcFalse, no warning will be displayed if
1564 'file' does not exist. Error and warning messages will be output to stderr.
1565 Returns FcFalse if some error occurred while loading the file, either a
1566 parse error, semantic error or allocation failure. Otherwise returns FcTrue.
1571 fontconfig/doc/func.sgml
1573 Copyright © 2003 Keith Packard
1575 Permission to use, copy, modify, distribute, and sell this software and its
1576 documentation for any purpose is hereby granted without fee, provided that
1577 the above copyright notice appear in all copies and that both that
1578 copyright notice and this permission notice appear in supporting
1579 documentation, and that the name of the author(s) not be used in
1580 advertising or publicity pertaining to distribution of the software without
1581 specific, written prior permission. The authors make no
1582 representations about the suitability of this software for any purpose. It
1583 is provided "as is" without express or implied warranty.
1585 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1586 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1587 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1588 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1589 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1590 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1591 PERFORMANCE OF THIS SOFTWARE.
1593 <refentry id="FcConfigParseAndLoadFromMemory">
1595 <refentrytitle>FcConfigParseAndLoadFromMemory</refentrytitle>
1596 <manvolnum>3</manvolnum>
1597 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1600 <refname>FcConfigParseAndLoadFromMemory</refname>
1601 <refpurpose>load a configuration from memory</refpurpose>
1606 #include <fontconfig/fontconfig.h>
1609 <funcdef>FcBool <function>FcConfigParseAndLoadFromMemory</function></funcdef>
1610 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
1611 <paramdef>const FcChar8 *<parameter>buffer</parameter></paramdef>
1612 <paramdef>FcBool <parameter>complain</parameter></paramdef>
1616 <refsect1><title>Description</title>
1618 Walks the configuration in 'memory' and constructs the internal representation
1619 in 'config'. Any includes files referenced from within 'memory' will be loaded
1620 and dparsed. If 'complain' is FcFalse, no warning will be displayed if
1621 'file' does not exist. Error and warning messages will be output to stderr.
1622 Returns FcFalse if fsome error occurred while loading the file, either a
1623 parse error, semantic error or allocation failure. Otherwise returns FcTrue.
1626 <refsect1><title>Since</title>
1627 <para>version 2.12.5</para>
1631 fontconfig/doc/func.sgml
1633 Copyright © 2003 Keith Packard
1635 Permission to use, copy, modify, distribute, and sell this software and its
1636 documentation for any purpose is hereby granted without fee, provided that
1637 the above copyright notice appear in all copies and that both that
1638 copyright notice and this permission notice appear in supporting
1639 documentation, and that the name of the author(s) not be used in
1640 advertising or publicity pertaining to distribution of the software without
1641 specific, written prior permission. The authors make no
1642 representations about the suitability of this software for any purpose. It
1643 is provided "as is" without express or implied warranty.
1645 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1646 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1647 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1648 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1649 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1650 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1651 PERFORMANCE OF THIS SOFTWARE.
1653 <refentry id="FcConfigGetSysRoot">
1655 <refentrytitle>FcConfigGetSysRoot</refentrytitle>
1656 <manvolnum>3</manvolnum>
1657 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1660 <refname>FcConfigGetSysRoot</refname>
1661 <refpurpose>Obtain the system root directory</refpurpose>
1666 #include <fontconfig/fontconfig.h>
1669 <funcdef>const FcChar8 * <function>FcConfigGetSysRoot</function></funcdef>
1670 <paramdef>const FcConfig *<parameter>config</parameter></paramdef>
1674 <refsect1><title>Description</title>
1676 Obtrains the system root directory in 'config' if available.
1679 <refsect1><title>Since</title>
1680 <para>version 2.10.92</para>
1684 fontconfig/doc/func.sgml
1686 Copyright © 2003 Keith Packard
1688 Permission to use, copy, modify, distribute, and sell this software and its
1689 documentation for any purpose is hereby granted without fee, provided that
1690 the above copyright notice appear in all copies and that both that
1691 copyright notice and this permission notice appear in supporting
1692 documentation, and that the name of the author(s) not be used in
1693 advertising or publicity pertaining to distribution of the software without
1694 specific, written prior permission. The authors make no
1695 representations about the suitability of this software for any purpose. It
1696 is provided "as is" without express or implied warranty.
1698 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1699 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1700 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1701 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1702 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1703 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1704 PERFORMANCE OF THIS SOFTWARE.
1706 <refentry id="FcConfigSetSysRoot">
1708 <refentrytitle>FcConfigSetSysRoot</refentrytitle>
1709 <manvolnum>3</manvolnum>
1710 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1713 <refname>FcConfigSetSysRoot</refname>
1714 <refpurpose>Set the system root directory</refpurpose>
1719 #include <fontconfig/fontconfig.h>
1722 <funcdef>void <function>FcConfigSetSysRoot</function></funcdef>
1723 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
1724 <paramdef>const FcChar8 *<parameter>sysroot</parameter></paramdef>
1728 <refsect1><title>Description</title>
1730 Set 'sysroot' as the system root directory. fontconfig prepend 'sysroot'
1731 to the cache directories in order to allow people to generate caches at
1732 the build time. Note that this causes changing current config. i.e.
1733 this function calls FcConfigSetCurrent() internally.
1736 <refsect1><title>Since</title>
1737 <para>version 2.10.92</para>
1741 fontconfig/doc/func.sgml
1743 Copyright © 2003 Keith Packard
1745 Permission to use, copy, modify, distribute, and sell this software and its
1746 documentation for any purpose is hereby granted without fee, provided that
1747 the above copyright notice appear in all copies and that both that
1748 copyright notice and this permission notice appear in supporting
1749 documentation, and that the name of the author(s) not be used in
1750 advertising or publicity pertaining to distribution of the software without
1751 specific, written prior permission. The authors make no
1752 representations about the suitability of this software for any purpose. It
1753 is provided "as is" without express or implied warranty.
1755 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1756 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1757 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1758 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1759 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1760 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1761 PERFORMANCE OF THIS SOFTWARE.
1763 <refentry id="FcConfigFileInfoIterInit">
1765 <refentrytitle>FcConfigFileInfoIterInit</refentrytitle>
1766 <manvolnum>3</manvolnum>
1767 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1770 <refname>FcConfigFileInfoIterInit</refname>
1771 <refpurpose>Initialize the iterator</refpurpose>
1776 #include <fontconfig/fontconfig.h>
1779 <funcdef>void <function>FcConfigFileInfoIterInit</function></funcdef>
1780 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
1781 <paramdef>FcConfigFileInfoIter *<parameter>iter</parameter></paramdef>
1785 <refsect1><title>Description</title>
1787 Initialize 'iter' with the first iterator in the config file information list.
1790 <refsect1><title>Since</title>
1791 <para>version 2.12.91</para>
1795 fontconfig/doc/func.sgml
1797 Copyright © 2003 Keith Packard
1799 Permission to use, copy, modify, distribute, and sell this software and its
1800 documentation for any purpose is hereby granted without fee, provided that
1801 the above copyright notice appear in all copies and that both that
1802 copyright notice and this permission notice appear in supporting
1803 documentation, and that the name of the author(s) not be used in
1804 advertising or publicity pertaining to distribution of the software without
1805 specific, written prior permission. The authors make no
1806 representations about the suitability of this software for any purpose. It
1807 is provided "as is" without express or implied warranty.
1809 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1810 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1811 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1812 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1813 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1814 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1815 PERFORMANCE OF THIS SOFTWARE.
1817 <refentry id="FcConfigFileInfoIterNext">
1819 <refentrytitle>FcConfigFileInfoIterNext</refentrytitle>
1820 <manvolnum>3</manvolnum>
1821 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1824 <refname>FcConfigFileInfoIterNext</refname>
1825 <refpurpose>Set the iterator to point to the next list</refpurpose>
1830 #include <fontconfig/fontconfig.h>
1833 <funcdef>FcBool <function>FcConfigFileInfoIterNext</function></funcdef>
1834 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
1835 <paramdef>FcConfigFileInfoIter *<parameter>iter</parameter></paramdef>
1839 <refsect1><title>Description</title>
1841 Set 'iter' to point to the next node in the config file information list.
1842 If there is no next node, FcFalse is returned.
1845 <refsect1><title>Since</title>
1846 <para>version 2.12.91</para>
1850 fontconfig/doc/func.sgml
1852 Copyright © 2003 Keith Packard
1854 Permission to use, copy, modify, distribute, and sell this software and its
1855 documentation for any purpose is hereby granted without fee, provided that
1856 the above copyright notice appear in all copies and that both that
1857 copyright notice and this permission notice appear in supporting
1858 documentation, and that the name of the author(s) not be used in
1859 advertising or publicity pertaining to distribution of the software without
1860 specific, written prior permission. The authors make no
1861 representations about the suitability of this software for any purpose. It
1862 is provided "as is" without express or implied warranty.
1864 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
1865 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
1866 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
1867 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
1868 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
1869 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
1870 PERFORMANCE OF THIS SOFTWARE.
1872 <refentry id="FcConfigFileInfoIterGet">
1874 <refentrytitle>FcConfigFileInfoIterGet</refentrytitle>
1875 <manvolnum>3</manvolnum>
1876 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
1879 <refname>FcConfigFileInfoIterGet</refname>
1880 <refpurpose>Obtain the configuration file information</refpurpose>
1885 #include <fontconfig/fontconfig.h>
1888 <funcdef>FcBool <function>FcConfigFileInfoIterGet</function></funcdef>
1889 <paramdef>FcConfig *<parameter>config</parameter></paramdef>
1890 <paramdef>FcConfigFileInfoIter *<parameter>iter</parameter></paramdef>
1891 <paramdef>FcChar8 **<parameter>name</parameter></paramdef>
1892 <paramdef>FcChar8 **<parameter>description</parameter></paramdef>
1893 <paramdef>FcBool *<parameter>enabled</parameter></paramdef>
1897 <refsect1><title>Description</title>
1899 Obtain the filename, the description and the flag whether it is enabled or not
1900 for 'iter' where points to current configuration file information.
1901 If the iterator is invalid, FcFalse is returned.
1904 <refsect1><title>Since</title>
1905 <para>version 2.12.91</para>