Blame doc/fcinit.fncs

Packit 352660
/*
Packit 352660
 * fontconfig/doc/fcinit.fncs
Packit 352660
 *
Packit 352660
 * Copyright © 2003 Keith Packard
Packit 352660
 *
Packit 352660
 * Permission to use, copy, modify, distribute, and sell this software and its
Packit 352660
 * documentation for any purpose is hereby granted without fee, provided that
Packit 352660
 * the above copyright notice appear in all copies and that both that
Packit 352660
 * copyright notice and this permission notice appear in supporting
Packit 352660
 * documentation, and that the name of the author(s) not be used in
Packit 352660
 * advertising or publicity pertaining to distribution of the software without
Packit 352660
 * specific, written prior permission.  The authors make no
Packit 352660
 * representations about the suitability of this software for any purpose.  It
Packit 352660
 * is provided "as is" without express or implied warranty.
Packit 352660
 *
Packit 352660
 * THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
Packit 352660
 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
Packit 352660
 * EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
Packit 352660
 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
Packit 352660
 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
Packit 352660
 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
Packit 352660
 * PERFORMANCE OF THIS SOFTWARE.
Packit 352660
 */
Packit 352660
@RET@		FcConfig *
Packit 352660
@FUNC@		FcInitLoadConfig
Packit 352660
@TYPE1@		void
Packit 352660
@PURPOSE@	load configuration
Packit 352660
@DESC@
Packit 352660
Loads the default configuration file and returns the resulting configuration.
Packit 352660
Does not load any font information.
Packit 352660
@@
Packit 352660
Packit 352660
@RET@           FcConfig *      
Packit 352660
@FUNC@          FcInitLoadConfigAndFonts 
Packit 352660
@TYPE1@		void
Packit 352660
@PURPOSE@	load configuration and font data
Packit 352660
@DESC@
Packit 352660
Loads the default configuration file and builds information about the
Packit 352660
available fonts.  Returns the resulting configuration.
Packit 352660
@@
Packit 352660
Packit 352660
@RET@           FcBool       
Packit 352660
@FUNC@          FcInit 
Packit 352660
@TYPE1@		void
Packit 352660
@PURPOSE@	initialize fontconfig library
Packit 352660
@DESC@
Packit 352660
Loads the default configuration file and the fonts referenced therein and
Packit 352660
sets the default configuration to that result.  Returns whether this
Packit 352660
process succeeded or not.  If the default configuration has already
Packit 352660
been loaded, this routine does nothing and returns FcTrue.
Packit 352660
@@
Packit 352660
Packit 352660
@RET@		void
Packit 352660
@FUNC@		FcFini
Packit 352660
@TYPE1@		void
Packit 352660
@PURPOSE@	finalize fontconfig library
Packit 352660
@DESC@
Packit 352660
Frees all data structures allocated by previous calls to fontconfig
Packit 352660
functions. Fontconfig returns to an uninitialized state, requiring a
Packit 352660
new call to one of the FcInit functions before any other fontconfig
Packit 352660
function may be called.
Packit 352660
@@
Packit 352660
Packit 352660
@RET@           int       
Packit 352660
@FUNC@          FcGetVersion 
Packit 352660
@TYPE1@		void
Packit 352660
@PURPOSE@	library version number
Packit 352660
@DESC@
Packit 352660
Returns the version number of the library.
Packit 352660
@@
Packit 352660
Packit 352660
@RET@           FcBool       
Packit 352660
@FUNC@          FcInitReinitialize 
Packit 352660
@TYPE1@		void
Packit 352660
@PURPOSE@	re-initialize library
Packit 352660
@DESC@
Packit 352660
Forces the default configuration file to be reloaded and resets the default
Packit 352660
configuration. Returns FcFalse if the configuration cannot be reloaded (due
Packit 352660
to configuration file errors, allocation failures or other issues) and leaves the
Packit 352660
existing configuration unchanged. Otherwise returns FcTrue.
Packit 352660
@@
Packit 352660
Packit 352660
@RET@           FcBool       
Packit 352660
@FUNC@          FcInitBringUptoDate 
Packit 352660
@TYPE1@		void
Packit 352660
@PURPOSE@	reload configuration files if needed
Packit 352660
@DESC@
Packit 352660
Checks the rescan interval in the default configuration, checking the
Packit 352660
configuration if the interval has passed and reloading the configuration if
Packit 352660
when any changes are detected. Returns FcFalse if the configuration cannot
Packit 352660
be reloaded (see FcInitReinitialize). Otherwise returns FcTrue.
Packit 352660
@@