]> git.wh0rd.org - fontconfig.git/blame - doc/fccache.fncs
Cleanup copyright notices to replace "Keith Packard" with "the author(s)"
[fontconfig.git] / doc / fccache.fncs
CommitLineData
a190678e
KP
1/*
2 * Copyright © 2007 Keith Packard
3 *
4 * Permission to use, copy, modify, distribute, and sell this software and its
5 * documentation for any purpose is hereby granted without fee, provided that
6 * the above copyright notice appear in all copies and that both that
7 * copyright notice and this permission notice appear in supporting
5aaf466d 8 * documentation, and that the name of the author(s) not be used in
a190678e 9 * advertising or publicity pertaining to distribution of the software without
5aaf466d 10 * specific, written prior permission. The authors make no
a190678e
KP
11 * representations about the suitability of this software for any purpose. It
12 * is provided "as is" without express or implied warranty.
13 *
3074a73b 14 * THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
a190678e 15 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
3074a73b 16 * EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
a190678e
KP
17 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
18 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
19 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
20 * PERFORMANCE OF THIS SOFTWARE.
21 */
22
23@RET@ const FcChar8 *
24@FUNC@ FcCacheDir
25@TYPE1@ const FcCache * @ARG1@ cache
26@PURPOSE@ Return directory of <parameter>cache</parameter>
27@DESC@
28This function returns the directory from which the cache was constructed.
29@@
30
31@RET@ FcFontSet *
32@FUNC@ FcCacheCopySet
33@TYPE1@ const FcCache * @ARG1@ cache
34@PURPOSE@ Returns a copy of the fontset from <parameter>cache</parameter>
bfdc0047 35@DESC@
a190678e
KP
36The returned fontset contains each of the font patterns from
37<parameter>cache</parameter>. This fontset may be modified, but the patterns
38from the cache are read-only.
39@@
40
41@RET@ const FcChar8 *
42@FUNC@ FcCacheSubdir
43@TYPE1@ const FcCache * @ARG1@ cache
44@TYPE2@ int @ARG2@ i
45@PURPOSE@ Return the <parameter>i</parameter>'th subdirectory.
bfdc0047 46@DESC@
a190678e
KP
47The set of subdirectories stored in a cache file are indexed by this
48function, <parameter>i</parameter> should range from 0 to
49<parameter>n</parameter>-1, where <parameter>n</parameter> is the return
50value from FcCacheNumSubdir.
51@@
52
53@RET@ int
54@FUNC@ FcCacheNumSubdir
55@TYPE1@ const FcCache * @ARG1@ cache
56@PURPOSE@ Return the number of subdirectories in <parameter>cache</parameter>.
bfdc0047 57@DESC@
a190678e
KP
58This returns the total number of subdirectories in the cache.
59@@
60
61@RET@ int
62@FUNC@ FcCacheNumFont
63@TYPE1@ const FcCache * @ARG1@ cache
64@PURPOSE@ Returns the number of fonts in <parameter>cache</parameter>.
bfdc0047 65@DESC@
a190678e
KP
66This returns the number of fonts which would be included in the return from
67FcCacheCopySet.
68@@