12c393a42Smrg/*
2a6844aabSmrg * fontconfig/doc/fcconstant.fncs
32c393a42Smrg *
42c393a42Smrg * Copyright © 2003 Keith Packard
52c393a42Smrg *
62c393a42Smrg * Permission to use, copy, modify, distribute, and sell this software and its
72c393a42Smrg * documentation for any purpose is hereby granted without fee, provided that
82c393a42Smrg * the above copyright notice appear in all copies and that both that
92c393a42Smrg * copyright notice and this permission notice appear in supporting
10ca08ab68Smrg * documentation, and that the name of the author(s) not be used in
112c393a42Smrg * advertising or publicity pertaining to distribution of the software without
12ca08ab68Smrg * specific, written prior permission.  The authors make no
132c393a42Smrg * representations about the suitability of this software for any purpose.  It
142c393a42Smrg * is provided "as is" without express or implied warranty.
152c393a42Smrg *
16a6844aabSmrg * THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
172c393a42Smrg * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
18a6844aabSmrg * EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
192c393a42Smrg * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
202c393a42Smrg * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
212c393a42Smrg * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
222c393a42Smrg * PERFORMANCE OF THIS SOFTWARE.
232c393a42Smrg */
241cc69409Smrg@RET@           FcBool
251cc69409Smrg@FUNC@          FcNameRegisterConstants
261cc69409Smrg@TYPE1@         const FcConstant *              @ARG1@          consts
271cc69409Smrg@TYPE2@         int%                            @ARG2@          nconsts
281cc69409Smrg@PURPOSE@       Register symbolic constants
292c393a42Smrg@DESC@
30c9710b42SmrgDeprecated.  Does nothing.  Returns FcFalse.
312c393a42Smrg@@
322c393a42Smrg
331cc69409Smrg@RET@           FcBool
341cc69409Smrg@FUNC@          FcNameUnregisterConstants
351cc69409Smrg@TYPE1@         const FcConstant *              @ARG1@          consts
361cc69409Smrg@TYPE2@         int%                            @ARG2@          nconsts
371cc69409Smrg@PURPOSE@       Unregister symbolic constants
382c393a42Smrg@DESC@
39c9710b42SmrgDeprecated.  Does nothing.  Returns FcFalse.
402c393a42Smrg@@
412c393a42Smrg
421cc69409Smrg@RET@           const FcConstant *
431cc69409Smrg@FUNC@          FcNameGetConstant
441cc69409Smrg@TYPE1@         FcChar8 *                       @ARG1@          string
451cc69409Smrg@PURPOSE@       Lookup symbolic constant
462c393a42Smrg@DESC@
472c393a42SmrgReturn the FcConstant structure related to symbolic constant <parameter>string</parameter>.
482c393a42Smrg@@
492c393a42Smrg
501cc69409Smrg@RET@           const FcConstant *
511cc69409Smrg@FUNC@          FcNameGetConstantFor
521cc69409Smrg@TYPE1@         FcChar8 *                       @ARG1@          string
531cc69409Smrg@TYPE2@         char *                          @ARG2@          object
541cc69409Smrg@PURPOSE@       Lookup symbolic constant For object
551cc69409Smrg@DESC@
561cc69409SmrgReturn the FcConstant structure related to symbolic constant <parameter>string</parameter>
571cc69409Smrgfor <parameter>object</parameter>.
581cc69409Smrg@@
591cc69409Smrg
601cc69409Smrg@RET@           FcBool
611cc69409Smrg@FUNC@          FcNameConstant
621cc69409Smrg@TYPE1@         FcChar8 *                       @ARG1@          string
631cc69409Smrg@TYPE2@         int *                           @ARG2@          result
641cc69409Smrg@PURPOSE@       Get the value for a symbolic constant
652c393a42Smrg@DESC@
662c393a42SmrgReturns whether a symbolic constant with name <parameter>string</parameter> is registered,
672c393a42Smrgplacing the value of the constant in <parameter>result</parameter> if present.
682c393a42Smrg@@
69