- <sect3><title>FcBlanksCreate</title><programlisting>
-FcBlanks *FcBlanksCreate (void)
- </programlisting><para>
-Creates an empty FcBlanks object.
- </para>
- <sect3><title>FcBlanksDestroy</title><programlisting>
-void FcBlanksDestroy (FcBlanks *b)
- </programlisting><para>
-Destroys an FcBlanks object, freeing any associated memory.
- </para>
- <sect3><title>FcBlanksAdd</title><programlisting>
-FcBool FcBlanksAdd (FcBlanks *b, FcChar32 ucs4)
- </programlisting><para>
-Adds a single character to an FcBlanks object, returning FcFalse
-if this process ran out of memory.
- </para>
- <sect3><title>FcBlanksIsMember</title><programlisting>
-FcBool FcBlanksIsMember (FcBlanks *b, FcChar32 ucs4)
- </programlisting><para>
-Returns whether the specified FcBlanks object contains the indicated Unicode
-value.
- </para>
- </sect2>
- <sect2><title>FcConfig</title>
- <para>
-An FcConfig object holds the internal representation of a configuration.
-There is a default configuration which applications may use by passing 0 to
-any function using the data within an FcConfig.
- </para>
- <sect3><title>FcConfigCreate</title><programlisting>
-FcConfig *FcConfigCreate (void)
- </programlisting><para>
-Creates an empty configuration.
- </para>
- <sect3><title>FcConfigDestroy</title><programlisting>
-void FcConfigDestroy (FcConfig *config)
- </programlisting><para>
-Destroys a configuration and any data associated with it. Note that calling
-this function with the return from FcConfigGetCurrent will place the library
-in an indeterminate state.
- </para>
- <sect3><title>FcConfigSetCurrent</title><programlisting>
-FcBool FcConfigSetCurrent (FcConfig *config)
- </programlisting><para>
-Sets the current default configuration to 'config'. Implicitly calls
-FcConfigBuildFonts if necessary, returning FcFalse if that call fails.
- </para>
- <sect3><title>FcConfigGetCurrent</title><programlisting>
-FcConfig *FcConfigGetCurrent (void)
- </programlisting><para>
-Returns the current default configuration.
- </para>
- <sect3><title>FcConfigUptoDate</title><programlisting>
-FcBool FcConfigUptoDate (FcConfig *config)
- </programlisting><para>
-Checks all of the files related to 'config' and returns whether the
-in-memory version is in sync with the disk version.
- </para>
- <sect3><title>FcConfigBuildFonts</title><programlisting>
-FcBool FcConfigBuildFonts (FcConfig *config)
- </programlisting><para>
-Builds the set of available fonts for the given configuration. Note that
-any changes to the configuration after this call have indeterminate effects.
-Returns FcFalse if this operation runs out of memory.
- </para>
- <sect3><title>FcConfigGetConfigDirs</title><programlisting>
-FcStrList *FcConfigGetConfigDirs (FcConfig *config)
- </programlisting><para>
-Returns the list of font directories specified in the configuration files
-for 'config'. Does not include any subdirectories.
- </para>
- <sect3><title>FcConfigGetFontDirs</title><programlisting>
-FcStrList *FcConfigGetFontDirs (FcConfig *config)
- </programlisting><para>
-Returns the list of font directories in 'config'. This includes the
-configured font directories along with any directories below those in the
-filesystem.
- </para>
- <sect3><title>FcConfigGetConfigFiles</title><programlisting>
-FcStrList *FcConfigGetConfigFiles (FcConfig *config)
- </programlisting><para>
-Returns the list of known configuration files used to generate 'config'.
-Note that this will not include any configuration done with FcConfigParse.
- </para>
- <sect3><title>FcConfigGetCache</title><programlisting>
-char *FcConfigGetCache (FcConfig *config)
- </programlisting><para>
-Returns the name of the file used to store per-user font information.
- </para>
- <sect3><title>FcConfigGetFonts</title><programlisting>
-FcFontSet *FcConfigGetFonts (FcConfig *config, FcSetName set)
- </programlisting><para>
-Returns one of the two sets of fonts from the configuration as specified
-by 'set'.
- </para>
- <sect3><title>FcConfigGetBlanks</title><programlisting>
-FcBlanks *FcConfigGetBlanks (FcConfig *config)
- </programlisting><para>
-Returns the FcBlanks object associated with the given configuration, if no
-blanks were present in the configuration, this function will return 0.
- </para>
- <sect3><title>FcConfigGetRescanInverval</title><programlisting>
-int FcConfigGetRescanInverval (FcConfig *config)
- </programlisting><para>
-Returns the interval between automatic checks of the configuration (in
-seconds) specified in 'config'. The configuration is checked during
-a call to FcFontList when this interval has passed since the last check.
- </para>
- <sect3><title>FcConfigSetRescanInverval</title><programlisting>
-FcBool FcConfigSetRescanInverval (FcConfig *config, int rescanInterval)
- </programlisting><para>
-Sets the rescan interval; returns FcFalse if an error occurred.
- </para>
- <sect3><title>FcConfigAppFontAddFile</title><programlisting>
-FcBool FcConfigAppFontAddFile (FcConfig *config, const char *file)
- </programlisting><para>
-Adds an application-specific font to the configuration.
- </para>
- <sect3><title>FcConfigAppFontAddDir</title><programlisting>
-FcBool FcConfigAppFontAddDir (FcConfig *config, const char *dir)
- </programlisting><para>
-Scans the specified directory for fonts, adding each one found to the
-application-specific set of fonts.
- </para>
- <sect3><title>FcConfigAppFontClear</title><programlisting>
-void FcConfigAppFontClear (FcConfig *config)
- </programlisting><para>
-Clears the set of application-specific fonts.
- </para>
- <sect3><title>FcConfigSubstituteWithPat</title><programlisting>
-FcBool FcConfigSubstituteWithPat (FcConfig *config, FcPattern *p, FcPattern *p_pat FcMatchKind kind)
- </programlisting><para>
-Performs the sequence of pattern modification operations, if 'kind' is
-FcMatchPattern, then those tagged as pattern operations are applied, else
-if 'kind' is FcMatchFont, those tagged as font operations are applied and
-p_pat is used for <test> elements with target=pattern.
- </para>
- <sect3><title>FcConfigSubstitute</title><programlisting>
-FcBool FcConfigSubstitute (FcConfig *config, FcPattern *p, FcMatchKind kind)
- </programlisting><para>
-Calls FcConfigSubstituteWithPat setting p_pat to NULL.
- </para>
- <sect3><title>FcFontMatch</title><programlisting>
-FcPattern *FcFontMatch (FcConfig *config, FcPattern *p, FcResult *result)
- </programlisting><para>
-Returns the font in 'config' most close matching 'p'. This function
-should be called only after FcConfigSubstitute and FcDefaultSubstitute have
-been called for 'p'; otherwise the results will not be correct.
- </para>
- <sect3><title>FcFontSort</title><programlisting>
-FcFontSet *FcFontSort (FcConfig *config, FcPattern *p, FcBool trim, FcCharSet **csp, FcResult *result)
- </programlisting><para>
-Returns the list of fonts sorted by closeness to 'p'. If 'trim' is FcTrue,
-elements in the list which don't include Unicode coverage not provided by
-earlier elements in the list are elided. The union of Unicode coverage of
-all of the fonts is returned in 'csp', if 'csp' is not NULL. This function
-should be called only after FcConfigSubstitute and FcDefaultSubstitute have
-been called for 'p'; otherwise the results will not be correct.
- </para><para>
-The returned FcFontSet references FcPattern structures which may be shared
-by the return value from multiple FcFontSort calls, applications must not
-modify these patterns. Instead, they should be passed, along with 'p' to
-FcFontRenderPrepare which combines them into a complete pattern.
- </para><para>
-The FcFontSet returned by FcFontSort is destroyed by caling FcFontSetDestroy.
- </para>
- <sect3><title>FcFontRenderPrepare</title><programlisting>
-FcPattern *FcFontRenderPrepare (FcConfig *config, FcPattern *pat, FcPattern *font)
- </programlisting><para>
-Creates a new pattern consisting of elements of 'font' not appearing
-in 'pat', elements of 'pat' not appearing in 'font' and the best matching
-value from 'pat' for elements appearing in both. The result is passed to
-FcConfigSubstitute with 'kind' FcMatchFont and then returned.
- </para>
- <sect3><title>FcFontList</title><programlisting>
-FcFontSet *FcFontList (FcConfig *config, FcPattern *p, FcObjectSet *os)
- </programlisting><para>
-Selects fonts matching 'p', creates patterns from those fonts containing
-only the objects in 'os' and returns the set of unique such patterns.
- </para>
- <sect3><title>FcConfigFilename</title><programlisting>
-char *FcConfigFilename (const char *name)
- </programlisting><para>
-Given the specified external entity name, return the associated filename.
-This provides applications a way to convert various configuration file
-references into filename form.
- </para><para>
-A null or empty 'name' indicates that the default configuration file should
-be used; which file this references can be overridden with the
-FC_CONFIG_FILE environment variable. Next, if the name starts with '~', it
-refers to a file in the current users home directory. Otherwise if the name
-doesn't start with '/', it refers to a file in the default configuration
-directory; the built-in default directory can be overridden with the
-FC_CONFIG_DIR environment variable.
- </para>
- </sect2>
- <sect2><title>Initialization</title>
- <para>
-These functions provide some control over how the library is initialized.
- </para>
- <sect3><title>FcInitLoadConfig</title><programlisting>
-FcConfig *FcInitLoadConfig (void)
- </programlisting><para>
-Loads the default configuration file and returns the resulting configuration.
-Does not load any font information.
- </para>
- <sect3><title>FcInitLoadConfigAndFonts</title><programlisting>
-FcConfig *FcInitLoadConfigAndFonts (void)
- </programlisting><para>
-Loads the default configuration file and builds information about the
-available fonts. Returns the resulting configuration.
- </para>
- <sect3><title>FcInit</title><programlisting>
-FcBool FcInit (void)
- </programlisting><para>
-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.
- </para>
- <sect3><title>FcGetVersion</title><programlisting>
-int FcGetVersion (void)
- </programlisting><para>
-Returns the version number of the library.
- </para>
- <sect3><title>FcInitReinitialize</title><programlisting>
-FcBool FcInitReinitialize (void)
- </programlisting><para>
-Forces the default configuration file to be reloaded and resets the default
-configuration.
- </para>
- <sect3><title>FcInitBringUptoDate</title><programlisting>
-FcBool FcInitBringUptoDate (void)
- </programlisting><para>
-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.
- </para>