]> git.wh0rd.org - fontconfig.git/blame - doc/fcstrset.fncs
Survive missing docbook2pdf.
[fontconfig.git] / doc / fcstrset.fncs
CommitLineData
39381776
KP
1/*
2 * $Id$
3 *
46b51147 4 * Copyright © 2003 Keith Packard
39381776
KP
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 <variablelist>
25
26@RET@ FcStrSet *
27@FUNC@ FcStrSetCreate
28@TYPE1@ void
29@PURPOSE@ create a string set
30@DESC@
31Create an empty set.
32@@
33
34@RET@ FcBool
35@FUNC@ FcStrSetMember
36@TYPE1@ FcStrSet * @ARG1@ set
37@TYPE2@ const FcChar8 * @ARG2@ s
38@PURPOSE@ check set for membership
39@DESC@
40Returns whether <parameter>s</parameter> is a member of
41<parameter>set</parameter>.
42@@
43
44@RET@ FcBool
45@FUNC@ FcStrSetAdd
46@TYPE1@ FcStrSet * @ARG1@ set
47@TYPE2@ const FcChar8 * @ARG2@ s
48@PURPOSE@ add to a string set
49@DESC@
50Adds a copy of <parameter>s</parameter> to <parameter>set</parameter>.
51@@
52
53@RET@ FcBool
54@FUNC@ FcStrSetAddFilename
55@TYPE1@ FcStrSet * @ARG1@ set
56@TYPE2@ const FcChar8 * @ARG2@ s
57@PURPOSE@ add a filename to a string set
58@DESC@
59Adds a copy <parameter>s</parameter> to <parameter>set</parameter>, The copy
60is created with FcStrCopyFilename so that leading '~' values are replaced
61with the value of the HOME environment variable.
62@@
63
64@RET@ FcBool
65@FUNC@ FcStrSetDel
66@TYPE1@ FcStrSet * @ARG1@ set
67@TYPE2@ const FcChar8 * @ARG2@ s
68@PURPOSE@ delete from a string set
69@DESC@
70Removes <parameter>s</parameter> from <parameter>set</parameter>, returning
71FcTrue if <parameter>s</parameter> was a member else FcFalse.
72@@
73
74@RET@ void
75@FUNC@ FcStrSetDestroy
76@TYPE1@ FcStrSet * @ARG1@ set
77@PURPOSE@ destroy a string set
78@DESC@
79Destroys <parameter>set</parameter>.
80@@
81
82@RET@ FcStrList *
83@FUNC@ FcStrListCreate
84@TYPE1@ FcStrSet * @ARG1@ set
85@PURPOSE@ create a string iterator
86@DESC@
87Creates an iterator to list the strings in <parameter>set</parameter>.
88@@
89
90@RET@ FcChar8 *
91@FUNC@ FcStrListNext
92@TYPE1@ FcStrList * @ARG1@ list
93@PURPOSE@ get next string in iteration
94@DESC@
95Returns the next string in <parameter>set</parameter>.
96@@
97
98@RET@ void
99@FUNC@ FcStrListDone
100@TYPE1@ FcStrList * @ARG1@ list
101@PURPOSE@ destroy a string iterator
102@DESC@
103Destroys the enumerator <parameter>list</parameter>.
104@@