fcobjectset.fncs 2.38 KB
Newer Older
1
/*
Behdad Esfahbod's avatar
Behdad Esfahbod committed
2
 * fontconfig/doc/fcobjectset.fncs
3
 *
4
 * Copyright © 2003 Keith Packard
5 6 7 8 9
 *
 * Permission to use, copy, modify, distribute, and sell this software and its
 * documentation for any purpose is hereby granted without fee, provided that
 * the above copyright notice appear in all copies and that both that
 * 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 14 15
 * representations about the suitability of this software for any purpose.  It
 * 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 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37
 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 */
@RET@		FcObjectSet *
@FUNC@		FcObjectSetCreate
@TYPE1@		void
@PURPOSE@	Create an object set
@DESC@
Creates an empty set.
@@

@RET@		FcBool
@FUNC@		FcObjectSetAdd
@TYPE1@		FcObjectSet *			@ARG1@		os
@TYPE2@		const char *			@ARG2@		object
@PURPOSE@	Add to an object set
@DESC@
Behdad Esfahbod's avatar
Behdad Esfahbod committed
38
Adds a property name to the set. Returns FcFalse if the property name cannot be
39
inserted into the set (due to allocation failure). Otherwise returns FcTrue.
40 41 42 43 44 45 46 47 48 49 50 51 52 53
@@

@RET@		void
@FUNC@		FcObjectSetDestroy
@TYPE1@		FcObjectSet *			@ARG1@		os
@PURPOSE@	Destroy an object set
@DESC@
Destroys an object set.
@@

@RET@		FcObjectSet *
@FUNC@		FcObjectSetBuild
@TYPE1@		const char *			@ARG1@		first
@TYPE2@		...
54

55 56 57 58
@PROTOTYPE+@
@RET+@		FcObjectSet *
@FUNC+@		FcObjectSetVaBuild
@TYPE1+@	const char *			@ARG1+@		first
59
@TYPE2+@	va_list%			@ARG2+@		va
60 61 62 63 64 65 66 67

@PROTOTYPE++@
@RET++@		void
@FUNC++@	FcObjectSetVapBuild
@TYPE1++@	FcObjectSet *			@ARG1++@	result
@TYPE2++@	const char *			@ARG2++@	first
@TYPE3++@	va_list%			@ARG3++@	va

68 69 70
@PURPOSE@	Build object set from args
@DESC@
These build an object set from a null-terminated list of property names.
71 72
FcObjectSetVapBuild is a macro version of FcObjectSetVaBuild which returns
the result in the <parameter>result</parameter> variable directly.
73
@@