doc/fcinit.fncs

   1 /*
   2  * fontconfig/doc/fcinit.fncs
   3  *
   4  * Copyright © 2003 Keith Packard
   5  *
   6  * Permission to use, copy, modify, distribute, and sell this software and its
   7  * documentation for any purpose is hereby granted without fee, provided that
   8  * the above copyright notice appear in all copies and that both that
   9  * copyright notice and this permission notice appear in supporting
  10  * documentation, and that the name of the author(s) not be used in
  11  * advertising or publicity pertaining to distribution of the software without
  12  * specific, written prior permission.  The authors make no
  13  * representations about the suitability of this software for any purpose.  It
  14  * is provided "as is" without express or implied warranty.
  15  *
  16  * THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  17  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  18  * EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  19  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  20  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  21  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  22  * PERFORMANCE OF THIS SOFTWARE.
  23  */
  24 @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
  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
  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
  78 configuration. Returns FcFalse if the configuration cannot be reloaded (due
  79 to config file errors, allocation failures or other issues) and leaves the
  80 existing configuration unchanged. Otherwise returns FcTrue.
  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
  90 when any changes are detected. Returns FcFalse if the configuration cannot
  91 be reloaded (see FcInitReinitialize). Otherwise returns FcTrue.
  92 @@