08d6be0bfdc5422a62466475d17564858144e8d4
[platform/upstream/fontconfig.git] / doc / fcrange.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="FcRangeCopy">
25         <refmeta>
26             <refentrytitle>FcRangeCopy</refentrytitle>
27             <manvolnum>3</manvolnum>
28             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
29         </refmeta>
30         <refnamediv>
31             <refname>FcRangeCopy</refname>
32             <refpurpose>Copy a range object</refpurpose>
33         </refnamediv>
34         <refsynopsisdiv>
35         <funcsynopsis>
36         <funcsynopsisinfo>
37 #include &lt;fontconfig/fontconfig.h&gt;
38         </funcsynopsisinfo>
39         <funcprototype>
40             <funcdef>FcRange * <function>FcRangeCopy</function></funcdef>
41                 <paramdef>const FcRange *<parameter>range</parameter></paramdef>
42         </funcprototype>
43         </funcsynopsis>
44         </refsynopsisdiv>
45         <refsect1><title>Description</title>
46             <para>
47 <function>FcRangeCopy</function> creates a new FcRange object and
48 populates it with the contents of <parameter>range</parameter>.
49             </para>
50         </refsect1>
51         <refsect1><title>Since</title>
52             <para>version 2.11.91</para>
53         </refsect1>
54     </refentry>
55 <!--
56    fontconfig/doc/func.sgml
57   
58    Copyright © 2003 Keith Packard
59   
60    Permission to use, copy, modify, distribute, and sell this software and its
61    documentation for any purpose is hereby granted without fee, provided that
62    the above copyright notice appear in all copies and that both that
63    copyright notice and this permission notice appear in supporting
64    documentation, and that the name of the author(s) not be used in
65    advertising or publicity pertaining to distribution of the software without
66    specific, written prior permission.  The authors make no
67    representations about the suitability of this software for any purpose.  It
68    is provided "as is" without express or implied warranty.
69   
70    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
71    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
72    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
73    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
74    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
75    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
76    PERFORMANCE OF THIS SOFTWARE.
77  -->
78     <refentry id="FcRangeCreateDouble">
79         <refmeta>
80             <refentrytitle>FcRangeCreateDouble</refentrytitle>
81             <manvolnum>3</manvolnum>
82             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
83         </refmeta>
84         <refnamediv>
85             <refname>FcRangeCreateDouble</refname>
86             <refpurpose>create a range object for double</refpurpose>
87         </refnamediv>
88         <refsynopsisdiv>
89         <funcsynopsis>
90         <funcsynopsisinfo>
91 #include &lt;fontconfig/fontconfig.h&gt;
92         </funcsynopsisinfo>
93         <funcprototype>
94             <funcdef>FcRange * <function>FcRangeCreateDouble</function></funcdef>
95                 <paramdef>double<parameter>begin</parameter></paramdef>
96                 <paramdef>double<parameter>end</parameter></paramdef>
97         </funcprototype>
98         </funcsynopsis>
99         </refsynopsisdiv>
100         <refsect1><title>Description</title>
101             <para>
102 <function>FcRangeCreateDouble</function> creates a new FcRange object with
103 double sized value.
104             </para>
105         </refsect1>
106         <refsect1><title>Since</title>
107             <para>version 2.11.91</para>
108         </refsect1>
109     </refentry>
110 <!--
111    fontconfig/doc/func.sgml
112   
113    Copyright © 2003 Keith Packard
114   
115    Permission to use, copy, modify, distribute, and sell this software and its
116    documentation for any purpose is hereby granted without fee, provided that
117    the above copyright notice appear in all copies and that both that
118    copyright notice and this permission notice appear in supporting
119    documentation, and that the name of the author(s) not be used in
120    advertising or publicity pertaining to distribution of the software without
121    specific, written prior permission.  The authors make no
122    representations about the suitability of this software for any purpose.  It
123    is provided "as is" without express or implied warranty.
124   
125    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
126    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
127    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
128    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
129    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
130    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
131    PERFORMANCE OF THIS SOFTWARE.
132  -->
133     <refentry id="FcRangeCreateInteger">
134         <refmeta>
135             <refentrytitle>FcRangeCreateInteger</refentrytitle>
136             <manvolnum>3</manvolnum>
137             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
138         </refmeta>
139         <refnamediv>
140             <refname>FcRangeCreateInteger</refname>
141             <refpurpose>create a range object for integer</refpurpose>
142         </refnamediv>
143         <refsynopsisdiv>
144         <funcsynopsis>
145         <funcsynopsisinfo>
146 #include &lt;fontconfig/fontconfig.h&gt;
147         </funcsynopsisinfo>
148         <funcprototype>
149             <funcdef>FcRange * <function>FcRangeCreateInteger</function></funcdef>
150                 <paramdef>int<parameter>begin</parameter></paramdef>
151                 <paramdef>int<parameter>end</parameter></paramdef>
152         </funcprototype>
153         </funcsynopsis>
154         </refsynopsisdiv>
155         <refsect1><title>Description</title>
156             <para>
157 <function>FcRangeCreateInteger</function> creates a new FcRange object with
158 integer sized value.
159             </para>
160         </refsect1>
161         <refsect1><title>Since</title>
162             <para>version 2.11.91</para>
163         </refsect1>
164     </refentry>
165 <!--
166    fontconfig/doc/func.sgml
167   
168    Copyright © 2003 Keith Packard
169   
170    Permission to use, copy, modify, distribute, and sell this software and its
171    documentation for any purpose is hereby granted without fee, provided that
172    the above copyright notice appear in all copies and that both that
173    copyright notice and this permission notice appear in supporting
174    documentation, and that the name of the author(s) not be used in
175    advertising or publicity pertaining to distribution of the software without
176    specific, written prior permission.  The authors make no
177    representations about the suitability of this software for any purpose.  It
178    is provided "as is" without express or implied warranty.
179   
180    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
181    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
182    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
183    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
184    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
185    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
186    PERFORMANCE OF THIS SOFTWARE.
187  -->
188     <refentry id="FcRangeDestroy">
189         <refmeta>
190             <refentrytitle>FcRangeDestroy</refentrytitle>
191             <manvolnum>3</manvolnum>
192             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
193         </refmeta>
194         <refnamediv>
195             <refname>FcRangeDestroy</refname>
196             <refpurpose>destroy a range object</refpurpose>
197         </refnamediv>
198         <refsynopsisdiv>
199         <funcsynopsis>
200         <funcsynopsisinfo>
201 #include &lt;fontconfig/fontconfig.h&gt;
202         </funcsynopsisinfo>
203         <funcprototype>
204             <funcdef>void <function>FcRangeDestroy</function></funcdef>
205                 <paramdef>FcRange *<parameter>range</parameter></paramdef>
206         </funcprototype>
207         </funcsynopsis>
208         </refsynopsisdiv>
209         <refsect1><title>Description</title>
210             <para>
211 <function>FcRangeDestroy</function> destroys a FcRange object, freeing
212 all memory associated with it.
213             </para>
214         </refsect1>
215         <refsect1><title>Since</title>
216             <para>version 2.11.91</para>
217         </refsect1>
218     </refentry>
219 <!--
220    fontconfig/doc/func.sgml
221   
222    Copyright © 2003 Keith Packard
223   
224    Permission to use, copy, modify, distribute, and sell this software and its
225    documentation for any purpose is hereby granted without fee, provided that
226    the above copyright notice appear in all copies and that both that
227    copyright notice and this permission notice appear in supporting
228    documentation, and that the name of the author(s) not be used in
229    advertising or publicity pertaining to distribution of the software without
230    specific, written prior permission.  The authors make no
231    representations about the suitability of this software for any purpose.  It
232    is provided "as is" without express or implied warranty.
233   
234    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
235    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
236    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
237    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
238    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
239    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
240    PERFORMANCE OF THIS SOFTWARE.
241  -->
242     <refentry id="FcRangeGetDouble">
243         <refmeta>
244             <refentrytitle>FcRangeGetDouble</refentrytitle>
245             <manvolnum>3</manvolnum>
246             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
247         </refmeta>
248         <refnamediv>
249             <refname>FcRangeGetDouble</refname>
250             <refpurpose>Get the range in double</refpurpose>
251         </refnamediv>
252         <refsynopsisdiv>
253         <funcsynopsis>
254         <funcsynopsisinfo>
255 #include &lt;fontconfig/fontconfig.h&gt;
256         </funcsynopsisinfo>
257         <funcprototype>
258             <funcdef>FcBool <function>FcRangeGetDouble</function></funcdef>
259                 <paramdef>const FcRange *<parameter>range</parameter></paramdef>
260                 <paramdef>double *<parameter>begin</parameter></paramdef>
261                 <paramdef>double *<parameter>end</parameter></paramdef>
262         </funcprototype>
263         </funcsynopsis>
264         </refsynopsisdiv>
265         <refsect1><title>Description</title>
266             <para>
267 Returns in <parameter>begin</parameter> and <parameter>end</parameter> as the range.
268             </para>
269         </refsect1>
270         <refsect1><title>Since</title>
271             <para>version 2.11.91</para>
272         </refsect1>
273     </refentry>