[fontconfig.git] / doc / fcinit.fncs

/*
 * fontconfig/doc/fcinit.fncs
 *
 * Copyright © 2003 Keith Packard
 *
 * Permission to use, copy, modify, distribute, and sell this software and its
 * documentation for any purpose is hereby granted without fee, provided that
 * the above copyright notice appear in all copies and that both that
 * copyright notice and this permission notice appear in supporting
 * documentation, and that the name of the author(s) not be used in
 * advertising or publicity pertaining to distribution of the software without
 * specific, written prior permission.  The authors make no
 * representations about the suitability of this software for any purpose.  It
 * is provided "as is" without express or implied warranty.
 *
 * THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 * EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 */
@RET@		FcConfig *
@FUNC@		FcInitLoadConfig
@TYPE1@		void
@PURPOSE@	load configuration
@DESC@
Loads the default configuration file and returns the resulting configuration.
Does not load any font information.
@@

@RET@           FcConfig *      
@FUNC@          FcInitLoadConfigAndFonts 
@TYPE1@		void
@PURPOSE@	load configuration and font data
@DESC@
Loads the default configuration file and builds information about the
available fonts.  Returns the resulting configuration.
@@

@RET@           FcBool       
@FUNC@          FcInit 
@TYPE1@		void
@PURPOSE@	initialize fontconfig library
@DESC@
Loads the default configuration file and the fonts referenced therein and
sets the default configuration to that result.  Returns whether this
process succeeded or not.  If the default configuration has already
been loaded, this routine does nothing and returns FcTrue.
@@

@RET@		void
@FUNC@		FcFini
@TYPE1@		void
@PURPOSE@	finalize fonconfig library
@DESC@
Frees all data structures allocated by previous calls to fontconfig
functions. Fontconfig returns to an uninitialized state, requiring a
new call to one of the FcInit functions before any other fontconfig
function may be called.
@@

@RET@           int       
@FUNC@          FcGetVersion 
@TYPE1@		void
@PURPOSE@	library version number
@DESC@
Returns the version number of the library.
@@

@RET@           FcBool       
@FUNC@          FcInitReinitialize 
@TYPE1@		void
@PURPOSE@	re-initialize library
@DESC@
Forces the default configuration file to be reloaded and resets the default
configuration. Returns FcFalse if the configuration cannot be reloaded (due
to configuration file errors, allocation failures or other issues) and leaves the
existing configuration unchanged. Otherwise returns FcTrue.
@@

@RET@           FcBool       
@FUNC@          FcInitBringUptoDate 
@TYPE1@		void
@PURPOSE@	reload configuration files if needed
@DESC@
Checks the rescan interval in the default configuration, checking the
configuration if the interval has passed and reloading the configuration if
when any changes are detected. Returns FcFalse if the configuration cannot
be reloaded (see FcInitReinitialize). Otherwise returns FcTrue.
@@
Commit	Line	Data
39381776	1	/*
e690fbb2	2	* fontconfig/doc/fcinit.fncs
39381776	3	*
46b51147	4	* Copyright © 2003 Keith Packard
39381776 KP	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
5aaf466d	10	* documentation, and that the name of the author(s) not be used in
39381776	11	* advertising or publicity pertaining to distribution of the software without
5aaf466d	12	* specific, written prior permission. The authors make no
39381776 KP	13	* representations about the suitability of this software for any purpose. It
	14	* is provided "as is" without express or implied warranty.
	15	*
3074a73b	16	* THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
39381776	17	* INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
3074a73b	18	* EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
39381776 KP	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	@RET@ FcConfig *
	25	@FUNC@ FcInitLoadConfig
	26	@TYPE1@ void
	27	@PURPOSE@ load configuration
	28	@DESC@
	29	Loads the default configuration file and returns the resulting configuration.
	30	Does not load any font information.
	31	@@
	32
	33	@RET@ FcConfig *
	34	@FUNC@ FcInitLoadConfigAndFonts
	35	@TYPE1@ void
	36	@PURPOSE@ load configuration and font data
	37	@DESC@
	38	Loads the default configuration file and builds information about the
	39	available fonts. Returns the resulting configuration.
	40	@@
	41
	42	@RET@ FcBool
	43	@FUNC@ FcInit
	44	@TYPE1@ void
	45	@PURPOSE@ initialize fontconfig library
	46	@DESC@
	47	Loads the default configuration file and the fonts referenced therein and
	48	sets the default configuration to that result. Returns whether this
	49	process succeeded or not. If the default configuration has already
	50	been loaded, this routine does nothing and returns FcTrue.
	51	@@
	52
34cd0514 CW	53	@RET@ void
	54	@FUNC@ FcFini
	55	@TYPE1@ void
	56	@PURPOSE@ finalize fonconfig library
	57	@DESC@
	58	Frees all data structures allocated by previous calls to fontconfig
	59	functions. Fontconfig returns to an uninitialized state, requiring a
	60	new call to one of the FcInit functions before any other fontconfig
	61	function may be called.
	62	@@
	63
39381776 KP	64	@RET@ int
	65	@FUNC@ FcGetVersion
	66	@TYPE1@ void
	67	@PURPOSE@ library version number
	68	@DESC@
	69	Returns the version number of the library.
	70	@@
	71
	72	@RET@ FcBool
	73	@FUNC@ FcInitReinitialize
	74	@TYPE1@ void
	75	@PURPOSE@ re-initialize library
	76	@DESC@
	77	Forces the default configuration file to be reloaded and resets the default
fab44f3c	78	configuration. Returns FcFalse if the configuration cannot be reloaded (due
7baa20c7	79	to configuration file errors, allocation failures or other issues) and leaves the
fab44f3c	80	existing configuration unchanged. Otherwise returns FcTrue.
39381776 KP	81	@@
	82
	83	@RET@ FcBool
	84	@FUNC@ FcInitBringUptoDate
	85	@TYPE1@ void
	86	@PURPOSE@ reload configuration files if needed
	87	@DESC@
	88	Checks the rescan interval in the default configuration, checking the
	89	configuration if the interval has passed and reloading the configuration if
fab44f3c KP	90	when any changes are detected. Returns FcFalse if the configuration cannot
fab44f3c KP	91	be reloaded (see FcInitReinitialize). Otherwise returns FcTrue.
39381776	92	@@