diff options
Diffstat (limited to 'nx-X11/extras/fontconfig/doc/fontconfig-devel/x93.html')
| -rw-r--r-- | nx-X11/extras/fontconfig/doc/fontconfig-devel/x93.html | 1138 |
1 files changed, 1138 insertions, 0 deletions
diff --git a/nx-X11/extras/fontconfig/doc/fontconfig-devel/x93.html b/nx-X11/extras/fontconfig/doc/fontconfig-devel/x93.html new file mode 100644 index 000000000..8f3ed8395 --- /dev/null +++ b/nx-X11/extras/fontconfig/doc/fontconfig-devel/x93.html @@ -0,0 +1,1138 @@ +<!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="AEN93" +>4. FUNCTIONS</A +></H1 +><P +>These are grouped by functionality, often using the main datatype being +manipulated. + </P +><DIV +CLASS="SECT2" +><H2 +CLASS="SECT2" +><A +NAME="AEN96" +>4.1. Initialization</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="r99.html" +>FcInitLoadConfig</A +> -- load configuration</DT +><DT +><A +HREF="r120.html" +>FcInitLoadConfigAndFonts</A +> -- load configuration and font data</DT +><DT +><A +HREF="r141.html" +>FcInit</A +> -- initialize fontconfig library</DT +><DT +><A +HREF="r162.html" +>FcFini</A +> -- finalize fonconfig library</DT +><DT +><A +HREF="r183.html" +>FcGetVersion</A +> -- library version number</DT +><DT +><A +HREF="r204.html" +>FcInitReinitialize</A +> -- re-initialize library</DT +><DT +><A +HREF="r225.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="AEN246" +>4.2. FcPattern</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="r249.html" +>FcPatternCreate</A +> -- Create a pattern</DT +><DT +><A +HREF="r270.html" +>FcPatternDestroy</A +> -- Destroy a pattern</DT +><DT +><A +HREF="r291.html" +>FcPatternEqual</A +> -- Compare patterns</DT +><DT +><A +HREF="r316.html" +>FcPatternEqualSubset</A +> -- Compare portions of patterns</DT +><DT +><A +HREF="r344.html" +>FcPatternHash</A +> -- Compute a pattern hash value</DT +><DT +><A +HREF="r365.html" +>FcPatternAdd</A +> -- Add a value to a pattern</DT +><DT +><A +HREF="r393.html" +>FcPatternAddWeak</A +> -- Add a value to a pattern with weak binding</DT +><DT +><A +HREF="r422.html" +>FcPatternAdd-Type</A +> -- Add a typed value to a pattern</DT +><DT +><A +HREF="r497.html" +>FcPatternGet</A +> -- Return a value from a pattern</DT +><DT +><A +HREF="r527.html" +>FcPatternGet-Type</A +> -- Return a typed value from a pattern</DT +><DT +><A +HREF="r614.html" +>FcPatternBuild</A +> -- Create patterns from arguments</DT +><DT +><A +HREF="r655.html" +>FcPatternDel</A +> -- Delete a property from a pattern</DT +><DT +><A +HREF="r678.html" +>FcPatternRemove</A +> -- Remove one object of the specified type from the pattern</DT +><DT +><A +HREF="r703.html" +>FcPatternPrint</A +> -- Print a pattern for debugging</DT +><DT +><A +HREF="r724.html" +>FcDefaultSubstitute</A +> -- Perform default substitutions in a pattern</DT +><DT +><A +HREF="r752.html" +>FcNameParse</A +> -- Parse a pattern string</DT +><DT +><A +HREF="r774.html" +>FcNameUnparse</A +> -- Convert a pattern back into a string that can be parsed</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="AEN795" +>4.3. FcFontSet</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="r798.html" +>FcFontSetCreate</A +> -- Create a font set</DT +><DT +><A +HREF="r819.html" +>FcFontSetDestroy</A +> -- Destroy a font set</DT +><DT +><A +HREF="r840.html" +>FcFontSetAdd</A +> -- Add to 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="AEN863" +>4.4. FcObjectSet</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="r866.html" +>FcObjectSetCreate</A +> -- Create an object set</DT +><DT +><A +HREF="r887.html" +>FcObjectSetAdd</A +> -- Add to an object set</DT +><DT +><A +HREF="r910.html" +>FcObjectSetDestroy</A +> -- Destroy an object set</DT +><DT +><A +HREF="r931.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 +indiciate which properties are to be returned in the patterns from +FcFontList. + </P +></DIV +><DIV +CLASS="SECT2" +><H2 +CLASS="SECT2" +><A +NAME="AEN962" +>4.5. FreeType specific functions</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="r965.html" +>FcFreeTypeCharIndex</A +> -- map Unicode to glyph id</DT +><DT +><A +HREF="r988.html" +>FcFreeTypeCharSet</A +> -- compute unicode coverage</DT +><DT +><A +HREF="r1011.html" +>FcFreeTypeQuery</A +> -- compute font file pattern</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="AEN1038" +>4.6. FcValue</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="r1042.html" +>FcValueDestroy</A +> -- Free a value</DT +><DT +><A +HREF="r1064.html" +>FcValueSave</A +> -- Copy a value</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="AEN1087" +>4.7. FcCharSet</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="r1090.html" +>FcCharSetCreate</A +> -- Create an empty character set</DT +><DT +><A +HREF="r1112.html" +>FcCharSetDestroy</A +> -- Destroy a character set</DT +><DT +><A +HREF="r1135.html" +>FcCharSetAddChar</A +> -- Add a character to a charset</DT +><DT +><A +HREF="r1159.html" +>FcCharSetCopy</A +> -- Copy a charset</DT +><DT +><A +HREF="r1182.html" +>FcCharSetEqual</A +> -- Compare two charsets</DT +><DT +><A +HREF="r1207.html" +>FcCharSetIntersect</A +> -- Intersect charsets</DT +><DT +><A +HREF="r1232.html" +>FcCharSetUnion</A +> -- Add charsets</DT +><DT +><A +HREF="r1257.html" +>FcCharSetSubtract</A +> -- Subtract charsets</DT +><DT +><A +HREF="r1282.html" +>FcCharSetHasChar</A +> -- Check a charset for a char</DT +><DT +><A +HREF="r1307.html" +>FcCharSetCount</A +> -- Count entries in a charset</DT +><DT +><A +HREF="r1329.html" +>FcCharSetIntersectCount</A +> -- Intersect and count charsets</DT +><DT +><A +HREF="r1354.html" +>FcCharSetSubtractCount</A +> -- Subtract and count charsets</DT +><DT +><A +HREF="r1379.html" +>FcCharSetIsSubset</A +> -- Test for charset inclusion</DT +><DT +><A +HREF="r1404.html" +>FcCharSetFirstPage</A +> -- Start enumerating charset contents</DT +><DT +><A +HREF="r1431.html" +>FcCharSetNextPage</A +> -- Continue enumerating charset contents</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="AEN1459" +>4.8. FcMatrix</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="r1462.html" +>FcMatrixInit</A +> -- initialize an FcMatrix structure</DT +><DT +><A +HREF="r1485.html" +>FcMatrixCopy</A +> -- Copy a matrix</DT +><DT +><A +HREF="r1508.html" +>FcMatrixEqual</A +> -- Compare two matrices</DT +><DT +><A +HREF="r1534.html" +>FcMatrixMultiply</A +> -- Multiply matrices</DT +><DT +><A +HREF="r1563.html" +>FcMatrixRotate</A +> -- Rotate a matrix</DT +><DT +><A +HREF="r1593.html" +>FcMatrixScale</A +> -- Scale a matrix</DT +><DT +><A +HREF="r1623.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="AEN1653" +>4.9. FcConfig</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="r1656.html" +>FcConfigCreate</A +> -- Create a configuration</DT +><DT +><A +HREF="r1677.html" +>FcConfigDestroy</A +> -- Destroy a configuration</DT +><DT +><A +HREF="r1698.html" +>FcConfigSetCurrent</A +> -- Set configuration as default</DT +><DT +><A +HREF="r1720.html" +>FcConfigGetCurrent</A +> -- Return current configuration</DT +><DT +><A +HREF="r1741.html" +>FcConfigUptoDate</A +> -- Check timestamps on config files</DT +><DT +><A +HREF="r1763.html" +>FcConfigBuildFonts</A +> -- Build font database</DT +><DT +><A +HREF="r1784.html" +>FcConfigGetConfigDirs</A +> -- Get config directories</DT +><DT +><A +HREF="r1806.html" +>FcConfigGetFontDirs</A +> -- Get font directories</DT +><DT +><A +HREF="r1828.html" +>FcConfigGetConfigFiles</A +> -- Get config files</DT +><DT +><A +HREF="r1850.html" +>FcConfigGetCache</A +> -- Get cache filename</DT +><DT +><A +HREF="r1871.html" +>FcConfigGetFonts</A +> -- Get config font set</DT +><DT +><A +HREF="r1895.html" +>FcConfigGetBlanks</A +> -- Get config blanks</DT +><DT +><A +HREF="r1916.html" +>FcConfigGetRescanInverval</A +> -- Get config rescan interval</DT +><DT +><A +HREF="r1938.html" +>FcConfigSetRescanInverval</A +> -- Set config rescan interval</DT +><DT +><A +HREF="r1961.html" +>FcConfigAppFontAddFile</A +> -- Add font file to font database</DT +><DT +><A +HREF="r1984.html" +>FcConfigAppFontAddDir</A +> -- Add fonts from directory to font database</DT +><DT +><A +HREF="r2007.html" +>FcConfigAppFontClear</A +> -- Remove all app fonts from font database</DT +><DT +><A +HREF="r2028.html" +>FcConfigSubstituteWithPat</A +> -- Execute substitutions</DT +><DT +><A +HREF="r2057.html" +>FcConfigSubstitute</A +> -- Execute substitutions</DT +><DT +><A +HREF="r2082.html" +>FcFontMatch</A +> -- Return best font</DT +><DT +><A +HREF="r2110.html" +>FcFontSort</A +> -- Return list of matching fonts</DT +><DT +><A +HREF="r2147.html" +>FcFontRenderPrepare</A +> -- Prepare pattern for loading font file</DT +><DT +><A +HREF="r2178.html" +>FcFontList</A +> -- List fonts</DT +><DT +><A +HREF="r2205.html" +>FcConfigFilename</A +> -- Find a config file</DT +><DT +><A +HREF="r2229.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="AEN2252" +>4.10. FcObjectType</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="r2255.html" +>FcNameRegisterObjectTypes</A +> -- Register object types</DT +><DT +><A +HREF="r2279.html" +>FcNameUnregisterObjectTypes</A +> -- Unregister object types</DT +><DT +><A +HREF="r2303.html" +>FcNameGetObjectType</A +> -- Lookup an object type</DT +></DL +></DIV +><P +>Provides for applcation-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="AEN2325" +>4.11. FcConstant</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="r2328.html" +>FcNameRegisterConstants</A +> -- Register symbolic constants</DT +><DT +><A +HREF="r2352.html" +>FcNameUnregisterConstants</A +> -- Unregister symbolic constants</DT +><DT +><A +HREF="r2376.html" +>FcNameGetConstant</A +> -- Lookup symbolic constant</DT +><DT +><A +HREF="r2398.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="AEN2423" +>4.12. FcBlanks</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="r2426.html" +>FcBlanksCreate</A +> -- Create an FcBlanks</DT +><DT +><A +HREF="r2447.html" +>FcBlanksDestroy</A +> -- Destroy and FcBlanks</DT +><DT +><A +HREF="r2468.html" +>FcBlanksAdd</A +> -- Add a character to an FcBlanks</DT +><DT +><A +HREF="r2491.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="AEN2514" +>4.13. FcAtomic</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="r2517.html" +>FcAtomicCreate</A +> -- create an FcAtomic object</DT +><DT +><A +HREF="r2539.html" +>FcAtomicLock</A +> -- lock a file</DT +><DT +><A +HREF="r2561.html" +>FcAtomicNewFile</A +> -- return new temporary file name</DT +><DT +><A +HREF="r2583.html" +>FcAtomicOrigFile</A +> -- return original file name</DT +><DT +><A +HREF="r2605.html" +>FcAtomicReplaceOrig</A +> -- replace original with new</DT +><DT +><A +HREF="r2627.html" +>FcAtomicDeleteNew</A +> -- delete new file</DT +><DT +><A +HREF="r2648.html" +>FcAtomicUnlock</A +> -- unlock a file</DT +><DT +><A +HREF="r2669.html" +>FcAtomicDestroy</A +> -- destroy an FcAtomic object</DT +></DL +></DIV +><P +>These functions provide a safe way to update config files, allowing ongoing +reading of the old config file while locked for writing and ensuring that a +consistent and complete version of the config file is always available. + </P +></DIV +><DIV +CLASS="SECT2" +><H2 +CLASS="SECT2" +><A +NAME="AEN2691" +>4.14. File and Directory routines</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="r2694.html" +>FcFileScan</A +> -- scan a font file</DT +><DT +><A +HREF="r2730.html" +>FcDirScan</A +> -- scan a font directory</DT +><DT +><A +HREF="r2765.html" +>FcDirSave</A +> -- save a directory cache</DT +><DT +><A +HREF="r2793.html" +>FcDirCacheValid</A +> -- check directory cache timestamp</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="AEN2815" +>4.15. FcStrSet and FcStrList</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="r2818.html" +>FcStrSetCreate</A +> -- create a string set</DT +><DT +><A +HREF="r2839.html" +>FcStrSetMember</A +> -- check set for membership</DT +><DT +><A +HREF="r2864.html" +>FcStrSetAdd</A +> -- add to a string set</DT +><DT +><A +HREF="r2889.html" +>FcStrSetAddFilename</A +> -- add a filename to a string set</DT +><DT +><A +HREF="r2914.html" +>FcStrSetDel</A +> -- delete from a string set</DT +><DT +><A +HREF="r2940.html" +>FcStrSetDestroy</A +> -- destroy a string set</DT +><DT +><A +HREF="r2962.html" +>FcStrListCreate</A +> -- create a string iterator</DT +><DT +><A +HREF="r2984.html" +>FcStrListNext</A +> -- get next string in iteration</DT +><DT +><A +HREF="r3006.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="AEN3028" +>4.16. String utilities</A +></H2 +><DIV +CLASS="TOC" +><DL +><DT +><B +>Table of Contents</B +></DT +><DT +><A +HREF="r3031.html" +>FcUtf8ToUcs4</A +> -- convert UTF-8 to UCS4</DT +><DT +><A +HREF="r3060.html" +>FcUcs4ToUtf8</A +> -- convert UCS4 to UTF-8</DT +><DT +><A +HREF="r3085.html" +>FcUtf8Len</A +> -- count UTF-8 encoded chars</DT +><DT +><A +HREF="r3117.html" +>FcUtf16ToUcs4</A +> -- convert UTF-16 to UCS4</DT +><DT +><A +HREF="r3150.html" +>FcUtf16Len</A +> -- count UTF-16 encoded chars</DT +><DT +><A +HREF="r3186.html" +>FcStrCopy</A +> -- duplicate a string</DT +><DT +><A +HREF="r3209.html" +>FcStrDowncase</A +> -- create a lower case translation of a string</DT +><DT +><A +HREF="r3231.html" +>FcStrCopyFilename</A +> -- copy a string, expanding '~'</DT +><DT +><A +HREF="r3254.html" +>FcStrCmpIgnoreCase</A +> -- compare UTF-8 strings ignoring ASCII case</DT +><DT +><A +HREF="r3279.html" +>FcStrStr</A +> -- locate UTF-8 substring</DT +><DT +><A +HREF="r3306.html" +>FcStrStrIgnoreCase</A +> -- locate UTF-8 substring ignoring ASCII case</DT +><DT +><A +HREF="r3333.html" +>FcStrDirname</A +> -- directory part of filename</DT +><DT +><A +HREF="r3355.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 |