Imported Upstream version 2.6.4
[platform/upstream/harfbuzz.git] / docs / html / harfbuzz-hb-deprecated.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>hb-deprecated: HarfBuzz Manual</title>
6 <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
7 <link rel="home" href="index.html" title="HarfBuzz Manual">
8 <link rel="up" href="ch11.html" title="Core API">
9 <link rel="prev" href="harfbuzz-hb-common.html" title="hb-common">
10 <link rel="next" href="harfbuzz-hb-face.html" title="hb-face">
11 <meta name="generator" content="GTK-Doc V1.29 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16 <td width="100%" align="left" class="shortcuts">
17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
18                   <a href="#harfbuzz-hb-deprecated.description" class="shortcut">Description</a></span>
19 </td>
20 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
21 <td><a accesskey="u" href="ch11.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
22 <td><a accesskey="p" href="harfbuzz-hb-common.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
23 <td><a accesskey="n" href="harfbuzz-hb-face.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
24 </tr></table>
25 <div class="refentry">
26 <a name="harfbuzz-hb-deprecated"></a><div class="titlepage"></div>
27 <div class="refnamediv"><table width="100%"><tr>
28 <td valign="top">
29 <h2><span class="refentrytitle"><a name="harfbuzz-hb-deprecated.top_of_page"></a>hb-deprecated</span></h2>
30 <p>hb-deprecated — Deprecated API</p>
31 </td>
32 <td class="gallery_image" valign="top" align="right"></td>
33 </tr></table></div>
34 <div class="refsect1">
35 <a name="harfbuzz-hb-deprecated.functions"></a><h2>Functions</h2>
36 <div class="informaltable"><table class="informaltable" width="100%" border="0">
37 <colgroup>
38 <col width="150px" class="functions_return">
39 <col class="functions_name">
40 </colgroup>
41 <tbody>
42 <tr>
43 <td class="function_type">
44 <a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
45 </td>
46 <td class="function_name">
47 <span class="c_punctuation">(</span><a class="link" href="harfbuzz-hb-deprecated.html#hb-font-get-glyph-func-t" title="hb_font_get_glyph_func_t ()">*hb_font_get_glyph_func_t</a><span class="c_punctuation">)</span> <span class="c_punctuation">()</span>
48 </td>
49 </tr>
50 <tr>
51 <td class="function_type">
52 <a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
53 </td>
54 <td class="function_name">
55 <a class="link" href="harfbuzz-hb-deprecated.html#hb-ot-layout-table-find-script" title="hb_ot_layout_table_find_script ()">hb_ot_layout_table_find_script</a> <span class="c_punctuation">()</span>
56 </td>
57 </tr>
58 <tr>
59 <td class="function_type">
60 <span class="returnvalue">void</span>
61 </td>
62 <td class="function_name">
63 <a class="link" href="harfbuzz-hb-deprecated.html#hb-font-funcs-set-glyph-v-kerning-func" title="hb_font_funcs_set_glyph_v_kerning_func ()">hb_font_funcs_set_glyph_v_kerning_func</a> <span class="c_punctuation">()</span>
64 </td>
65 </tr>
66 <tr>
67 <td class="function_type">
68 <a class="link" href="harfbuzz-hb-common.html#hb-position-t" title="hb_position_t"><span class="returnvalue">hb_position_t</span></a>
69 </td>
70 <td class="function_name">
71 <a class="link" href="harfbuzz-hb-deprecated.html#hb-font-get-glyph-v-kerning" title="hb_font_get_glyph_v_kerning ()">hb_font_get_glyph_v_kerning</a> <span class="c_punctuation">()</span>
72 </td>
73 </tr>
74 </tbody>
75 </table></div>
76 </div>
77 <div class="refsect1">
78 <a name="harfbuzz-hb-deprecated.other"></a><h2>Types and Values</h2>
79 <div class="informaltable"><table class="informaltable" width="100%" border="0">
80 <colgroup>
81 <col width="150px" class="name">
82 <col class="description">
83 </colgroup>
84 <tbody>
85 <tr>
86 <td class="define_keyword">#define</td>
87 <td class="function_name"><a class="link" href="harfbuzz-hb-deprecated.html#HB-BUFFER-FLAGS-DEFAULT:CAPS" title="HB_BUFFER_FLAGS_DEFAULT">HB_BUFFER_FLAGS_DEFAULT</a></td>
88 </tr>
89 <tr>
90 <td class="define_keyword">#define</td>
91 <td class="function_name"><a class="link" href="harfbuzz-hb-deprecated.html#HB-BUFFER-SERIALIZE-FLAGS-DEFAULT:CAPS" title="HB_BUFFER_SERIALIZE_FLAGS_DEFAULT">HB_BUFFER_SERIALIZE_FLAGS_DEFAULT</a></td>
92 </tr>
93 <tr>
94 <td class="define_keyword">#define</td>
95 <td class="function_name"><a class="link" href="harfbuzz-hb-deprecated.html#HB-SCRIPT-CANADIAN-ABORIGINAL:CAPS" title="HB_SCRIPT_CANADIAN_ABORIGINAL">HB_SCRIPT_CANADIAN_ABORIGINAL</a></td>
96 </tr>
97 <tr>
98 <td class="define_keyword">#define</td>
99 <td class="function_name"><a class="link" href="harfbuzz-hb-deprecated.html#HB-MATH-GLYPH-PART-FLAG-EXTENDER:CAPS" title="HB_MATH_GLYPH_PART_FLAG_EXTENDER">HB_MATH_GLYPH_PART_FLAG_EXTENDER</a></td>
100 </tr>
101 <tr>
102 <td class="define_keyword">#define</td>
103 <td class="function_name"><a class="link" href="harfbuzz-hb-deprecated.html#HB-OT-VAR-NO-AXIS-INDEX:CAPS" title="HB_OT_VAR_NO_AXIS_INDEX">HB_OT_VAR_NO_AXIS_INDEX</a></td>
104 </tr>
105 <tr>
106 <td class="define_keyword">#define</td>
107 <td class="function_name"><a class="link" href="harfbuzz-hb-deprecated.html#HB-UNICODE-MAX-DECOMPOSITION-LEN:CAPS" title="HB_UNICODE_MAX_DECOMPOSITION_LEN">HB_UNICODE_MAX_DECOMPOSITION_LEN</a></td>
108 </tr>
109 <tr>
110 <td class="typedef_keyword">typedef</td>
111 <td class="function_name"><a class="link" href="harfbuzz-hb-deprecated.html#hb-font-get-glyph-v-kerning-func-t" title="hb_font_get_glyph_v_kerning_func_t">hb_font_get_glyph_v_kerning_func_t</a></td>
112 </tr>
113 </tbody>
114 </table></div>
115 </div>
116 <div class="refsect1">
117 <a name="harfbuzz-hb-deprecated.includes"></a><h2>Includes</h2>
118 <pre class="synopsis">#include &lt;hb.h&gt;
119 </pre>
120 </div>
121 <div class="refsect1">
122 <a name="harfbuzz-hb-deprecated.description"></a><h2>Description</h2>
123 <p>These API have been deprecated in favor of newer API, or because they
124 were deemed unnecessary.</p>
125 </div>
126 <div class="refsect1">
127 <a name="harfbuzz-hb-deprecated.functions_details"></a><h2>Functions</h2>
128 <div class="refsect2">
129 <a name="hb-font-get-glyph-func-t"></a><h3>hb_font_get_glyph_func_t ()</h3>
130 <pre class="programlisting"><a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
131 <span class="c_punctuation">(</span>*hb_font_get_glyph_func_t<span class="c_punctuation">)</span> (<em class="parameter"><code><a class="link" href="harfbuzz-hb-font.html#hb-font-t"><span class="type">hb_font_t</span></a> *font</code></em>,
132                              <em class="parameter"><code><span class="type">void</span> *font_data</code></em>,
133                              <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-codepoint-t" title="hb_codepoint_t"><span class="type">hb_codepoint_t</span></a> unicode</code></em>,
134                              <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-codepoint-t" title="hb_codepoint_t"><span class="type">hb_codepoint_t</span></a> variation_selector</code></em>,
135                              <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-codepoint-t" title="hb_codepoint_t"><span class="type">hb_codepoint_t</span></a> *glyph</code></em>,
136                              <em class="parameter"><code><span class="type">void</span> *user_data</code></em>);</pre>
137 <div class="warning"><p><code class="literal">hb_font_get_glyph_func_t</code> is deprecated and should not be used in newly-written code.</p></div>
138 </div>
139 <hr>
140 <div class="refsect2">
141 <a name="hb-ot-layout-table-find-script"></a><h3>hb_ot_layout_table_find_script ()</h3>
142 <pre class="programlisting"><a class="link" href="harfbuzz-hb-common.html#hb-bool-t" title="hb_bool_t"><span class="returnvalue">hb_bool_t</span></a>
143 hb_ot_layout_table_find_script (<em class="parameter"><code><a class="link" href="harfbuzz-hb-face.html#hb-face-t"><span class="type">hb_face_t</span></a> *face</code></em>,
144                                 <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-tag-t" title="hb_tag_t"><span class="type">hb_tag_t</span></a> table_tag</code></em>,
145                                 <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-tag-t" title="hb_tag_t"><span class="type">hb_tag_t</span></a> script_tag</code></em>,
146                                 <em class="parameter"><code>unsigned <span class="type">int</span> *script_index</code></em>);</pre>
147 <p>Fetches the index if a given script tag in the specified face's GSUB table
148 or GPOS table.</p>
149 <div class="refsect3">
150 <a name="hb-ot-layout-table-find-script.parameters"></a><h4>Parameters</h4>
151 <div class="informaltable"><table class="informaltable" width="100%" border="0">
152 <colgroup>
153 <col width="150px" class="parameters_name">
154 <col class="parameters_description">
155 <col width="200px" class="parameters_annotations">
156 </colgroup>
157 <tbody>
158 <tr>
159 <td class="parameter_name"><p>face</p></td>
160 <td class="parameter_description"><p><a class="link" href="harfbuzz-hb-face.html#hb-face-t"><span class="type">hb_face_t</span></a> to work upon</p></td>
161 <td class="parameter_annotations"> </td>
162 </tr>
163 <tr>
164 <td class="parameter_name"><p>table_tag</p></td>
165 <td class="parameter_description"><p>HB_OT_TAG_GSUB or HB_OT_TAG_GPOS</p></td>
166 <td class="parameter_annotations"> </td>
167 </tr>
168 <tr>
169 <td class="parameter_name"><p>script_tag</p></td>
170 <td class="parameter_description"><p><a class="link" href="harfbuzz-hb-common.html#hb-tag-t" title="hb_tag_t"><span class="type">hb_tag_t</span></a> of the script tag requested</p></td>
171 <td class="parameter_annotations"> </td>
172 </tr>
173 <tr>
174 <td class="parameter_name"><p>script_index</p></td>
175 <td class="parameter_description"><p>The index of the requested script tag. </p></td>
176 <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span></td>
177 </tr>
178 </tbody>
179 </table></div>
180 </div>
181 <div class="refsect3">
182 <a name="hb-ot-layout-table-find-script.returns"></a><h4>Returns</h4>
183 <p> true if the script is found, false otherwise</p>
184 </div>
185 </div>
186 <hr>
187 <div class="refsect2">
188 <a name="hb-font-funcs-set-glyph-v-kerning-func"></a><h3>hb_font_funcs_set_glyph_v_kerning_func ()</h3>
189 <pre class="programlisting"><span class="returnvalue">void</span>
190 hb_font_funcs_set_glyph_v_kerning_func
191                                (<em class="parameter"><code><a class="link" href="harfbuzz-hb-font.html#hb-font-funcs-t"><span class="type">hb_font_funcs_t</span></a> *ffuncs</code></em>,
192                                 <em class="parameter"><code><a class="link" href="harfbuzz-hb-deprecated.html#hb-font-get-glyph-v-kerning-func-t" title="hb_font_get_glyph_v_kerning_func_t"><span class="type">hb_font_get_glyph_v_kerning_func_t</span></a> func</code></em>,
193                                 <em class="parameter"><code><span class="type">void</span> *user_data</code></em>,
194                                 <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-destroy-func-t" title="hb_destroy_func_t ()"><span class="type">hb_destroy_func_t</span></a> destroy</code></em>);</pre>
195 <div class="warning"><p><code class="literal">hb_font_funcs_set_glyph_v_kerning_func</code> has been deprecated since version 2.0.0 and should not be used in newly-written code.</p></div>
196 <div class="refsect3">
197 <a name="hb-font-funcs-set-glyph-v-kerning-func.parameters"></a><h4>Parameters</h4>
198 <div class="informaltable"><table class="informaltable" width="100%" border="0">
199 <colgroup>
200 <col width="150px" class="parameters_name">
201 <col class="parameters_description">
202 <col width="200px" class="parameters_annotations">
203 </colgroup>
204 <tbody>
205 <tr>
206 <td class="parameter_name"><p>ffuncs</p></td>
207 <td class="parameter_description"><p>font functions.</p></td>
208 <td class="parameter_annotations"> </td>
209 </tr>
210 <tr>
211 <td class="parameter_name"><p>func</p></td>
212 <td class="parameter_description"><p>. </p></td>
213 <td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym> user_data][<acronym title="This parameter is a 'destroy_data', for callbacks."><span class="acronym">destroy</span></acronym> destroy][<acronym title="The callback is valid until the GDestroyNotify argument is called."><span class="acronym">scope notified</span></acronym>]</span></td>
214 </tr>
215 </tbody>
216 </table></div>
217 </div>
218 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
219 </div>
220 <hr>
221 <div class="refsect2">
222 <a name="hb-font-get-glyph-v-kerning"></a><h3>hb_font_get_glyph_v_kerning ()</h3>
223 <pre class="programlisting"><a class="link" href="harfbuzz-hb-common.html#hb-position-t" title="hb_position_t"><span class="returnvalue">hb_position_t</span></a>
224 hb_font_get_glyph_v_kerning (<em class="parameter"><code><a class="link" href="harfbuzz-hb-font.html#hb-font-t"><span class="type">hb_font_t</span></a> *font</code></em>,
225                              <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-codepoint-t" title="hb_codepoint_t"><span class="type">hb_codepoint_t</span></a> top_glyph</code></em>,
226                              <em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-codepoint-t" title="hb_codepoint_t"><span class="type">hb_codepoint_t</span></a> bottom_glyph</code></em>);</pre>
227 <div class="warning"><p><code class="literal">hb_font_get_glyph_v_kerning</code> has been deprecated since version 2.0.0 and should not be used in newly-written code.</p></div>
228 <div class="refsect3">
229 <a name="hb-font-get-glyph-v-kerning.parameters"></a><h4>Parameters</h4>
230 <div class="informaltable"><table class="informaltable" width="100%" border="0">
231 <colgroup>
232 <col width="150px" class="parameters_name">
233 <col class="parameters_description">
234 <col width="200px" class="parameters_annotations">
235 </colgroup>
236 <tbody><tr>
237 <td class="parameter_name"><p>font</p></td>
238 <td class="parameter_description"><p>a font.</p></td>
239 <td class="parameter_annotations"> </td>
240 </tr></tbody>
241 </table></div>
242 </div>
243 <p class="since">Since: <a class="link" href="api-index-0-9-2.html#api-index-0.9.2">0.9.2</a></p>
244 </div>
245 </div>
246 <div class="refsect1">
247 <a name="harfbuzz-hb-deprecated.other_details"></a><h2>Types and Values</h2>
248 <div class="refsect2">
249 <a name="HB-BUFFER-FLAGS-DEFAULT:CAPS"></a><h3>HB_BUFFER_FLAGS_DEFAULT</h3>
250 <pre class="programlisting">#define HB_BUFFER_FLAGS_DEFAULT                     HB_BUFFER_FLAG_DEFAULT
251 </pre>
252 <div class="warning"><p><code class="literal">HB_BUFFER_FLAGS_DEFAULT</code> is deprecated and should not be used in newly-written code.</p></div>
253 </div>
254 <hr>
255 <div class="refsect2">
256 <a name="HB-BUFFER-SERIALIZE-FLAGS-DEFAULT:CAPS"></a><h3>HB_BUFFER_SERIALIZE_FLAGS_DEFAULT</h3>
257 <pre class="programlisting">#define HB_BUFFER_SERIALIZE_FLAGS_DEFAULT HB_BUFFER_SERIALIZE_FLAG_DEFAULT
258 </pre>
259 <div class="warning"><p><code class="literal">HB_BUFFER_SERIALIZE_FLAGS_DEFAULT</code> is deprecated and should not be used in newly-written code.</p></div>
260 </div>
261 <hr>
262 <div class="refsect2">
263 <a name="HB-SCRIPT-CANADIAN-ABORIGINAL:CAPS"></a><h3>HB_SCRIPT_CANADIAN_ABORIGINAL</h3>
264 <pre class="programlisting">#define HB_SCRIPT_CANADIAN_ABORIGINAL               HB_SCRIPT_CANADIAN_SYLLABICS
265 </pre>
266 <div class="warning"><p><code class="literal">HB_SCRIPT_CANADIAN_ABORIGINAL</code> is deprecated and should not be used in newly-written code.</p></div>
267 </div>
268 <hr>
269 <div class="refsect2">
270 <a name="HB-MATH-GLYPH-PART-FLAG-EXTENDER:CAPS"></a><h3>HB_MATH_GLYPH_PART_FLAG_EXTENDER</h3>
271 <pre class="programlisting">#define HB_MATH_GLYPH_PART_FLAG_EXTENDER HB_OT_MATH_GLYPH_PART_FLAG_EXTENDER
272 </pre>
273 <div class="warning"><p><code class="literal">HB_MATH_GLYPH_PART_FLAG_EXTENDER</code> is deprecated and should not be used in newly-written code.</p></div>
274 </div>
275 <hr>
276 <div class="refsect2">
277 <a name="HB-OT-VAR-NO-AXIS-INDEX:CAPS"></a><h3>HB_OT_VAR_NO_AXIS_INDEX</h3>
278 <pre class="programlisting">#define HB_OT_VAR_NO_AXIS_INDEX             0xFFFFFFFFu
279 </pre>
280 <div class="warning"><p><code class="literal">HB_OT_VAR_NO_AXIS_INDEX</code> has been deprecated since version 2.2.0 and should not be used in newly-written code.</p></div>
281 <p class="since">Since: <a class="link" href="api-index-1-4-2.html#api-index-1.4.2">1.4.2</a></p>
282 </div>
283 <hr>
284 <div class="refsect2">
285 <a name="HB-UNICODE-MAX-DECOMPOSITION-LEN:CAPS"></a><h3>HB_UNICODE_MAX_DECOMPOSITION_LEN</h3>
286 <pre class="programlisting">#define HB_UNICODE_MAX_DECOMPOSITION_LEN (18+1) /* codepoints */
287 </pre>
288 <div class="warning"><p><code class="literal">HB_UNICODE_MAX_DECOMPOSITION_LEN</code> has been deprecated since version 2.0.0 and should not be used in newly-written code.</p></div>
289 <p>See Unicode 6.1 for details on the maximum decomposition length.</p>
290 </div>
291 <hr>
292 <div class="refsect2">
293 <a name="hb-font-get-glyph-v-kerning-func-t"></a><h3>hb_font_get_glyph_v_kerning_func_t</h3>
294 <pre class="programlisting">typedef hb_font_get_glyph_kerning_func_t hb_font_get_glyph_v_kerning_func_t;
295 </pre>
296 <div class="warning"><p><code class="literal">hb_font_get_glyph_v_kerning_func_t</code> is deprecated and should not be used in newly-written code.</p></div>
297 </div>
298 </div>
299 </div>
300 <div class="footer">
301 <hr>Generated by GTK-Doc V1.29</div>
302 </body>
303 </html>