Add new public API: FcCharSetDelChar()

[fontconfig.git] / doc / fccharset.fncs

diff --git a/doc/fccharset.fncs b/doc/fccharset.fncs
index 700a20b56078a9d6de3a533679e8ec3ffda7eff6..004fdc3a0b9f67a550354d2b9b5a562054d9f2c7 100644 (file)
--- a/doc/fccharset.fncs
+++ b/doc/fccharset.fncs
@@ -1,5 +1,5 @@
 /*
- * $Id$
+ * fontconfig/doc/fccharset.fncs
  *
  * Copyright © 2003 Keith Packard
  *
@@ -13,9 +13,9 @@
  * representations about the suitability of this software for any purpose.  It
  * is provided "as is" without express or implied warranty.
  *
- * KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
+ * THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
- * EVENT SHALL KEITH PACKARD BE LIABLE FOR ANY SPECIAL, INDIRECT OR
+ * 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
@@ -43,7 +43,7 @@ memory referenced is freed.
 @RET@          FcBool 
 @FUNC@         FcCharSetAddChar
 @TYPE1@                FcCharSet *             @ARG1@          fcs
-@TYPE2@                FcChar32                @ARG2@          ucs4 
+@TYPE2@                FcChar32%               @ARG2@          ucs4 
 @PURPOSE@      Add a character to a charset
 @DESC@
 <function>FcCharSetAddChar</function> adds a single unicode char to the set,
@@ -51,6 +51,17 @@ returning FcFalse on failure, either as a result of a constant set or from
 running out of memory. 
 @@
 
+@RET@          FcBool 
+@FUNC@         FcCharSetDelChar
+@TYPE1@                FcCharSet *             @ARG1@          fcs
+@TYPE2@                FcChar32%               @ARG2@          ucs4 
+@PURPOSE@      Add a character to a charset
+@DESC@
+<function>FcCharSetDelChar</function> deletes a single unicode char from the set,
+returning FcFalse on failure, either as a result of a constant set or from
+running out of memory.
+@@
+
 @RET@          FcCharSet *
 @FUNC@         FcCharSetCopy
 @TYPE1@                FcCharSet *             @ARG1@          src
@@ -98,10 +109,25 @@ Returns a set including only those chars found in either <parameter>a</parameter
 Returns a set including only those chars found in <parameter>a</parameter> but not <parameter>b</parameter>. 
 @@
 
+@RET@          FcBool
+@FUNC@         FcCharSetMerge
+@TYPE1@                FcCharSet *             @ARG1@          a
+@TYPE2@                const FcCharSet *       @ARG2@          b
+@TYPE3@                FcBool *                @ARG3@          changed
+@PURPOSE@      Merge charsets
+@DESC@
+Adds all chars in <parameter>b</parameter> to <parameter>a</parameter>.
+In other words, this is an in-place version of FcCharSetUnion.
+If <parameter>changed</parameter> is not NULL, then it returns whether any new
+chars from <parameter>b</parameter> were added to <parameter>a</parameter>.
+Returns FcFalse on failure, either when <parameter>a</parameter> is a constant
+set or from running out of memory.
+@@
+
 @RET@          FcBool 
 @FUNC@         FcCharSetHasChar
 @TYPE1@                const FcCharSet *       @ARG1@          fcs
-@TYPE2@                FcChar32                @ARG2@          ucs4
+@TYPE2@                FcChar32%               @ARG2@          ucs4
 @PURPOSE@      Check a charset for a char
 @DESC@
 Returns whether <parameter>fcs</parameter> contains the char <parameter>ucs4</parameter>. 
@@ -145,7 +171,7 @@ Returns whether <parameter>a</parameter> is a subset of <parameter>b</parameter>
 @RET@          FcChar32
 @FUNC@         FcCharSetFirstPage
 @TYPE1@                const FcCharSet *       @ARG1@          a
-@TYPE2@                FcChar32[FC_CHARSET_MAP_SIZE]   @ARG2@  map
+@TYPE2@                FcChar32[FC_CHARSET_MAP_SIZE]%  @ARG2@  map
 @TYPE3@                FcChar32 *              @ARG3@          next
 @PURPOSE@      Start enumerating charset contents
 @DESC@
@@ -157,7 +183,7 @@ font.
 @RET@          FcChar32
 @FUNC@         FcCharSetNextPage
 @TYPE1@                const FcCharSet *       @ARG1@          a
-@TYPE2@                FcChar32[FC_CHARSET_MAP_SIZE]   @ARG2@  map
+@TYPE2@                FcChar32[FC_CHARSET_MAP_SIZE]%  @ARG2@  map
 @TYPE3@                FcChar32 *              @ARG3@          next
 @PURPOSE@      Continue enumerating charset contents
 @DESC@
@@ -165,3 +191,27 @@ Builds an array of bits marking the Unicode coverage of <parameter>a</parameter>
 <parameter>*next</parameter>. Returns the base of the array. <parameter>next</parameter> contains the next page in
 the font. 
 @@
+
+@RET@          FcChar32
+@FUNC@         FcCharSetCoverage
+@TYPE1@                const FcCharSet *       @ARG1@          a
+@TYPE2@                FcChar32                @ARG2@          page
+@TYPE3@                FcChar32[8]             @ARG3@          result
+@PURPOSE@      DEPRECATED return coverage for a Unicode page
+@DESC@
+DEPRECATED
+This function returns a bitmask in <parameter>result</parameter> which
+indicates which code points in
+<parameter>page</parameter> are included in <parameter>a</parameter>.
+<function>FcCharSetCoverage</function> returns the next page in the charset which has any
+coverage.
+@@
+
+@RET@          FcCharSet *
+@FUNC@         FcCharSetNew
+@TYPE1@                void
+@PURPOSE@      DEPRECATED alias for FcCharSetCreate
+@DESC@
+<function>FcCharSetNew</function> is a DEPRECATED alias for FcCharSetCreate.
+@@
+