diff options
Diffstat (limited to 'doc/fontconfig-devel/x102.html')
| -rw-r--r-- | doc/fontconfig-devel/x102.html | 1474 |
1 files changed, 1474 insertions, 0 deletions
diff --git a/doc/fontconfig-devel/x102.html b/doc/fontconfig-devel/x102.html new file mode 100644 index 0000000..3f51bc3 --- /dev/null +++ b/doc/fontconfig-devel/x102.html @@ -0,0 +1,1474 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd"> +<HTML +><HEAD +><TITLE +>FUNCTIONS</TITLE +><META +NAME="GENERATOR" +CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK +REL="HOME" +HREF="index.html"><LINK +REL="PREVIOUS" +TITLE="Datatypes" +HREF="x31.html"></HEAD +><BODY +CLASS="SECT1" +BGCOLOR="#FFFFFF" +TEXT="#000000" +LINK="#0000FF" +VLINK="#840084" +ALINK="#0000FF" +><DIV +CLASS="NAVHEADER" +><TABLE +SUMMARY="Header navigation table" +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TH +COLSPAN="3" +ALIGN="center" +></TH +></TR +><TR +><TD +WIDTH="10%" +ALIGN="left" +VALIGN="bottom" +><A +HREF="x31.html" +ACCESSKEY="P" +>Prev</A +></TD +><TD +WIDTH="80%" +ALIGN="center" +VALIGN="bottom" +></TD +><TD +WIDTH="10%" +ALIGN="right" +VALIGN="bottom" +> </TD +></TR +></TABLE +><HR +ALIGN="LEFT" +WIDTH="100%"></DIV +><DIV +CLASS="SECT1" +><H1 +CLASS="SECT1" +><A +NAME="AEN102" +>4. FUNCTIONS</A +></H1 +><P +>These are grouped by functionality, often using the main data type being +manipulated. + </P +><DIV +CLASS="SECT2" +><H2 +CLASS="SECT2" +><A +NAME="AEN105" +>4.1. Initialization</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="fcinitloadconfig.html" +>FcInitLoadConfig</A +> -- load configuration</DT +><DT +><A +HREF="fcinitloadconfigandfonts.html" +>FcInitLoadConfigAndFonts</A +> -- load configuration and font data</DT +><DT +><A +HREF="fcinit.html" +>FcInit</A +> -- initialize fontconfig library</DT +><DT +><A +HREF="fcfini.html" +>FcFini</A +> -- finalize fontconfig library</DT +><DT +><A +HREF="fcgetversion.html" +>FcGetVersion</A +> -- library version number</DT +><DT +><A +HREF="fcinitreinitialize.html" +>FcInitReinitialize</A +> -- re-initialize library</DT +><DT +><A +HREF="fcinitbringuptodate.html" +>FcInitBringUptoDate</A +> -- reload configuration files if needed</DT +></DL +></DIV +><P +>These functions provide some control over how the library is initialized. + </P +></DIV +><DIV +CLASS="SECT2" +><H2 +CLASS="SECT2" +><A +NAME="AEN255" +>4.2. FcPattern</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="fcpatterncreate.html" +>FcPatternCreate</A +> -- Create a pattern</DT +><DT +><A +HREF="fcpatternduplicate.html" +>FcPatternDuplicate</A +> -- Copy a pattern</DT +><DT +><A +HREF="fcpatternreference.html" +>FcPatternReference</A +> -- Increment pattern reference count</DT +><DT +><A +HREF="fcpatterndestroy.html" +>FcPatternDestroy</A +> -- Destroy a pattern</DT +><DT +><A +HREF="fcpatternequal.html" +>FcPatternEqual</A +> -- Compare patterns</DT +><DT +><A +HREF="fcpatternequalsubset.html" +>FcPatternEqualSubset</A +> -- Compare portions of patterns</DT +><DT +><A +HREF="fcpatternfilter.html" +>FcPatternFilter</A +> -- Filter the objects of pattern</DT +><DT +><A +HREF="fcpatternhash.html" +>FcPatternHash</A +> -- Compute a pattern hash value</DT +><DT +><A +HREF="fcpatternadd.html" +>FcPatternAdd</A +> -- Add a value to a pattern</DT +><DT +><A +HREF="fcpatternaddweak.html" +>FcPatternAddWeak</A +> -- Add a value to a pattern with weak binding</DT +><DT +><A +HREF="fcpatternadd-type.html" +>FcPatternAdd-Type</A +> -- Add a typed value to a pattern</DT +><DT +><A +HREF="fcpatternget.html" +>FcPatternGet</A +> -- Return a value from a pattern</DT +><DT +><A +HREF="fcpatternget-type.html" +>FcPatternGet-Type</A +> -- Return a typed value from a pattern</DT +><DT +><A +HREF="fcpatternbuild.html" +>FcPatternBuild</A +> -- Create patterns from arguments</DT +><DT +><A +HREF="fcpatterndel.html" +>FcPatternDel</A +> -- Delete a property from a pattern</DT +><DT +><A +HREF="fcpatternremove.html" +>FcPatternRemove</A +> -- Remove one object of the specified type from the pattern</DT +><DT +><A +HREF="fcpatternprint.html" +>FcPatternPrint</A +> -- Print a pattern for debugging</DT +><DT +><A +HREF="fcdefaultsubstitute.html" +>FcDefaultSubstitute</A +> -- Perform default substitutions in a pattern</DT +><DT +><A +HREF="fcnameparse.html" +>FcNameParse</A +> -- Parse a pattern string</DT +><DT +><A +HREF="fcnameunparse.html" +>FcNameUnparse</A +> -- Convert a pattern back into a string that can be parsed</DT +><DT +><A +HREF="fcpatternformat.html" +>FcPatternFormat</A +> -- Format a pattern into a string according to a format specifier</DT +></DL +></DIV +><P +>An FcPattern is an opaque type that holds both patterns to match against the +available fonts, as well as the information about each font. + </P +></DIV +><DIV +CLASS="SECT2" +><H2 +CLASS="SECT2" +><A +NAME="AEN1056" +>4.3. FcFontSet</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="fcfontsetcreate.html" +>FcFontSetCreate</A +> -- Create a font set</DT +><DT +><A +HREF="fcfontsetdestroy.html" +>FcFontSetDestroy</A +> -- Destroy a font set</DT +><DT +><A +HREF="fcfontsetadd.html" +>FcFontSetAdd</A +> -- Add to a font set</DT +><DT +><A +HREF="fcfontsetlist.html" +>FcFontSetList</A +> -- List fonts from a set of font sets</DT +><DT +><A +HREF="fcfontsetmatch.html" +>FcFontSetMatch</A +> -- Return the best font from a set of font sets</DT +><DT +><A +HREF="fcfontsetprint.html" +>FcFontSetPrint</A +> -- Print a set of patterns to stdout</DT +><DT +><A +HREF="fcfontsetsort.html" +>FcFontSetSort</A +> -- Add to a font set</DT +><DT +><A +HREF="fcfontsetsortdestroy.html" +>FcFontSetSortDestroy</A +> -- DEPRECATED destroy a font set</DT +></DL +></DIV +><P +>An FcFontSet simply holds a list of patterns; these are used to return the +results of listing available fonts. + </P +></DIV +><DIV +CLASS="SECT2" +><H2 +CLASS="SECT2" +><A +NAME="AEN1283" +>4.4. FcObjectSet</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="fcobjectsetcreate.html" +>FcObjectSetCreate</A +> -- Create an object set</DT +><DT +><A +HREF="fcobjectsetadd.html" +>FcObjectSetAdd</A +> -- Add to an object set</DT +><DT +><A +HREF="fcobjectsetdestroy.html" +>FcObjectSetDestroy</A +> -- Destroy an object set</DT +><DT +><A +HREF="fcobjectsetbuild.html" +>FcObjectSetBuild</A +> -- Build object set from args</DT +></DL +></DIV +><P +>An FcObjectSet holds a list of pattern property names; it is used to +indicate which properties are to be returned in the patterns from +FcFontList. + </P +></DIV +><DIV +CLASS="SECT2" +><H2 +CLASS="SECT2" +><A +NAME="AEN1393" +>4.5. FreeType specific functions</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="fcfreetypecharindex.html" +>FcFreeTypeCharIndex</A +> -- map Unicode to glyph id</DT +><DT +><A +HREF="fcfreetypecharset.html" +>FcFreeTypeCharSet</A +> -- compute Unicode coverage</DT +><DT +><A +HREF="fcfreetypecharsetandspacing.html" +>FcFreeTypeCharSetAndSpacing</A +> -- compute Unicode coverage and spacing type</DT +><DT +><A +HREF="fcfreetypequery.html" +>FcFreeTypeQuery</A +> -- compute pattern from font file (and index)</DT +><DT +><A +HREF="fcfreetypequeryface.html" +>FcFreeTypeQueryFace</A +> -- compute pattern from FT_Face</DT +></DL +></DIV +><P +>While the fontconfig library doesn't insist that FreeType be used as the +rasterization mechanism for fonts, it does provide some convenience +functions. + </P +></DIV +><DIV +CLASS="SECT2" +><H2 +CLASS="SECT2" +><A +NAME="AEN1522" +>4.6. FcValue</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="fcvaluedestroy.html" +>FcValueDestroy</A +> -- Free a value</DT +><DT +><A +HREF="fcvaluesave.html" +>FcValueSave</A +> -- Copy a value</DT +><DT +><A +HREF="fcvalueprint.html" +>FcValuePrint</A +> -- Print a value to stdout</DT +><DT +><A +HREF="fcvalueequal.html" +>FcValueEqual</A +> -- Test two values for equality</DT +></DL +></DIV +><P +>FcValue is a structure containing a type tag and a union of all possible +datatypes. The tag is an enum of type +<SPAN +CLASS="emphasis" +><I +CLASS="EMPHASIS" +>FcType</I +></SPAN +> +and is intended to provide a measure of run-time +typechecking, although that depends on careful programming. + </P +></DIV +><DIV +CLASS="SECT2" +><H2 +CLASS="SECT2" +><A +NAME="AEN1616" +>4.7. FcCharSet</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="fccharsetcreate.html" +>FcCharSetCreate</A +> -- Create an empty character set</DT +><DT +><A +HREF="fccharsetdestroy.html" +>FcCharSetDestroy</A +> -- Destroy a character set</DT +><DT +><A +HREF="fccharsetaddchar.html" +>FcCharSetAddChar</A +> -- Add a character to a charset</DT +><DT +><A +HREF="fccharsetdelchar.html" +>FcCharSetDelChar</A +> -- Add a character to a charset</DT +><DT +><A +HREF="fccharsetcopy.html" +>FcCharSetCopy</A +> -- Copy a charset</DT +><DT +><A +HREF="fccharsetequal.html" +>FcCharSetEqual</A +> -- Compare two charsets</DT +><DT +><A +HREF="fccharsetintersect.html" +>FcCharSetIntersect</A +> -- Intersect charsets</DT +><DT +><A +HREF="fccharsetunion.html" +>FcCharSetUnion</A +> -- Add charsets</DT +><DT +><A +HREF="fccharsetsubtract.html" +>FcCharSetSubtract</A +> -- Subtract charsets</DT +><DT +><A +HREF="fccharsetmerge.html" +>FcCharSetMerge</A +> -- Merge charsets</DT +><DT +><A +HREF="fccharsethaschar.html" +>FcCharSetHasChar</A +> -- Check a charset for a char</DT +><DT +><A +HREF="fccharsetcount.html" +>FcCharSetCount</A +> -- Count entries in a charset</DT +><DT +><A +HREF="fccharsetintersectcount.html" +>FcCharSetIntersectCount</A +> -- Intersect and count charsets</DT +><DT +><A +HREF="fccharsetsubtractcount.html" +>FcCharSetSubtractCount</A +> -- Subtract and count charsets</DT +><DT +><A +HREF="fccharsetissubset.html" +>FcCharSetIsSubset</A +> -- Test for charset inclusion</DT +><DT +><A +HREF="fccharsetfirstpage.html" +>FcCharSetFirstPage</A +> -- Start enumerating charset contents</DT +><DT +><A +HREF="fccharsetnextpage.html" +>FcCharSetNextPage</A +> -- Continue enumerating charset contents</DT +><DT +><A +HREF="fccharsetcoverage.html" +>FcCharSetCoverage</A +> -- DEPRECATED return coverage for a Unicode page</DT +><DT +><A +HREF="fccharsetnew.html" +>FcCharSetNew</A +> -- DEPRECATED alias for FcCharSetCreate</DT +></DL +></DIV +><P +>An FcCharSet is a boolean array indicating a set of Unicode chars. Those +associated with a font are marked constant and cannot be edited. +FcCharSets may be reference counted internally to reduce memory consumption; +this may be visible to applications as the result of FcCharSetCopy may +return it's argument, and that CharSet may remain unmodifiable. + </P +></DIV +><DIV +CLASS="SECT2" +><H2 +CLASS="SECT2" +><A +NAME="AEN2094" +>4.8. FcLangSet</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="fclangsetcreate.html" +>FcLangSetCreate</A +> -- create a langset object</DT +><DT +><A +HREF="fclangsetdestroy.html" +>FcLangSetDestroy</A +> -- destroy a langset object</DT +><DT +><A +HREF="fclangsetcopy.html" +>FcLangSetCopy</A +> -- copy a langset object</DT +><DT +><A +HREF="fclangsetadd.html" +>FcLangSetAdd</A +> -- add a language to a langset</DT +><DT +><A +HREF="fclangsetdel.html" +>FcLangSetDel</A +> -- delete a language from a langset</DT +><DT +><A +HREF="fclangsetunion.html" +>FcLangSetUnion</A +> -- Add langsets</DT +><DT +><A +HREF="fclangsetsubtract.html" +>FcLangSetSubtract</A +> -- Subtract langsets</DT +><DT +><A +HREF="fclangsetcompare.html" +>FcLangSetCompare</A +> -- compare language sets</DT +><DT +><A +HREF="fclangsetcontains.html" +>FcLangSetContains</A +> -- check langset subset relation</DT +><DT +><A +HREF="fclangsetequal.html" +>FcLangSetEqual</A +> -- test for matching langsets</DT +><DT +><A +HREF="fclangsethash.html" +>FcLangSetHash</A +> -- return a hash value for a langset</DT +><DT +><A +HREF="fclangsethaslang.html" +>FcLangSetHasLang</A +> -- test langset for language support</DT +><DT +><A +HREF="fclangsetgetlangs.html" +>FcLangSetGetLangs</A +> -- get the list of languages in the langset</DT +><DT +><A +HREF="fcgetlangs.html" +>FcGetLangs</A +> -- Get list of languages</DT +><DT +><A +HREF="fclanggetcharset.html" +>FcLangGetCharSet</A +> -- Get character map for a language</DT +></DL +></DIV +><P +>An FcLangSet is a set of language names (each of which include language and +an optional territory). They are used when selecting fonts to indicate which +languages the fonts need to support. Each font is marked, using language +orthography information built into fontconfig, with the set of supported +languages. + </P +></DIV +><DIV +CLASS="SECT2" +><H2 +CLASS="SECT2" +><A +NAME="AEN2464" +>4.9. FcMatrix</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="fcmatrixinit.html" +>FcMatrixInit</A +> -- initialize an FcMatrix structure</DT +><DT +><A +HREF="fcmatrixcopy.html" +>FcMatrixCopy</A +> -- Copy a matrix</DT +><DT +><A +HREF="fcmatrixequal.html" +>FcMatrixEqual</A +> -- Compare two matrices</DT +><DT +><A +HREF="fcmatrixmultiply.html" +>FcMatrixMultiply</A +> -- Multiply matrices</DT +><DT +><A +HREF="fcmatrixrotate.html" +>FcMatrixRotate</A +> -- Rotate a matrix</DT +><DT +><A +HREF="fcmatrixscale.html" +>FcMatrixScale</A +> -- Scale a matrix</DT +><DT +><A +HREF="fcmatrixshear.html" +>FcMatrixShear</A +> -- Shear a matrix</DT +></DL +></DIV +><P +>FcMatrix structures hold an affine transformation in matrix form. + </P +></DIV +><DIV +CLASS="SECT2" +><H2 +CLASS="SECT2" +><A +NAME="AEN2658" +>4.10. FcConfig</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="fcconfigcreate.html" +>FcConfigCreate</A +> -- Create a configuration</DT +><DT +><A +HREF="fcconfigreference.html" +>FcConfigReference</A +> -- Increment config reference count</DT +><DT +><A +HREF="fcconfigdestroy.html" +>FcConfigDestroy</A +> -- Destroy a configuration</DT +><DT +><A +HREF="fcconfigsetcurrent.html" +>FcConfigSetCurrent</A +> -- Set configuration as default</DT +><DT +><A +HREF="fcconfiggetcurrent.html" +>FcConfigGetCurrent</A +> -- Return current configuration</DT +><DT +><A +HREF="fcconfiguptodate.html" +>FcConfigUptoDate</A +> -- Check timestamps on config files</DT +><DT +><A +HREF="fcconfighome.html" +>FcConfigHome</A +> -- return the current home directory.</DT +><DT +><A +HREF="fcconfigenablehome.html" +>FcConfigEnableHome</A +> -- controls use of the home directory.</DT +><DT +><A +HREF="fcconfigbuildfonts.html" +>FcConfigBuildFonts</A +> -- Build font database</DT +><DT +><A +HREF="fcconfiggetconfigdirs.html" +>FcConfigGetConfigDirs</A +> -- Get config directories</DT +><DT +><A +HREF="fcconfiggetfontdirs.html" +>FcConfigGetFontDirs</A +> -- Get font directories</DT +><DT +><A +HREF="fcconfiggetconfigfiles.html" +>FcConfigGetConfigFiles</A +> -- Get config files</DT +><DT +><A +HREF="fcconfiggetcache.html" +>FcConfigGetCache</A +> -- DEPRECATED used to return per-user cache filename</DT +><DT +><A +HREF="fcconfiggetcachedirs.html" +>FcConfigGetCacheDirs</A +> -- return the list of directories searched for cache files</DT +><DT +><A +HREF="fcconfiggetfonts.html" +>FcConfigGetFonts</A +> -- Get config font set</DT +><DT +><A +HREF="fcconfiggetblanks.html" +>FcConfigGetBlanks</A +> -- Get config blanks</DT +><DT +><A +HREF="fcconfiggetrescaninterval.html" +>FcConfigGetRescanInterval</A +> -- Get config rescan interval</DT +><DT +><A +HREF="fcconfigsetrescaninterval.html" +>FcConfigSetRescanInterval</A +> -- Set config rescan interval</DT +><DT +><A +HREF="fcconfigappfontaddfile.html" +>FcConfigAppFontAddFile</A +> -- Add font file to font database</DT +><DT +><A +HREF="fcconfigappfontadddir.html" +>FcConfigAppFontAddDir</A +> -- Add fonts from directory to font database</DT +><DT +><A +HREF="fcconfigappfontclear.html" +>FcConfigAppFontClear</A +> -- Remove all app fonts from font database</DT +><DT +><A +HREF="fcconfigsubstitutewithpat.html" +>FcConfigSubstituteWithPat</A +> -- Execute substitutions</DT +><DT +><A +HREF="fcconfigsubstitute.html" +>FcConfigSubstitute</A +> -- Execute substitutions</DT +><DT +><A +HREF="fcfontmatch.html" +>FcFontMatch</A +> -- Return best font</DT +><DT +><A +HREF="fcfontsort.html" +>FcFontSort</A +> -- Return list of matching fonts</DT +><DT +><A +HREF="fcfontrenderprepare.html" +>FcFontRenderPrepare</A +> -- Prepare pattern for loading font file</DT +><DT +><A +HREF="fcfontlist.html" +>FcFontList</A +> -- List fonts</DT +><DT +><A +HREF="fcconfigfilename.html" +>FcConfigFilename</A +> -- Find a config file</DT +><DT +><A +HREF="fcconfigparseandload.html" +>FcConfigParseAndLoad</A +> -- load a configuration file</DT +></DL +></DIV +><P +>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. + </P +></DIV +><DIV +CLASS="SECT2" +><H2 +CLASS="SECT2" +><A +NAME="AEN3371" +>4.11. FcObjectType</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="fcnameregisterobjecttypes.html" +>FcNameRegisterObjectTypes</A +> -- Register object types</DT +><DT +><A +HREF="fcnameunregisterobjecttypes.html" +>FcNameUnregisterObjectTypes</A +> -- Unregister object types</DT +><DT +><A +HREF="fcnamegetobjecttype.html" +>FcNameGetObjectType</A +> -- Lookup an object type</DT +></DL +></DIV +><P +>Provides for application-specified font name object types so that new +pattern elements can be generated from font names. + </P +></DIV +><DIV +CLASS="SECT2" +><H2 +CLASS="SECT2" +><A +NAME="AEN3444" +>4.12. FcConstant</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="fcnameregisterconstants.html" +>FcNameRegisterConstants</A +> -- Register symbolic constants</DT +><DT +><A +HREF="fcnameunregisterconstants.html" +>FcNameUnregisterConstants</A +> -- Unregister symbolic constants</DT +><DT +><A +HREF="fcnamegetconstant.html" +>FcNameGetConstant</A +> -- Lookup symbolic constant</DT +><DT +><A +HREF="fcnameconstant.html" +>FcNameConstant</A +> -- Get the value for a symbolic constant</DT +></DL +></DIV +><P +>Provides for application-specified symbolic constants for font names. + </P +></DIV +><DIV +CLASS="SECT2" +><H2 +CLASS="SECT2" +><A +NAME="AEN3542" +>4.13. FcBlanks</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="fcblankscreate.html" +>FcBlanksCreate</A +> -- Create an FcBlanks</DT +><DT +><A +HREF="fcblanksdestroy.html" +>FcBlanksDestroy</A +> -- Destroy and FcBlanks</DT +><DT +><A +HREF="fcblanksadd.html" +>FcBlanksAdd</A +> -- Add a character to an FcBlanks</DT +><DT +><A +HREF="fcblanksismember.html" +>FcBlanksIsMember</A +> -- Query membership in an FcBlanks</DT +></DL +></DIV +><P +>An FcBlanks object holds a list of Unicode chars which are expected to +be blank when drawn. When scanning new fonts, any glyphs which are +empty and not in this list will be assumed to be broken and not placed in +the FcCharSet associated with the font. This provides a significantly more +accurate CharSet for applications. + </P +></DIV +><DIV +CLASS="SECT2" +><H2 +CLASS="SECT2" +><A +NAME="AEN3633" +>4.14. FcAtomic</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="fcatomiccreate.html" +>FcAtomicCreate</A +> -- create an FcAtomic object</DT +><DT +><A +HREF="fcatomiclock.html" +>FcAtomicLock</A +> -- lock a file</DT +><DT +><A +HREF="fcatomicnewfile.html" +>FcAtomicNewFile</A +> -- return new temporary file name</DT +><DT +><A +HREF="fcatomicorigfile.html" +>FcAtomicOrigFile</A +> -- return original file name</DT +><DT +><A +HREF="fcatomicreplaceorig.html" +>FcAtomicReplaceOrig</A +> -- replace original with new</DT +><DT +><A +HREF="fcatomicdeletenew.html" +>FcAtomicDeleteNew</A +> -- delete new file</DT +><DT +><A +HREF="fcatomicunlock.html" +>FcAtomicUnlock</A +> -- unlock a file</DT +><DT +><A +HREF="fcatomicdestroy.html" +>FcAtomicDestroy</A +> -- destroy an FcAtomic object</DT +></DL +></DIV +><P +>These functions provide a safe way to update configuration files, allowing ongoing +reading of the old configuration file while locked for writing and ensuring that a +consistent and complete version of the configuration file is always available. + </P +></DIV +><DIV +CLASS="SECT2" +><H2 +CLASS="SECT2" +><A +NAME="AEN3810" +>4.15. File and Directory routines</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="fcfilescan.html" +>FcFileScan</A +> -- scan a font file</DT +><DT +><A +HREF="fcfileisdir.html" +>FcFileIsDir</A +> -- check whether a file is a directory</DT +><DT +><A +HREF="fcdirscan.html" +>FcDirScan</A +> -- scan a font directory without caching it</DT +><DT +><A +HREF="fcdirsave.html" +>FcDirSave</A +> -- DEPRECATED: formerly used to save a directory cache</DT +><DT +><A +HREF="fcdircacheunlink.html" +>FcDirCacheUnlink</A +> -- Remove all caches related to <CODE +CLASS="PARAMETER" +>dir</CODE +></DT +><DT +><A +HREF="fcdircachevalid.html" +>FcDirCacheValid</A +> -- check directory cache</DT +><DT +><A +HREF="fcdircacheload.html" +>FcDirCacheLoad</A +> -- load a directory cache</DT +><DT +><A +HREF="fcdircacheread.html" +>FcDirCacheRead</A +> -- read or construct a directory cache</DT +><DT +><A +HREF="fcdircacheloadfile.html" +>FcDirCacheLoadFile</A +> -- load a cache file</DT +><DT +><A +HREF="fcdircacheunload.html" +>FcDirCacheUnload</A +> -- unload a cache file</DT +></DL +></DIV +><P +>These routines work with font files and directories, including font +directory cache files. + </P +></DIV +><DIV +CLASS="SECT2" +><H2 +CLASS="SECT2" +><A +NAME="AEN4083" +>4.16. FcCache routines</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="fccachedir.html" +>FcCacheDir</A +> -- Return directory of <CODE +CLASS="PARAMETER" +>cache</CODE +></DT +><DT +><A +HREF="fccachecopyset.html" +>FcCacheCopySet</A +> -- Returns a copy of the fontset from <CODE +CLASS="PARAMETER" +>cache</CODE +></DT +><DT +><A +HREF="fccachesubdir.html" +>FcCacheSubdir</A +> -- Return the <CODE +CLASS="PARAMETER" +>i</CODE +>'th subdirectory.</DT +><DT +><A +HREF="fccachenumsubdir.html" +>FcCacheNumSubdir</A +> -- Return the number of subdirectories in <CODE +CLASS="PARAMETER" +>cache</CODE +>.</DT +><DT +><A +HREF="fccachenumfont.html" +>FcCacheNumFont</A +> -- Returns the number of fonts in <CODE +CLASS="PARAMETER" +>cache</CODE +>.</DT +></DL +></DIV +><P +>These routines work with font directory caches, accessing their contents in +limited ways. It is not expected that normal applications will need to use +these functions. + </P +></DIV +><DIV +CLASS="SECT2" +><H2 +CLASS="SECT2" +><A +NAME="AEN4202" +>4.17. FcStrSet and FcStrList</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="fcstrsetcreate.html" +>FcStrSetCreate</A +> -- create a string set</DT +><DT +><A +HREF="fcstrsetmember.html" +>FcStrSetMember</A +> -- check set for membership</DT +><DT +><A +HREF="fcstrsetequal.html" +>FcStrSetEqual</A +> -- check sets for equality</DT +><DT +><A +HREF="fcstrsetadd.html" +>FcStrSetAdd</A +> -- add to a string set</DT +><DT +><A +HREF="fcstrsetaddfilename.html" +>FcStrSetAddFilename</A +> -- add a filename to a string set</DT +><DT +><A +HREF="fcstrsetdel.html" +>FcStrSetDel</A +> -- delete from a string set</DT +><DT +><A +HREF="fcstrsetdestroy.html" +>FcStrSetDestroy</A +> -- destroy a string set</DT +><DT +><A +HREF="fcstrlistcreate.html" +>FcStrListCreate</A +> -- create a string iterator</DT +><DT +><A +HREF="fcstrlistnext.html" +>FcStrListNext</A +> -- get next string in iteration</DT +><DT +><A +HREF="fcstrlistdone.html" +>FcStrListDone</A +> -- destroy a string iterator</DT +></DL +></DIV +><P +>A data structure for enumerating strings, used to list directories while +scanning the configuration as directories are added while scanning. + </P +></DIV +><DIV +CLASS="SECT2" +><H2 +CLASS="SECT2" +><A +NAME="AEN4440" +>4.18. String utilities</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="fcutf8toucs4.html" +>FcUtf8ToUcs4</A +> -- convert UTF-8 to UCS4</DT +><DT +><A +HREF="fcucs4toutf8.html" +>FcUcs4ToUtf8</A +> -- convert UCS4 to UTF-8</DT +><DT +><A +HREF="fcutf8len.html" +>FcUtf8Len</A +> -- count UTF-8 encoded chars</DT +><DT +><A +HREF="fcutf16toucs4.html" +>FcUtf16ToUcs4</A +> -- convert UTF-16 to UCS4</DT +><DT +><A +HREF="fcutf16len.html" +>FcUtf16Len</A +> -- count UTF-16 encoded chars</DT +><DT +><A +HREF="fcislower.html" +>FcIsLower</A +> -- check for lower case ASCII character</DT +><DT +><A +HREF="fcisupper.html" +>FcIsUpper</A +> -- check for upper case ASCII character</DT +><DT +><A +HREF="fctolower.html" +>FcToLower</A +> -- convert upper case ASCII to lower case</DT +><DT +><A +HREF="fcstrcopy.html" +>FcStrCopy</A +> -- duplicate a string</DT +><DT +><A +HREF="fcstrdowncase.html" +>FcStrDowncase</A +> -- create a lower case translation of a string</DT +><DT +><A +HREF="fcstrcopyfilename.html" +>FcStrCopyFilename</A +> -- create a complete path from a filename</DT +><DT +><A +HREF="fcstrcmp.html" +>FcStrCmp</A +> -- compare UTF-8 strings</DT +><DT +><A +HREF="fcstrcmpignorecase.html" +>FcStrCmpIgnoreCase</A +> -- compare UTF-8 strings ignoring case</DT +><DT +><A +HREF="fcstrstr.html" +>FcStrStr</A +> -- locate UTF-8 substring</DT +><DT +><A +HREF="fcstrstrignorecase.html" +>FcStrStrIgnoreCase</A +> -- locate UTF-8 substring ignoring ASCII case</DT +><DT +><A +HREF="fcstrplus.html" +>FcStrPlus</A +> -- concatenate two strings</DT +><DT +><A +HREF="fcstrfree.html" +>FcStrFree</A +> -- free a string</DT +><DT +><A +HREF="fcstrdirname.html" +>FcStrDirname</A +> -- directory part of filename</DT +><DT +><A +HREF="fcstrbasename.html" +>FcStrBasename</A +> -- last component of filename</DT +></DL +></DIV +><P +>Fontconfig manipulates many UTF-8 strings represented with the FcChar8 type. +These functions are exposed to help applications deal with these UTF-8 +strings in a locale-insensitive manner. + </P +></DIV +></DIV +><DIV +CLASS="NAVFOOTER" +><HR +ALIGN="LEFT" +WIDTH="100%"><TABLE +SUMMARY="Footer navigation table" +WIDTH="100%" +BORDER="0" +CELLPADDING="0" +CELLSPACING="0" +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +><A +HREF="x31.html" +ACCESSKEY="P" +>Prev</A +></TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +><A +HREF="index.html" +ACCESSKEY="H" +>Home</A +></TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +> </TD +></TR +><TR +><TD +WIDTH="33%" +ALIGN="left" +VALIGN="top" +>Datatypes</TD +><TD +WIDTH="34%" +ALIGN="center" +VALIGN="top" +> </TD +><TD +WIDTH="33%" +ALIGN="right" +VALIGN="top" +> </TD +></TR +></TABLE +></DIV +></BODY +></HTML +>
\ No newline at end of file |