]> git.wh0rd.org - fontconfig.git/blame - doc/fccharset.fncs
Rework documentation to build man pages for each function
[fontconfig.git] / doc / fccharset.fncs
CommitLineData
22671e25
KP
1@RET@ FcCharSet *
2@FUNC@ FcCharSetCreate
3@TYPE1@ void
4@PURPOSE@ Create an empty character set
5@DESC@
6<function>FcCharSetCreate</function> allocates and initializes a new empty
7character set object.
8@@
9
10@RET@ void
11@FUNC@ FcCharSetDestroy
12@TYPE1@ FcCharSet * @ARG1@ fcs
13@PURPOSE@ Destroy a character set
14@DESC@
15<function>FcCharSetDestroy</function> decrements the reference count
16<parameter>fcs</parameter>. If the reference count becomes zero, all
17memory referenced is freed.
18@@
19
20@RET@ FcBool
21@FUNC@ FcCharSetAddChar
22@TYPE1@ FcCharSet * @ARG1@ fcs
23@TYPE2@ FcChar32 @ARG2@ ucs4
24@PURPOSE@ Add a character to a charset
25@DESC@
26<function>FcCharSetAddChar</function> adds a single unicode char to the set,
27returning FcFalse on failure, either as a result of a constant set or from
28running out of memory.
29@@
30
31@RET@ FcCharSet *
32@FUNC@ FcCharSetCopy
33@TYPE1@ FcCharSet * @ARG1@ src
34@PURPOSE@ Copy a charset
35@DESC@
36Makes a copy of <parameter>src</parameter>; note that this may not actually do anything more
37than increment the reference count on <parameter>src</parameter>.
38@@
39
40@RET@ FcBool
41@FUNC@ FcCharSetEqual
42@TYPE1@ const FcCharSet * @ARG1@ a
43@TYPE2@ const FcCharSet * @ARG2@ b
44@PURPOSE@ Compare two charsets
45@DESC@
46Returns whether <parameter>a</parameter> and <parameter>b</parameter>
47contain the same set of unicode chars.
48@@
49
50@RET@ FcCharSet *
51@FUNC@ FcCharSetIntersect
52@TYPE1@ const FcCharSet * @ARG1@ a
53@TYPE2@ const FcCharSet * @ARG2@ b
54@PURPOSE@ Intersect charsets
55@DESC@
56Returns a set including only those chars found in both
57<parameter>a</parameter> and <parameter>b</parameter>.
58@@
59
60@RET@ FcCharSet *
61@FUNC@ FcCharSetUnion
62@TYPE1@ const FcCharSet * @ARG1@ a
63@TYPE2@ const FcCharSet * @ARG2@ b
64@PURPOSE@ Add charsets
65@DESC@
66Returns a set including only those chars found in either <parameter>a</parameter> or <parameter>b</parameter>.
67@@
68
69@RET@ FcCharSet *
70@FUNC@ FcCharSetSubtract
71@TYPE1@ const FcCharSet * @ARG1@ a
72@TYPE2@ const FcCharSet * @ARG2@ b
73@PURPOSE@ Subtract charsets
74@DESC@
75Returns a set including only those chars found in <parameter>a</parameter> but not <parameter>b</parameter>.
76@@
77
78@RET@ FcBool
79@FUNC@ FcCharSetHasChar
80@TYPE1@ const FcCharSet * @ARG1@ fcs
81@TYPE2@ FcChar32 @ARG2@ ucs4
82@PURPOSE@ Check a charset for a char
83@DESC@
84Returns whether <parameter>fcs</parameter> contains the char <parameter>ucs4</parameter>.
85@@
86
87@RET@ FcChar32
88@FUNC@ FcCharSetCount
89@TYPE1@ const FcCharSet * @ARG1@ a
90@PURPOSE@ Count entries in a charset
91@DESC@
92Returns the total number of unicode chars in <parameter>a</parameter>.
93@@
94
95@RET@ FcChar32
96@FUNC@ FcCharSetIntersectCount
97@TYPE1@ const FcCharSet * @ARG1@ a
98@TYPE2@ const FcCharSet * @ARG2@ b
99@PURPOSE@ Intersect and count charsets
100@DESC@
101Returns the number of chars that are in both <parameter>a</parameter> and <parameter>b</parameter>.
102@@
103
104@RET@ FcChar32
105@FUNC@ FcCharSetSubtractCount
106@TYPE1@ const FcCharSet * @ARG1@ a
107@TYPE2@ const FcCharSet * @ARG2@ b
108@PURPOSE@ Subtract and count charsets
109@DESC@
110Returns the number of chars that are in <parameter>a</parameter> but not in <parameter>b</parameter>.
111@@
112
113@RET@ FcBool
114@FUNC@ FcCharSetIsSubset
115@TYPE1@ const FcCharSet * @ARG1@ a
116@TYPE2@ const FcCharSet * @ARG2@ b
117@PURPOSE@ Test for charset inclusion
118@DESC@
119Returns whether <parameter>a</parameter> is a subset of <parameter>b</parameter>.
120@@
121
122@RET@ FcChar32
123@FUNC@ FcCharSetFirstPage
124@TYPE1@ const FcCharSet * @ARG1@ a
125@TYPE2@ FcChar32[FC_CHARSET_MAP_SIZE] @ARG2@ map
126@TYPE3@ FcChar32 * @ARG3@ next
127@PURPOSE@ Start enumerating charset contents
128@DESC@
129Builds an array of bits marking the first page of Unicode coverage of
130<parameter>a</parameter>. Returns the base of the array. <parameter>next</parameter> contains the next page in the
131font.
132@@
133
134@RET@ FcChar32
135@FUNC@ FcCharSetNextPage
136@TYPE1@ const FcCharSet * @ARG1@ a
137@TYPE2@ FcChar32[FC_CHARSET_MAP_SIZE] @ARG2@ map
138@TYPE3@ FcChar32 * @ARG3@ next
139@PURPOSE@ Continue enumerating charset contents
140@DESC@
141Builds an array of bits marking the Unicode coverage of <parameter>a</parameter> for page
142<parameter>*next</parameter>. Returns the base of the array. <parameter>next</parameter> contains the next page in
143the font.
144@@