doc/fcconstant.fncs

   1 /*
   2  * fontconfig/doc/fcconstant.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@           FcBool
  25 @FUNC@          FcNameRegisterConstants
  26 @TYPE1@         const FcConstant *              @ARG1@          consts
  27 @TYPE2@         int%                            @ARG2@          nconsts
  28 @PURPOSE@       Register symbolic constants
  29 @DESC@
  30 Register <parameter>nconsts</parameter> new symbolic constants. Returns
  31 FcFalse if the constants cannot be registered (due to allocation failure).
  32 Otherwise returns FcTrue.
  33 @@
  34
  35 @RET@           FcBool
  36 @FUNC@          FcNameUnregisterConstants
  37 @TYPE1@         const FcConstant *              @ARG1@          consts
  38 @TYPE2@         int%                            @ARG2@          nconsts
  39 @PURPOSE@       Unregister symbolic constants
  40 @DESC@
  41 Unregister <parameter>nconsts</parameter> symbolic constants. Returns
  42 FcFalse if the specified constants were not registered. Otherwise returns
  43 FcTrue.
  44 @@
  45
  46 @RET@           const FcConstant *
  47 @FUNC@          FcNameGetConstant
  48 @TYPE1@         FcChar8 *                       @ARG1@          string
  49 @PURPOSE@       Lookup symbolic constant
  50 @DESC@
  51 Return the FcConstant structure related to symbolic constant <parameter>string</parameter>.
  52 @@
  53
  54 @RET@           FcBool
  55 @FUNC@          FcNameConstant
  56 @TYPE1@         FcChar8 *                       @ARG1@          string
  57 @TYPE2@         int *                           @ARG2@          result
  58 @PURPOSE@       Get the value for a symbolic constant
  59 @DESC@
  60 Returns whether a symbolic constant with name <parameter>string</parameter> is registered,
  61 placing the value of the constant in <parameter>result</parameter> if present.
  62 @@