fcconstant.fncs revision a6844aab
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 102c393a42Smrg * documentation, and that the name of Keith Packard not be used in 112c393a42Smrg * advertising or publicity pertaining to distribution of the software without 122c393a42Smrg * specific, written prior permission. Keith Packard makes 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 */ 242c393a42Smrg@RET@ FcBool 252c393a42Smrg@FUNC@ FcNameRegisterConstants 262c393a42Smrg@TYPE1@ const FcConstant * @ARG1@ consts 272c393a42Smrg@TYPE2@ int% @ARG2@ nconsts 282c393a42Smrg@PURPOSE@ Register symbolic constants 292c393a42Smrg@DESC@ 302c393a42SmrgRegister <parameter>nconsts</parameter> new symbolic constants. Returns 312c393a42SmrgFcFalse if the constants cannot be registered (due to allocation failure). 322c393a42SmrgOtherwise returns FcTrue. 332c393a42Smrg@@ 342c393a42Smrg 352c393a42Smrg@RET@ FcBool 362c393a42Smrg@FUNC@ FcNameUnregisterConstants 372c393a42Smrg@TYPE1@ const FcConstant * @ARG1@ consts 382c393a42Smrg@TYPE2@ int% @ARG2@ nconsts 392c393a42Smrg@PURPOSE@ Unregister symbolic constants 402c393a42Smrg@DESC@ 412c393a42SmrgUnregister <parameter>nconsts</parameter> symbolic constants. Returns 422c393a42SmrgFcFalse if the specified constants were not registered. Otherwise returns 432c393a42SmrgFcTrue. 442c393a42Smrg@@ 452c393a42Smrg 462c393a42Smrg@RET@ const FcConstant * 472c393a42Smrg@FUNC@ FcNameGetConstant 482c393a42Smrg@TYPE1@ FcChar8 * @ARG1@ string 492c393a42Smrg@PURPOSE@ Lookup symbolic constant 502c393a42Smrg@DESC@ 512c393a42SmrgReturn the FcConstant structure related to symbolic constant <parameter>string</parameter>. 522c393a42Smrg@@ 532c393a42Smrg 542c393a42Smrg@RET@ FcBool 552c393a42Smrg@FUNC@ FcNameConstant 562c393a42Smrg@TYPE1@ FcChar8 * @ARG1@ string 572c393a42Smrg@TYPE2@ int * @ARG2@ result 582c393a42Smrg@PURPOSE@ Get the value for a symbolic constant 592c393a42Smrg@DESC@ 602c393a42SmrgReturns whether a symbolic constant with name <parameter>string</parameter> is registered, 612c393a42Smrgplacing the value of the constant in <parameter>result</parameter> if present. 622c393a42Smrg@@ 63