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="FcInitLoadConfig">
26 <refentrytitle>FcInitLoadConfig</refentrytitle>
27 <manvolnum>3</manvolnum>
28 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
31 <refname>FcInitLoadConfig</refname>
32 <refpurpose>load configuration</refpurpose>
37 #include <fontconfig/fontconfig.h>
40 <funcdef>FcConfig * <function>FcInitLoadConfig</function></funcdef>
41 <paramdef>void<parameter></parameter></paramdef>
45 <refsect1><title>Description</title>
47 Loads the default configuration file and returns the resulting configuration.
48 Does not load any font information.
53 fontconfig/doc/func.sgml
55 Copyright © 2003 Keith Packard
57 Permission to use, copy, modify, distribute, and sell this software and its
58 documentation for any purpose is hereby granted without fee, provided that
59 the above copyright notice appear in all copies and that both that
60 copyright notice and this permission notice appear in supporting
61 documentation, and that the name of the author(s) not be used in
62 advertising or publicity pertaining to distribution of the software without
63 specific, written prior permission. The authors make no
64 representations about the suitability of this software for any purpose. It
65 is provided "as is" without express or implied warranty.
67 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
68 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
69 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
70 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
71 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
72 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
73 PERFORMANCE OF THIS SOFTWARE.
75 <refentry id="FcInitLoadConfigAndFonts">
77 <refentrytitle>FcInitLoadConfigAndFonts</refentrytitle>
78 <manvolnum>3</manvolnum>
79 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
82 <refname>FcInitLoadConfigAndFonts</refname>
83 <refpurpose>load configuration and font data</refpurpose>
88 #include <fontconfig/fontconfig.h>
91 <funcdef>FcConfig * <function>FcInitLoadConfigAndFonts</function></funcdef>
92 <paramdef>void<parameter></parameter></paramdef>
96 <refsect1><title>Description</title>
98 Loads the default configuration file and builds information about the
99 available fonts. Returns the resulting configuration.
104 fontconfig/doc/func.sgml
106 Copyright © 2003 Keith Packard
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.
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.
126 <refentry id="FcInit">
128 <refentrytitle>FcInit</refentrytitle>
129 <manvolnum>3</manvolnum>
130 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
133 <refname>FcInit</refname>
134 <refpurpose>initialize fontconfig library</refpurpose>
139 #include <fontconfig/fontconfig.h>
142 <funcdef>FcBool <function>FcInit</function></funcdef>
143 <paramdef>void<parameter></parameter></paramdef>
147 <refsect1><title>Description</title>
149 Loads the default configuration file and the fonts referenced therein and
150 sets the default configuration to that result. Returns whether this
151 process succeeded or not. If the default configuration has already
152 been loaded, this routine does nothing and returns FcTrue.
157 fontconfig/doc/func.sgml
159 Copyright © 2003 Keith Packard
161 Permission to use, copy, modify, distribute, and sell this software and its
162 documentation for any purpose is hereby granted without fee, provided that
163 the above copyright notice appear in all copies and that both that
164 copyright notice and this permission notice appear in supporting
165 documentation, and that the name of the author(s) not be used in
166 advertising or publicity pertaining to distribution of the software without
167 specific, written prior permission. The authors make no
168 representations about the suitability of this software for any purpose. It
169 is provided "as is" without express or implied warranty.
171 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
172 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
173 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
174 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
175 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
176 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
177 PERFORMANCE OF THIS SOFTWARE.
179 <refentry id="FcFini">
181 <refentrytitle>FcFini</refentrytitle>
182 <manvolnum>3</manvolnum>
183 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
186 <refname>FcFini</refname>
187 <refpurpose>finalize fontconfig library</refpurpose>
192 #include <fontconfig/fontconfig.h>
195 <funcdef>void <function>FcFini</function></funcdef>
196 <paramdef>void<parameter></parameter></paramdef>
200 <refsect1><title>Description</title>
202 Frees all data structures allocated by previous calls to fontconfig
203 functions. Fontconfig returns to an uninitialized state, requiring a
204 new call to one of the FcInit functions before any other fontconfig
205 function may be called.
210 fontconfig/doc/func.sgml
212 Copyright © 2003 Keith Packard
214 Permission to use, copy, modify, distribute, and sell this software and its
215 documentation for any purpose is hereby granted without fee, provided that
216 the above copyright notice appear in all copies and that both that
217 copyright notice and this permission notice appear in supporting
218 documentation, and that the name of the author(s) not be used in
219 advertising or publicity pertaining to distribution of the software without
220 specific, written prior permission. The authors make no
221 representations about the suitability of this software for any purpose. It
222 is provided "as is" without express or implied warranty.
224 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
225 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
226 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
227 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
228 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
229 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
230 PERFORMANCE OF THIS SOFTWARE.
232 <refentry id="FcGetVersion">
234 <refentrytitle>FcGetVersion</refentrytitle>
235 <manvolnum>3</manvolnum>
236 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
239 <refname>FcGetVersion</refname>
240 <refpurpose>library version number</refpurpose>
245 #include <fontconfig/fontconfig.h>
248 <funcdef>int <function>FcGetVersion</function></funcdef>
249 <paramdef>void<parameter></parameter></paramdef>
253 <refsect1><title>Description</title>
255 Returns the version number of the library.
260 fontconfig/doc/func.sgml
262 Copyright © 2003 Keith Packard
264 Permission to use, copy, modify, distribute, and sell this software and its
265 documentation for any purpose is hereby granted without fee, provided that
266 the above copyright notice appear in all copies and that both that
267 copyright notice and this permission notice appear in supporting
268 documentation, and that the name of the author(s) not be used in
269 advertising or publicity pertaining to distribution of the software without
270 specific, written prior permission. The authors make no
271 representations about the suitability of this software for any purpose. It
272 is provided "as is" without express or implied warranty.
274 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
275 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
276 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
277 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
278 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
279 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
280 PERFORMANCE OF THIS SOFTWARE.
282 <refentry id="FcInitReinitialize">
284 <refentrytitle>FcInitReinitialize</refentrytitle>
285 <manvolnum>3</manvolnum>
286 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
289 <refname>FcInitReinitialize</refname>
290 <refpurpose>re-initialize library</refpurpose>
295 #include <fontconfig/fontconfig.h>
298 <funcdef>FcBool <function>FcInitReinitialize</function></funcdef>
299 <paramdef>void<parameter></parameter></paramdef>
303 <refsect1><title>Description</title>
305 Forces the default configuration file to be reloaded and resets the default
306 configuration. Returns FcFalse if the configuration cannot be reloaded (due
307 to configuration file errors, allocation failures or other issues) and leaves the
308 existing configuration unchanged. Otherwise returns FcTrue.
313 fontconfig/doc/func.sgml
315 Copyright © 2003 Keith Packard
317 Permission to use, copy, modify, distribute, and sell this software and its
318 documentation for any purpose is hereby granted without fee, provided that
319 the above copyright notice appear in all copies and that both that
320 copyright notice and this permission notice appear in supporting
321 documentation, and that the name of the author(s) not be used in
322 advertising or publicity pertaining to distribution of the software without
323 specific, written prior permission. The authors make no
324 representations about the suitability of this software for any purpose. It
325 is provided "as is" without express or implied warranty.
327 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
328 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
329 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
330 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
331 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
332 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
333 PERFORMANCE OF THIS SOFTWARE.
335 <refentry id="FcInitBringUptoDate">
337 <refentrytitle>FcInitBringUptoDate</refentrytitle>
338 <manvolnum>3</manvolnum>
339 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
342 <refname>FcInitBringUptoDate</refname>
343 <refpurpose>reload configuration files if needed</refpurpose>
348 #include <fontconfig/fontconfig.h>
351 <funcdef>FcBool <function>FcInitBringUptoDate</function></funcdef>
352 <paramdef>void<parameter></parameter></paramdef>
356 <refsect1><title>Description</title>
358 Checks the rescan interval in the default configuration, checking the
359 configuration if the interval has passed and reloading the configuration if
360 when any changes are detected. Returns FcFalse if the configuration cannot
361 be reloaded (see FcInitReinitialize). Otherwise returns FcTrue.