1/*
2 * fontconfig/doc/fcstrset.fncs
3 *
4 * Copyright © 2003 Keith Packard
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 the author(s) not be used in
11 * advertising or publicity pertaining to distribution of the software without
12 * specific, written prior permission.  The authors make 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 * THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
17 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
18 * EVENT SHALL THE AUTHOR(S) 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@          FcStrSetEqual
46@TYPE1@         FcStrSet *                      @ARG1@          set_a
47@TYPE2@         FcStrSet *                      @ARG2@          set_b
48@PURPOSE@       check sets for equality
49@DESC@
50Returns whether <parameter>set_a</parameter> contains precisely the same
51strings as <parameter>set_b</parameter>. Ordering of strings within the two
52sets is not considered.
53@@
54
55@RET@           FcBool
56@FUNC@          FcStrSetAdd
57@TYPE1@         FcStrSet *                      @ARG1@          set
58@TYPE2@         const FcChar8 *                 @ARG2@          s
59@PURPOSE@       add to a string set
60@DESC@
61Adds a copy of <parameter>s</parameter> to <parameter>set</parameter>.
62@@
63
64@RET@           FcBool
65@FUNC@          FcStrSetAddFilename
66@TYPE1@         FcStrSet *                      @ARG1@          set
67@TYPE2@         const FcChar8 *                 @ARG2@          s
68@PURPOSE@       add a filename to a string set
69@DESC@
70Adds a copy <parameter>s</parameter> to <parameter>set</parameter>, The copy
71is created with FcStrCopyFilename so that leading '~' values are replaced
72with the value of the HOME environment variable.
73@@
74
75@RET@           FcBool
76@FUNC@          FcStrSetDel
77@TYPE1@         FcStrSet *                      @ARG1@          set
78@TYPE2@         const FcChar8 *                 @ARG2@          s
79@PURPOSE@       delete from a string set
80@DESC@
81Removes <parameter>s</parameter> from <parameter>set</parameter>, returning
82FcTrue if <parameter>s</parameter> was a member else FcFalse.
83@@
84
85@RET@           void
86@FUNC@          FcStrSetDestroy
87@TYPE1@         FcStrSet *                      @ARG1@          set
88@PURPOSE@       destroy a string set
89@DESC@
90Destroys <parameter>set</parameter>.
91@@
92
93@RET@           FcStrList *
94@FUNC@          FcStrListCreate
95@TYPE1@         FcStrSet *                      @ARG1@          set
96@PURPOSE@       create a string iterator
97@DESC@
98Creates an iterator to list the strings in <parameter>set</parameter>.
99@@
100
101@RET@           void
102@FUNC@          FcStrListFirst
103@TYPE1@         FcStrList *                     @ARG1@          list
104@PURPOSE@       get first string in iteration
105@DESC@
106Returns the first string in <parameter>list</parameter>.
107@SINCE@         2.11.0
108@@
109
110@RET@           FcChar8 *
111@FUNC@          FcStrListNext
112@TYPE1@         FcStrList *                     @ARG1@          list
113@PURPOSE@       get next string in iteration
114@DESC@
115Returns the next string in <parameter>list</parameter>.
116@@
117
118@RET@           void
119@FUNC@          FcStrListDone
120@TYPE1@         FcStrList *                     @ARG1@          list
121@PURPOSE@       destroy a string iterator
122@DESC@
123Destroys the enumerator <parameter>list</parameter>.
124@@
125