2 fontconfig/doc/func.sgml
4 Copyright © 2003 Keith Packard
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.
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.
24 <refentry id="FcStrSetCreate">
26 <refentrytitle>FcStrSetCreate</refentrytitle>
27 <manvolnum>3</manvolnum>
30 <refname>FcStrSetCreate</refname>
31 <refpurpose>create a string set</refpurpose>
36 #include <fontconfig/fontconfig.h>
39 <funcdef>FcStrSet * <function>FcStrSetCreate</function></funcdef>
40 <paramdef>void<parameter></parameter></paramdef>
44 <refsect1><title>Description</title>
49 <refsect1><title>Version</title>
51 Fontconfig version &version;
56 fontconfig/doc/func.sgml
58 Copyright © 2003 Keith Packard
60 Permission to use, copy, modify, distribute, and sell this software and its
61 documentation for any purpose is hereby granted without fee, provided that
62 the above copyright notice appear in all copies and that both that
63 copyright notice and this permission notice appear in supporting
64 documentation, and that the name of the author(s) not be used in
65 advertising or publicity pertaining to distribution of the software without
66 specific, written prior permission. The authors make no
67 representations about the suitability of this software for any purpose. It
68 is provided "as is" without express or implied warranty.
70 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
71 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
72 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
73 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
74 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
75 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
76 PERFORMANCE OF THIS SOFTWARE.
78 <refentry id="FcStrSetMember">
80 <refentrytitle>FcStrSetMember</refentrytitle>
81 <manvolnum>3</manvolnum>
84 <refname>FcStrSetMember</refname>
85 <refpurpose>check set for membership</refpurpose>
90 #include <fontconfig/fontconfig.h>
93 <funcdef>FcBool <function>FcStrSetMember</function></funcdef>
94 <paramdef>FcStrSet *<parameter>set</parameter></paramdef>
95 <paramdef>const FcChar8 *<parameter>s</parameter></paramdef>
99 <refsect1><title>Description</title>
101 Returns whether <parameter>s</parameter> is a member of
102 <parameter>set</parameter>.
105 <refsect1><title>Version</title>
107 Fontconfig version &version;
112 fontconfig/doc/func.sgml
114 Copyright © 2003 Keith Packard
116 Permission to use, copy, modify, distribute, and sell this software and its
117 documentation for any purpose is hereby granted without fee, provided that
118 the above copyright notice appear in all copies and that both that
119 copyright notice and this permission notice appear in supporting
120 documentation, and that the name of the author(s) not be used in
121 advertising or publicity pertaining to distribution of the software without
122 specific, written prior permission. The authors make no
123 representations about the suitability of this software for any purpose. It
124 is provided "as is" without express or implied warranty.
126 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
127 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
128 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
129 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
130 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
131 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
132 PERFORMANCE OF THIS SOFTWARE.
134 <refentry id="FcStrSetEqual">
136 <refentrytitle>FcStrSetEqual</refentrytitle>
137 <manvolnum>3</manvolnum>
140 <refname>FcStrSetEqual</refname>
141 <refpurpose>check sets for equality</refpurpose>
146 #include <fontconfig/fontconfig.h>
149 <funcdef>FcBool <function>FcStrSetEqual</function></funcdef>
150 <paramdef>FcStrSet *<parameter>set_a</parameter></paramdef>
151 <paramdef>FcStrSet *<parameter>set_b</parameter></paramdef>
155 <refsect1><title>Description</title>
157 Returns whether <parameter>set_a</parameter> contains precisely the same
158 strings as <parameter>set_b</parameter>. Ordering of strings within the two
159 sets is not considered.
162 <refsect1><title>Version</title>
164 Fontconfig version &version;
169 fontconfig/doc/func.sgml
171 Copyright © 2003 Keith Packard
173 Permission to use, copy, modify, distribute, and sell this software and its
174 documentation for any purpose is hereby granted without fee, provided that
175 the above copyright notice appear in all copies and that both that
176 copyright notice and this permission notice appear in supporting
177 documentation, and that the name of the author(s) not be used in
178 advertising or publicity pertaining to distribution of the software without
179 specific, written prior permission. The authors make no
180 representations about the suitability of this software for any purpose. It
181 is provided "as is" without express or implied warranty.
183 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
184 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
185 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
186 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
187 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
188 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
189 PERFORMANCE OF THIS SOFTWARE.
191 <refentry id="FcStrSetAdd">
193 <refentrytitle>FcStrSetAdd</refentrytitle>
194 <manvolnum>3</manvolnum>
197 <refname>FcStrSetAdd</refname>
198 <refpurpose>add to a string set</refpurpose>
203 #include <fontconfig/fontconfig.h>
206 <funcdef>FcBool <function>FcStrSetAdd</function></funcdef>
207 <paramdef>FcStrSet *<parameter>set</parameter></paramdef>
208 <paramdef>const FcChar8 *<parameter>s</parameter></paramdef>
212 <refsect1><title>Description</title>
214 Adds a copy of <parameter>s</parameter> to <parameter>set</parameter>.
217 <refsect1><title>Version</title>
219 Fontconfig version &version;
224 fontconfig/doc/func.sgml
226 Copyright © 2003 Keith Packard
228 Permission to use, copy, modify, distribute, and sell this software and its
229 documentation for any purpose is hereby granted without fee, provided that
230 the above copyright notice appear in all copies and that both that
231 copyright notice and this permission notice appear in supporting
232 documentation, and that the name of the author(s) not be used in
233 advertising or publicity pertaining to distribution of the software without
234 specific, written prior permission. The authors make no
235 representations about the suitability of this software for any purpose. It
236 is provided "as is" without express or implied warranty.
238 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
239 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
240 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
241 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
242 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
243 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
244 PERFORMANCE OF THIS SOFTWARE.
246 <refentry id="FcStrSetAddFilename">
248 <refentrytitle>FcStrSetAddFilename</refentrytitle>
249 <manvolnum>3</manvolnum>
252 <refname>FcStrSetAddFilename</refname>
253 <refpurpose>add a filename to a string set</refpurpose>
258 #include <fontconfig/fontconfig.h>
261 <funcdef>FcBool <function>FcStrSetAddFilename</function></funcdef>
262 <paramdef>FcStrSet *<parameter>set</parameter></paramdef>
263 <paramdef>const FcChar8 *<parameter>s</parameter></paramdef>
267 <refsect1><title>Description</title>
269 Adds a copy <parameter>s</parameter> to <parameter>set</parameter>, The copy
270 is created with FcStrCopyFilename so that leading '~' values are replaced
271 with the value of the HOME environment variable.
274 <refsect1><title>Version</title>
276 Fontconfig version &version;
281 fontconfig/doc/func.sgml
283 Copyright © 2003 Keith Packard
285 Permission to use, copy, modify, distribute, and sell this software and its
286 documentation for any purpose is hereby granted without fee, provided that
287 the above copyright notice appear in all copies and that both that
288 copyright notice and this permission notice appear in supporting
289 documentation, and that the name of the author(s) not be used in
290 advertising or publicity pertaining to distribution of the software without
291 specific, written prior permission. The authors make no
292 representations about the suitability of this software for any purpose. It
293 is provided "as is" without express or implied warranty.
295 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
296 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
297 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
298 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
299 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
300 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
301 PERFORMANCE OF THIS SOFTWARE.
303 <refentry id="FcStrSetDel">
305 <refentrytitle>FcStrSetDel</refentrytitle>
306 <manvolnum>3</manvolnum>
309 <refname>FcStrSetDel</refname>
310 <refpurpose>delete from a string set</refpurpose>
315 #include <fontconfig/fontconfig.h>
318 <funcdef>FcBool <function>FcStrSetDel</function></funcdef>
319 <paramdef>FcStrSet *<parameter>set</parameter></paramdef>
320 <paramdef>const FcChar8 *<parameter>s</parameter></paramdef>
324 <refsect1><title>Description</title>
326 Removes <parameter>s</parameter> from <parameter>set</parameter>, returning
327 FcTrue if <parameter>s</parameter> was a member else FcFalse.
330 <refsect1><title>Version</title>
332 Fontconfig version &version;
337 fontconfig/doc/func.sgml
339 Copyright © 2003 Keith Packard
341 Permission to use, copy, modify, distribute, and sell this software and its
342 documentation for any purpose is hereby granted without fee, provided that
343 the above copyright notice appear in all copies and that both that
344 copyright notice and this permission notice appear in supporting
345 documentation, and that the name of the author(s) not be used in
346 advertising or publicity pertaining to distribution of the software without
347 specific, written prior permission. The authors make no
348 representations about the suitability of this software for any purpose. It
349 is provided "as is" without express or implied warranty.
351 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
352 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
353 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
354 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
355 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
356 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
357 PERFORMANCE OF THIS SOFTWARE.
359 <refentry id="FcStrSetDestroy">
361 <refentrytitle>FcStrSetDestroy</refentrytitle>
362 <manvolnum>3</manvolnum>
365 <refname>FcStrSetDestroy</refname>
366 <refpurpose>destroy a string set</refpurpose>
371 #include <fontconfig/fontconfig.h>
374 <funcdef>void <function>FcStrSetDestroy</function></funcdef>
375 <paramdef>FcStrSet *<parameter>set</parameter></paramdef>
379 <refsect1><title>Description</title>
381 Destroys <parameter>set</parameter>.
384 <refsect1><title>Version</title>
386 Fontconfig version &version;
391 fontconfig/doc/func.sgml
393 Copyright © 2003 Keith Packard
395 Permission to use, copy, modify, distribute, and sell this software and its
396 documentation for any purpose is hereby granted without fee, provided that
397 the above copyright notice appear in all copies and that both that
398 copyright notice and this permission notice appear in supporting
399 documentation, and that the name of the author(s) not be used in
400 advertising or publicity pertaining to distribution of the software without
401 specific, written prior permission. The authors make no
402 representations about the suitability of this software for any purpose. It
403 is provided "as is" without express or implied warranty.
405 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
406 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
407 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
408 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
409 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
410 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
411 PERFORMANCE OF THIS SOFTWARE.
413 <refentry id="FcStrListCreate">
415 <refentrytitle>FcStrListCreate</refentrytitle>
416 <manvolnum>3</manvolnum>
419 <refname>FcStrListCreate</refname>
420 <refpurpose>create a string iterator</refpurpose>
425 #include <fontconfig/fontconfig.h>
428 <funcdef>FcStrList * <function>FcStrListCreate</function></funcdef>
429 <paramdef>FcStrSet *<parameter>set</parameter></paramdef>
433 <refsect1><title>Description</title>
435 Creates an iterator to list the strings in <parameter>set</parameter>.
438 <refsect1><title>Version</title>
440 Fontconfig version &version;
445 fontconfig/doc/func.sgml
447 Copyright © 2003 Keith Packard
449 Permission to use, copy, modify, distribute, and sell this software and its
450 documentation for any purpose is hereby granted without fee, provided that
451 the above copyright notice appear in all copies and that both that
452 copyright notice and this permission notice appear in supporting
453 documentation, and that the name of the author(s) not be used in
454 advertising or publicity pertaining to distribution of the software without
455 specific, written prior permission. The authors make no
456 representations about the suitability of this software for any purpose. It
457 is provided "as is" without express or implied warranty.
459 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
460 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
461 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
462 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
463 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
464 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
465 PERFORMANCE OF THIS SOFTWARE.
467 <refentry id="FcStrListNext">
469 <refentrytitle>FcStrListNext</refentrytitle>
470 <manvolnum>3</manvolnum>
473 <refname>FcStrListNext</refname>
474 <refpurpose>get next string in iteration</refpurpose>
479 #include <fontconfig/fontconfig.h>
482 <funcdef>FcChar8 * <function>FcStrListNext</function></funcdef>
483 <paramdef>FcStrList *<parameter>list</parameter></paramdef>
487 <refsect1><title>Description</title>
489 Returns the next string in <parameter>set</parameter>.
492 <refsect1><title>Version</title>
494 Fontconfig version &version;
499 fontconfig/doc/func.sgml
501 Copyright © 2003 Keith Packard
503 Permission to use, copy, modify, distribute, and sell this software and its
504 documentation for any purpose is hereby granted without fee, provided that
505 the above copyright notice appear in all copies and that both that
506 copyright notice and this permission notice appear in supporting
507 documentation, and that the name of the author(s) not be used in
508 advertising or publicity pertaining to distribution of the software without
509 specific, written prior permission. The authors make no
510 representations about the suitability of this software for any purpose. It
511 is provided "as is" without express or implied warranty.
513 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
514 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
515 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
516 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
517 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
518 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
519 PERFORMANCE OF THIS SOFTWARE.
521 <refentry id="FcStrListDone">
523 <refentrytitle>FcStrListDone</refentrytitle>
524 <manvolnum>3</manvolnum>
527 <refname>FcStrListDone</refname>
528 <refpurpose>destroy a string iterator</refpurpose>
533 #include <fontconfig/fontconfig.h>
536 <funcdef>void <function>FcStrListDone</function></funcdef>
537 <paramdef>FcStrList *<parameter>list</parameter></paramdef>
541 <refsect1><title>Description</title>
543 Destroys the enumerator <parameter>list</parameter>.
546 <refsect1><title>Version</title>
548 Fontconfig version &version;