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>
28 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
31 <refname>FcStrSetCreate</refname>
32 <refpurpose>create a string set</refpurpose>
37 #include <fontconfig/fontconfig.h>
40 <funcdef>FcStrSet * <function>FcStrSetCreate</function></funcdef>
41 <paramdef>void<parameter></parameter></paramdef>
45 <refsect1><title>Description</title>
52 fontconfig/doc/func.sgml
54 Copyright © 2003 Keith Packard
56 Permission to use, copy, modify, distribute, and sell this software and its
57 documentation for any purpose is hereby granted without fee, provided that
58 the above copyright notice appear in all copies and that both that
59 copyright notice and this permission notice appear in supporting
60 documentation, and that the name of the author(s) not be used in
61 advertising or publicity pertaining to distribution of the software without
62 specific, written prior permission. The authors make no
63 representations about the suitability of this software for any purpose. It
64 is provided "as is" without express or implied warranty.
66 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
67 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
68 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
69 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
70 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
71 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
72 PERFORMANCE OF THIS SOFTWARE.
74 <refentry id="FcStrSetMember">
76 <refentrytitle>FcStrSetMember</refentrytitle>
77 <manvolnum>3</manvolnum>
78 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
81 <refname>FcStrSetMember</refname>
82 <refpurpose>check set for membership</refpurpose>
87 #include <fontconfig/fontconfig.h>
90 <funcdef>FcBool <function>FcStrSetMember</function></funcdef>
91 <paramdef>FcStrSet *<parameter>set</parameter></paramdef>
92 <paramdef>const FcChar8 *<parameter>s</parameter></paramdef>
96 <refsect1><title>Description</title>
98 Returns whether <parameter>s</parameter> is a member of
99 <parameter>set</parameter>.
104 fontconfig/doc/func.sgml
106 Copyright © 2003 Keith Packard
108 Permission to use, copy, modify, distribute, and sell this software and its
109 documentation for any purpose is hereby granted without fee, provided that
110 the above copyright notice appear in all copies and that both that
111 copyright notice and this permission notice appear in supporting
112 documentation, and that the name of the author(s) not be used in
113 advertising or publicity pertaining to distribution of the software without
114 specific, written prior permission. The authors make no
115 representations about the suitability of this software for any purpose. It
116 is provided "as is" without express or implied warranty.
118 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
119 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
120 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
121 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
122 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
123 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
124 PERFORMANCE OF THIS SOFTWARE.
126 <refentry id="FcStrSetEqual">
128 <refentrytitle>FcStrSetEqual</refentrytitle>
129 <manvolnum>3</manvolnum>
130 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
133 <refname>FcStrSetEqual</refname>
134 <refpurpose>check sets for equality</refpurpose>
139 #include <fontconfig/fontconfig.h>
142 <funcdef>FcBool <function>FcStrSetEqual</function></funcdef>
143 <paramdef>FcStrSet *<parameter>set_a</parameter></paramdef>
144 <paramdef>FcStrSet *<parameter>set_b</parameter></paramdef>
148 <refsect1><title>Description</title>
150 Returns whether <parameter>set_a</parameter> contains precisely the same
151 strings as <parameter>set_b</parameter>. Ordering of strings within the two
152 sets is not considered.
157 fontconfig/doc/func.sgml
159 Copyright © 2003 Keith Packard
161 Permission to use, copy, modify, distribute, and sell this software and its
162 documentation for any purpose is hereby granted without fee, provided that
163 the above copyright notice appear in all copies and that both that
164 copyright notice and this permission notice appear in supporting
165 documentation, and that the name of the author(s) not be used in
166 advertising or publicity pertaining to distribution of the software without
167 specific, written prior permission. The authors make no
168 representations about the suitability of this software for any purpose. It
169 is provided "as is" without express or implied warranty.
171 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
172 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
173 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
174 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
175 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
176 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
177 PERFORMANCE OF THIS SOFTWARE.
179 <refentry id="FcStrSetAdd">
181 <refentrytitle>FcStrSetAdd</refentrytitle>
182 <manvolnum>3</manvolnum>
183 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
186 <refname>FcStrSetAdd</refname>
187 <refpurpose>add to a string set</refpurpose>
192 #include <fontconfig/fontconfig.h>
195 <funcdef>FcBool <function>FcStrSetAdd</function></funcdef>
196 <paramdef>FcStrSet *<parameter>set</parameter></paramdef>
197 <paramdef>const FcChar8 *<parameter>s</parameter></paramdef>
201 <refsect1><title>Description</title>
203 Adds a copy of <parameter>s</parameter> to <parameter>set</parameter>.
208 fontconfig/doc/func.sgml
210 Copyright © 2003 Keith Packard
212 Permission to use, copy, modify, distribute, and sell this software and its
213 documentation for any purpose is hereby granted without fee, provided that
214 the above copyright notice appear in all copies and that both that
215 copyright notice and this permission notice appear in supporting
216 documentation, and that the name of the author(s) not be used in
217 advertising or publicity pertaining to distribution of the software without
218 specific, written prior permission. The authors make no
219 representations about the suitability of this software for any purpose. It
220 is provided "as is" without express or implied warranty.
222 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
223 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
224 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
225 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
226 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
227 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
228 PERFORMANCE OF THIS SOFTWARE.
230 <refentry id="FcStrSetAddFilename">
232 <refentrytitle>FcStrSetAddFilename</refentrytitle>
233 <manvolnum>3</manvolnum>
234 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
237 <refname>FcStrSetAddFilename</refname>
238 <refpurpose>add a filename to a string set</refpurpose>
243 #include <fontconfig/fontconfig.h>
246 <funcdef>FcBool <function>FcStrSetAddFilename</function></funcdef>
247 <paramdef>FcStrSet *<parameter>set</parameter></paramdef>
248 <paramdef>const FcChar8 *<parameter>s</parameter></paramdef>
252 <refsect1><title>Description</title>
254 Adds a copy <parameter>s</parameter> to <parameter>set</parameter>, The copy
255 is created with FcStrCopyFilename so that leading '~' values are replaced
256 with the value of the HOME environment variable.
261 fontconfig/doc/func.sgml
263 Copyright © 2003 Keith Packard
265 Permission to use, copy, modify, distribute, and sell this software and its
266 documentation for any purpose is hereby granted without fee, provided that
267 the above copyright notice appear in all copies and that both that
268 copyright notice and this permission notice appear in supporting
269 documentation, and that the name of the author(s) not be used in
270 advertising or publicity pertaining to distribution of the software without
271 specific, written prior permission. The authors make no
272 representations about the suitability of this software for any purpose. It
273 is provided "as is" without express or implied warranty.
275 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
276 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
277 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
278 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
279 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
280 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
281 PERFORMANCE OF THIS SOFTWARE.
283 <refentry id="FcStrSetDel">
285 <refentrytitle>FcStrSetDel</refentrytitle>
286 <manvolnum>3</manvolnum>
287 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
290 <refname>FcStrSetDel</refname>
291 <refpurpose>delete from a string set</refpurpose>
296 #include <fontconfig/fontconfig.h>
299 <funcdef>FcBool <function>FcStrSetDel</function></funcdef>
300 <paramdef>FcStrSet *<parameter>set</parameter></paramdef>
301 <paramdef>const FcChar8 *<parameter>s</parameter></paramdef>
305 <refsect1><title>Description</title>
307 Removes <parameter>s</parameter> from <parameter>set</parameter>, returning
308 FcTrue if <parameter>s</parameter> was a member else FcFalse.
313 fontconfig/doc/func.sgml
315 Copyright © 2003 Keith Packard
317 Permission to use, copy, modify, distribute, and sell this software and its
318 documentation for any purpose is hereby granted without fee, provided that
319 the above copyright notice appear in all copies and that both that
320 copyright notice and this permission notice appear in supporting
321 documentation, and that the name of the author(s) not be used in
322 advertising or publicity pertaining to distribution of the software without
323 specific, written prior permission. The authors make no
324 representations about the suitability of this software for any purpose. It
325 is provided "as is" without express or implied warranty.
327 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
328 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
329 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
330 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
331 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
332 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
333 PERFORMANCE OF THIS SOFTWARE.
335 <refentry id="FcStrSetDestroy">
337 <refentrytitle>FcStrSetDestroy</refentrytitle>
338 <manvolnum>3</manvolnum>
339 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
342 <refname>FcStrSetDestroy</refname>
343 <refpurpose>destroy a string set</refpurpose>
348 #include <fontconfig/fontconfig.h>
351 <funcdef>void <function>FcStrSetDestroy</function></funcdef>
352 <paramdef>FcStrSet *<parameter>set</parameter></paramdef>
356 <refsect1><title>Description</title>
358 Destroys <parameter>set</parameter>.
363 fontconfig/doc/func.sgml
365 Copyright © 2003 Keith Packard
367 Permission to use, copy, modify, distribute, and sell this software and its
368 documentation for any purpose is hereby granted without fee, provided that
369 the above copyright notice appear in all copies and that both that
370 copyright notice and this permission notice appear in supporting
371 documentation, and that the name of the author(s) not be used in
372 advertising or publicity pertaining to distribution of the software without
373 specific, written prior permission. The authors make no
374 representations about the suitability of this software for any purpose. It
375 is provided "as is" without express or implied warranty.
377 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
378 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
379 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
380 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
381 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
382 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
383 PERFORMANCE OF THIS SOFTWARE.
385 <refentry id="FcStrListCreate">
387 <refentrytitle>FcStrListCreate</refentrytitle>
388 <manvolnum>3</manvolnum>
389 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
392 <refname>FcStrListCreate</refname>
393 <refpurpose>create a string iterator</refpurpose>
398 #include <fontconfig/fontconfig.h>
401 <funcdef>FcStrList * <function>FcStrListCreate</function></funcdef>
402 <paramdef>FcStrSet *<parameter>set</parameter></paramdef>
406 <refsect1><title>Description</title>
408 Creates an iterator to list the strings in <parameter>set</parameter>.
413 fontconfig/doc/func.sgml
415 Copyright © 2003 Keith Packard
417 Permission to use, copy, modify, distribute, and sell this software and its
418 documentation for any purpose is hereby granted without fee, provided that
419 the above copyright notice appear in all copies and that both that
420 copyright notice and this permission notice appear in supporting
421 documentation, and that the name of the author(s) not be used in
422 advertising or publicity pertaining to distribution of the software without
423 specific, written prior permission. The authors make no
424 representations about the suitability of this software for any purpose. It
425 is provided "as is" without express or implied warranty.
427 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
428 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
429 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
430 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
431 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
432 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
433 PERFORMANCE OF THIS SOFTWARE.
435 <refentry id="FcStrListFirst">
437 <refentrytitle>FcStrListFirst</refentrytitle>
438 <manvolnum>3</manvolnum>
439 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
442 <refname>FcStrListFirst</refname>
443 <refpurpose>get first string in iteration</refpurpose>
448 #include <fontconfig/fontconfig.h>
451 <funcdef>void <function>FcStrListFirst</function></funcdef>
452 <paramdef>FcStrList *<parameter>list</parameter></paramdef>
456 <refsect1><title>Description</title>
458 Returns the first string in <parameter>list</parameter>.
461 <refsect1><title>Since</title>
462 <para>version 2.11.0</para>
466 fontconfig/doc/func.sgml
468 Copyright © 2003 Keith Packard
470 Permission to use, copy, modify, distribute, and sell this software and its
471 documentation for any purpose is hereby granted without fee, provided that
472 the above copyright notice appear in all copies and that both that
473 copyright notice and this permission notice appear in supporting
474 documentation, and that the name of the author(s) not be used in
475 advertising or publicity pertaining to distribution of the software without
476 specific, written prior permission. The authors make no
477 representations about the suitability of this software for any purpose. It
478 is provided "as is" without express or implied warranty.
480 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
481 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
482 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
483 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
484 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
485 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
486 PERFORMANCE OF THIS SOFTWARE.
488 <refentry id="FcStrListNext">
490 <refentrytitle>FcStrListNext</refentrytitle>
491 <manvolnum>3</manvolnum>
492 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
495 <refname>FcStrListNext</refname>
496 <refpurpose>get next string in iteration</refpurpose>
501 #include <fontconfig/fontconfig.h>
504 <funcdef>FcChar8 * <function>FcStrListNext</function></funcdef>
505 <paramdef>FcStrList *<parameter>list</parameter></paramdef>
509 <refsect1><title>Description</title>
511 Returns the next string in <parameter>list</parameter>.
516 fontconfig/doc/func.sgml
518 Copyright © 2003 Keith Packard
520 Permission to use, copy, modify, distribute, and sell this software and its
521 documentation for any purpose is hereby granted without fee, provided that
522 the above copyright notice appear in all copies and that both that
523 copyright notice and this permission notice appear in supporting
524 documentation, and that the name of the author(s) not be used in
525 advertising or publicity pertaining to distribution of the software without
526 specific, written prior permission. The authors make no
527 representations about the suitability of this software for any purpose. It
528 is provided "as is" without express or implied warranty.
530 THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
531 INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
532 EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
533 CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
534 DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
535 TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
536 PERFORMANCE OF THIS SOFTWARE.
538 <refentry id="FcStrListDone">
540 <refentrytitle>FcStrListDone</refentrytitle>
541 <manvolnum>3</manvolnum>
542 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
545 <refname>FcStrListDone</refname>
546 <refpurpose>destroy a string iterator</refpurpose>
551 #include <fontconfig/fontconfig.h>
554 <funcdef>void <function>FcStrListDone</function></funcdef>
555 <paramdef>FcStrList *<parameter>list</parameter></paramdef>
559 <refsect1><title>Description</title>
561 Destroys the enumerator <parameter>list</parameter>.