doc/fcinit.fncs

   1 /*
   2  * $Id$
   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 Keith Packard not be used in
  11  * advertising or publicity pertaining to distribution of the software without
  12  * specific, written prior permission.  Keith Packard makes 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  * KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  17  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  18  * EVENT SHALL KEITH PACKARD 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@           int
  54 @FUNC@          FcGetVersion
  55 @TYPE1@         void
  56 @PURPOSE@       library version number
  57 @DESC@
  58 Returns the version number of the library.
  59 @@
  60
  61 @RET@           FcBool
  62 @FUNC@          FcInitReinitialize
  63 @TYPE1@         void
  64 @PURPOSE@       re-initialize library
  65 @DESC@
  66 Forces the default configuration file to be reloaded and resets the default
  67 configuration.
  68 @@
  69
  70 @RET@           FcBool
  71 @FUNC@          FcInitBringUptoDate
  72 @TYPE1@         void
  73 @PURPOSE@       reload configuration files if needed
  74 @DESC@
  75 Checks the rescan interval in the default configuration, checking the
  76 configuration if the interval has passed and reloading the configuration if
  77 when any changes are detected.
  78 @@