aboutsummaryrefslogtreecommitdiff
path: root/fontconfig/doc/fcconstant.fncs
blob: c65fb392c39bf58ac80a952aa9968cf35e286470 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
/*
 * fontconfig/doc/fcconstant.fncs
 *
 * Copyright © 2003 Keith Packard
 *
 * 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
 * documentation, and that the name of the author(s) not be used in
 * advertising or publicity pertaining to distribution of the software without
 * specific, written prior permission.  The authors make no
 * representations about the suitability of this software for any purpose.  It
 * is provided "as is" without express or implied warranty.
 *
 * THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
 * EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 * 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@		FcBool
@FUNC@		FcNameRegisterConstants 
@TYPE1@		const FcConstant *		@ARG1@		consts
@TYPE2@		int%				@ARG2@		nconsts
@PURPOSE@	Register symbolic constants
@DESC@
Register <parameter>nconsts</parameter> new symbolic constants. Returns
FcFalse if the constants cannot be registered (due to allocation failure).
Otherwise returns FcTrue.
@@

@RET@		FcBool
@FUNC@		FcNameUnregisterConstants
@TYPE1@		const FcConstant *		@ARG1@		consts
@TYPE2@		int%				@ARG2@		nconsts
@PURPOSE@	Unregister symbolic constants
@DESC@
Unregister <parameter>nconsts</parameter> symbolic constants. Returns
FcFalse if the specified constants were not registered. Otherwise returns
FcTrue.
@@

@RET@		const FcConstant *
@FUNC@		FcNameGetConstant
@TYPE1@		FcChar8 *			@ARG1@		string
@PURPOSE@	Lookup symbolic constant
@DESC@
Return the FcConstant structure related to symbolic constant <parameter>string</parameter>.
@@

@RET@		FcBool
@FUNC@		FcNameConstant
@TYPE1@		FcChar8 *			@ARG1@		string
@TYPE2@		int *				@ARG2@		result
@PURPOSE@	Get the value for a symbolic constant
@DESC@
Returns whether a symbolic constant with name <parameter>string</parameter> is registered,
placing the value of the constant in <parameter>result</parameter> if present.
@@