fcobjectset.fncs revision 1cc69409 
1/*
2 * fontconfig/doc/fcobjectset.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@RET@           FcObjectSet *
25@FUNC@          FcObjectSetCreate
26@TYPE1@         void
27@PURPOSE@       Create an object set
28@DESC@
29Creates an empty set.
30@@
31
32@RET@           FcBool
33@FUNC@          FcObjectSetAdd
34@TYPE1@         FcObjectSet *                   @ARG1@          os
35@TYPE2@         const char *                    @ARG2@          object
36@PURPOSE@       Add to an object set
37@DESC@
38Adds a property name to the set. Returns FcFalse if the property name cannot be
39inserted into the set (due to allocation failure). Otherwise returns FcTrue.
40@@
41
42@RET@           void
43@FUNC@          FcObjectSetDestroy
44@TYPE1@         FcObjectSet *                   @ARG1@          os
45@PURPOSE@       Destroy an object set
46@DESC@
47Destroys an object set.
48@@
49
50@RET@           FcObjectSet *
51@FUNC@          FcObjectSetBuild
52@TYPE1@         const char *                    @ARG1@          first
53@TYPE2@         ...
54
55@PROTOTYPE+@
56@RET+@          FcObjectSet *
57@FUNC+@         FcObjectSetVaBuild
58@TYPE1+@        const char *                    @ARG1+@         first
59@TYPE2+@        va_list%                        @ARG2+@         va
60
61@PROTOTYPE++@
62@RET++@         void
63@FUNC++@        FcObjectSetVapBuild
64@TYPE1++@       FcObjectSet *                   @ARG1++@        result
65@TYPE2++@       const char *                    @ARG2++@        first
66@TYPE3++@       va_list%                        @ARG3++@        va
67
68@PURPOSE@       Build object set from args
69@DESC@
70These build an object set from a null-terminated list of property names.
71FcObjectSetVapBuild is a macro version of FcObjectSetVaBuild which returns
72the result in the <parameter>result</parameter> variable directly.
73@@
74