doc/fcobjecttype.fncs

   1 /*
   2  * fontconfig/doc/fcobjecttype.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@          FcNameRegisterObjectTypes
  26 @TYPE1@         const FcObjectType *            @ARG1@          types
  27 @TYPE2@         int%                            @ARG2@          ntype
  28 @PURPOSE@       Register object types
  29 @DESC@
  30 Register <parameter>ntype</parameter> new object types. Returns FcFalse if
  31 some of the names cannot be
  32 registered (due to allocation failure). Otherwise returns FcTrue.
  33 @@
  34
  35 @RET@           FcBool
  36 @FUNC@          FcNameUnregisterObjectTypes
  37 @TYPE1@         const FcObjectType *            @ARG1@          types
  38 @TYPE2@         int%                            @ARG2@          ntype
  39 @PURPOSE@       Unregister object types
  40 @DESC@
  41 Unregister <parameter>ntype</parameter> object types. Returns FcTrue.
  42 @@
  43
  44 @RET@           const FcObjectType *
  45 @FUNC@          FcNameGetObjectType
  46 @TYPE1@         const char *                    @ARG1@          object
  47 @PURPOSE@       Lookup an object type
  48 @DESC@
  49 Return the object type for the pattern element named <parameter>object</parameter>.
  50 @@