Change script name following numbering policy
[platform/upstream/fontconfig.git] / doc / fcblanks.sgml
1 <!--
2    fontconfig/doc/func.sgml
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     <refentry id="FcBlanksCreate">
25         <refmeta>
26             <refentrytitle>FcBlanksCreate</refentrytitle>
27             <manvolnum>3</manvolnum>
28             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
29         </refmeta>
30         <refnamediv>
31             <refname>FcBlanksCreate</refname>
32             <refpurpose>Create an FcBlanks</refpurpose>
33         </refnamediv>
34         <refsynopsisdiv>
35         <funcsynopsis>
36         <funcsynopsisinfo>
37 #include &lt;fontconfig/fontconfig.h&gt;
38         </funcsynopsisinfo>
39         <funcprototype>
40             <funcdef>FcBlanks * <function>FcBlanksCreate</function></funcdef>
41                 <paramdef>void<parameter></parameter></paramdef>
42         </funcprototype>
43         </funcsynopsis>
44         </refsynopsisdiv>
45         <refsect1><title>Description</title>
46             <para>
47 Creates an empty FcBlanks object.
48             </para>
49         </refsect1>
50     </refentry>
51 <!--
52    fontconfig/doc/func.sgml
53   
54    Copyright © 2003 Keith Packard
55   
56    Permission to use, copy, modify, distribute, and sell this software and its
57    documentation for any purpose is hereby granted without fee, provided that
58    the above copyright notice appear in all copies and that both that
59    copyright notice and this permission notice appear in supporting
60    documentation, and that the name of the author(s) not be used in
61    advertising or publicity pertaining to distribution of the software without
62    specific, written prior permission.  The authors make no
63    representations about the suitability of this software for any purpose.  It
64    is provided "as is" without express or implied warranty.
65   
66    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
67    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
68    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
69    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
70    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
71    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
72    PERFORMANCE OF THIS SOFTWARE.
73  -->
74     <refentry id="FcBlanksDestroy">
75         <refmeta>
76             <refentrytitle>FcBlanksDestroy</refentrytitle>
77             <manvolnum>3</manvolnum>
78             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
79         </refmeta>
80         <refnamediv>
81             <refname>FcBlanksDestroy</refname>
82             <refpurpose>Destroy and FcBlanks</refpurpose>
83         </refnamediv>
84         <refsynopsisdiv>
85         <funcsynopsis>
86         <funcsynopsisinfo>
87 #include &lt;fontconfig/fontconfig.h&gt;
88         </funcsynopsisinfo>
89         <funcprototype>
90             <funcdef>void <function>FcBlanksDestroy</function></funcdef>
91                 <paramdef>FcBlanks *<parameter>b</parameter></paramdef>
92         </funcprototype>
93         </funcsynopsis>
94         </refsynopsisdiv>
95         <refsect1><title>Description</title>
96             <para>
97 Destroys an FcBlanks object, freeing any associated memory.
98             </para>
99         </refsect1>
100     </refentry>
101 <!--
102    fontconfig/doc/func.sgml
103   
104    Copyright © 2003 Keith Packard
105   
106    Permission to use, copy, modify, distribute, and sell this software and its
107    documentation for any purpose is hereby granted without fee, provided that
108    the above copyright notice appear in all copies and that both that
109    copyright notice and this permission notice appear in supporting
110    documentation, and that the name of the author(s) not be used in
111    advertising or publicity pertaining to distribution of the software without
112    specific, written prior permission.  The authors make no
113    representations about the suitability of this software for any purpose.  It
114    is provided "as is" without express or implied warranty.
115   
116    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
117    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
118    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
119    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
120    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
121    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
122    PERFORMANCE OF THIS SOFTWARE.
123  -->
124     <refentry id="FcBlanksAdd">
125         <refmeta>
126             <refentrytitle>FcBlanksAdd</refentrytitle>
127             <manvolnum>3</manvolnum>
128             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
129         </refmeta>
130         <refnamediv>
131             <refname>FcBlanksAdd</refname>
132             <refpurpose>Add a character to an FcBlanks</refpurpose>
133         </refnamediv>
134         <refsynopsisdiv>
135         <funcsynopsis>
136         <funcsynopsisinfo>
137 #include &lt;fontconfig/fontconfig.h&gt;
138         </funcsynopsisinfo>
139         <funcprototype>
140             <funcdef>FcBool <function>FcBlanksAdd</function></funcdef>
141                 <paramdef>FcBlanks *<parameter>b</parameter></paramdef>
142                 <paramdef>FcChar32 <parameter>ucs4</parameter></paramdef>
143         </funcprototype>
144         </funcsynopsis>
145         </refsynopsisdiv>
146         <refsect1><title>Description</title>
147             <para>
148 Adds a single character to an FcBlanks object, returning FcFalse
149 if this process ran out of memory.
150             </para>
151         </refsect1>
152     </refentry>
153 <!--
154    fontconfig/doc/func.sgml
155   
156    Copyright © 2003 Keith Packard
157   
158    Permission to use, copy, modify, distribute, and sell this software and its
159    documentation for any purpose is hereby granted without fee, provided that
160    the above copyright notice appear in all copies and that both that
161    copyright notice and this permission notice appear in supporting
162    documentation, and that the name of the author(s) not be used in
163    advertising or publicity pertaining to distribution of the software without
164    specific, written prior permission.  The authors make no
165    representations about the suitability of this software for any purpose.  It
166    is provided "as is" without express or implied warranty.
167   
168    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
169    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
170    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
171    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
172    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
173    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
174    PERFORMANCE OF THIS SOFTWARE.
175  -->
176     <refentry id="FcBlanksIsMember">
177         <refmeta>
178             <refentrytitle>FcBlanksIsMember</refentrytitle>
179             <manvolnum>3</manvolnum>
180             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
181         </refmeta>
182         <refnamediv>
183             <refname>FcBlanksIsMember</refname>
184             <refpurpose>Query membership in an FcBlanks</refpurpose>
185         </refnamediv>
186         <refsynopsisdiv>
187         <funcsynopsis>
188         <funcsynopsisinfo>
189 #include &lt;fontconfig/fontconfig.h&gt;
190         </funcsynopsisinfo>
191         <funcprototype>
192             <funcdef>FcBool <function>FcBlanksIsMember</function></funcdef>
193                 <paramdef>FcBlanks *<parameter>b</parameter></paramdef>
194                 <paramdef>FcChar32 <parameter>ucs4</parameter></paramdef>
195         </funcprototype>
196         </funcsynopsis>
197         </refsynopsisdiv>
198         <refsect1><title>Description</title>
199             <para>
200 Returns whether the specified FcBlanks object contains the indicated Unicode
201 value.
202             </para>
203         </refsect1>
204     </refentry>