Imported Upstream version 2.6.7
[platform/upstream/harfbuzz.git] / docs / html / harfbuzz-hb-icu.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-icu: 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="ch15.html" title="Integration API">
9 <link rel="prev" href="harfbuzz-hb-graphite2.html" title="hb-graphite2">
10 <link rel="next" href="harfbuzz-hb-uniscribe.html" title="hb-uniscribe">
11 <meta name="generator" content="GTK-Doc V1.32.1 (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-icu.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="ch15.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
22 <td><a accesskey="p" href="harfbuzz-hb-graphite2.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
23 <td><a accesskey="n" href="harfbuzz-hb-uniscribe.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-icu"></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-icu.top_of_page"></a>hb-icu</span></h2>
30 <p>hb-icu — ICU integration</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-icu.functions"></a><h2>Functions</h2>
36 <div class="informaltable"><table class="informaltable" width="100%" border="0">
37 <colgroup>
38 <col width="150px" class="functions_proto_type">
39 <col class="functions_proto_name">
40 </colgroup>
41 <tbody>
42 <tr>
43 <td class="function_type">
44 <a class="link" href="harfbuzz-hb-unicode.html#hb-unicode-funcs-t" title="hb_unicode_funcs_t"><span class="returnvalue">hb_unicode_funcs_t</span></a> *
45 </td>
46 <td class="function_name">
47 <a class="link" href="harfbuzz-hb-icu.html#hb-icu-get-unicode-funcs" title="hb_icu_get_unicode_funcs ()">hb_icu_get_unicode_funcs</a> <span class="c_punctuation">()</span>
48 </td>
49 </tr>
50 <tr>
51 <td class="function_type">
52 <span class="returnvalue">UScriptCode</span>
53 </td>
54 <td class="function_name">
55 <a class="link" href="harfbuzz-hb-icu.html#hb-icu-script-from-script" title="hb_icu_script_from_script ()">hb_icu_script_from_script</a> <span class="c_punctuation">()</span>
56 </td>
57 </tr>
58 <tr>
59 <td class="function_type">
60 <a class="link" href="harfbuzz-hb-common.html#hb-script-t" title="enum hb_script_t"><span class="returnvalue">hb_script_t</span></a>
61 </td>
62 <td class="function_name">
63 <a class="link" href="harfbuzz-hb-icu.html#hb-icu-script-to-script" title="hb_icu_script_to_script ()">hb_icu_script_to_script</a> <span class="c_punctuation">()</span>
64 </td>
65 </tr>
66 </tbody>
67 </table></div>
68 </div>
69 <div class="refsect1">
70 <a name="harfbuzz-hb-icu.includes"></a><h2>Includes</h2>
71 <pre class="synopsis">#include &lt;hb-icu.h&gt;
72 </pre>
73 </div>
74 <div class="refsect1">
75 <a name="harfbuzz-hb-icu.description"></a><h2>Description</h2>
76 <p>Functions for using HarfBuzz with the International Components for Unicode
77 (ICU) library. HarfBuzz supports using ICU to provide Unicode data, by attaching
78 ICU functions to the virtual methods in a <a class="link" href="harfbuzz-hb-unicode.html#hb-unicode-funcs-t" title="hb_unicode_funcs_t"><span class="type">hb_unicode_funcs_t</span></a> function
79 structure.</p>
80 </div>
81 <div class="refsect1">
82 <a name="harfbuzz-hb-icu.functions_details"></a><h2>Functions</h2>
83 <div class="refsect2">
84 <a name="hb-icu-get-unicode-funcs"></a><h3>hb_icu_get_unicode_funcs ()</h3>
85 <pre class="programlisting"><a class="link" href="harfbuzz-hb-unicode.html#hb-unicode-funcs-t" title="hb_unicode_funcs_t"><span class="returnvalue">hb_unicode_funcs_t</span></a> *
86 hb_icu_get_unicode_funcs (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
87 <p>Fetches a Unicode-functions structure that is populated
88 with the appropriate ICU function for each method.</p>
89 <div class="refsect3">
90 <a name="hb-icu-get-unicode-funcs.returns"></a><h4>Returns</h4>
91 <p>a pointer to the <a class="link" href="harfbuzz-hb-unicode.html#hb-unicode-funcs-t" title="hb_unicode_funcs_t"><span class="type">hb_unicode_funcs_t</span></a> Unicode-functions structure. </p>
92 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
93 </div>
94 <p class="since">Since: <a class="link" href="api-index-0-9-38.html#api-index-0.9.38">0.9.38</a></p>
95 </div>
96 <hr>
97 <div class="refsect2">
98 <a name="hb-icu-script-from-script"></a><h3>hb_icu_script_from_script ()</h3>
99 <pre class="programlisting"><span class="returnvalue">UScriptCode</span>
100 hb_icu_script_from_script (<em class="parameter"><code><a class="link" href="harfbuzz-hb-common.html#hb-script-t" title="enum hb_script_t"><span class="type">hb_script_t</span></a> script</code></em>);</pre>
101 <p>Fetches the UScriptCode identifier that corresponds to the
102 specified <a class="link" href="harfbuzz-hb-common.html#hb-script-t" title="enum hb_script_t"><span class="type">hb_script_t</span></a> script.</p>
103 <div class="refsect3">
104 <a name="hb-icu-script-from-script.parameters"></a><h4>Parameters</h4>
105 <div class="informaltable"><table class="informaltable" width="100%" border="0">
106 <colgroup>
107 <col width="150px" class="parameters_name">
108 <col class="parameters_description">
109 <col width="200px" class="parameters_annotations">
110 </colgroup>
111 <tbody><tr>
112 <td class="parameter_name"><p>script</p></td>
113 <td class="parameter_description"><p>The <a class="link" href="harfbuzz-hb-common.html#hb-script-t" title="enum hb_script_t"><span class="type">hb_script_t</span></a> script to query</p></td>
114 <td class="parameter_annotations"> </td>
115 </tr></tbody>
116 </table></div>
117 </div>
118 <div class="refsect3">
119 <a name="hb-icu-script-from-script.returns"></a><h4>Returns</h4>
120 <p> the UScriptCode identifier found</p>
121 </div>
122 </div>
123 <hr>
124 <div class="refsect2">
125 <a name="hb-icu-script-to-script"></a><h3>hb_icu_script_to_script ()</h3>
126 <pre class="programlisting"><a class="link" href="harfbuzz-hb-common.html#hb-script-t" title="enum hb_script_t"><span class="returnvalue">hb_script_t</span></a>
127 hb_icu_script_to_script (<em class="parameter"><code><span class="type">UScriptCode</span> script</code></em>);</pre>
128 <p>Fetches the <a class="link" href="harfbuzz-hb-common.html#hb-script-t" title="enum hb_script_t"><span class="type">hb_script_t</span></a> script that corresponds to the
129 specified UScriptCode identifier.</p>
130 <div class="refsect3">
131 <a name="hb-icu-script-to-script.parameters"></a><h4>Parameters</h4>
132 <div class="informaltable"><table class="informaltable" width="100%" border="0">
133 <colgroup>
134 <col width="150px" class="parameters_name">
135 <col class="parameters_description">
136 <col width="200px" class="parameters_annotations">
137 </colgroup>
138 <tbody><tr>
139 <td class="parameter_name"><p>script</p></td>
140 <td class="parameter_description"><p>The UScriptCode identifier to query</p></td>
141 <td class="parameter_annotations"> </td>
142 </tr></tbody>
143 </table></div>
144 </div>
145 <div class="refsect3">
146 <a name="hb-icu-script-to-script.returns"></a><h4>Returns</h4>
147 <p> the <a class="link" href="harfbuzz-hb-common.html#hb-script-t" title="enum hb_script_t"><span class="type">hb_script_t</span></a> script found</p>
148 </div>
149 </div>
150 </div>
151 </div>
152 <div class="footer">
153 <hr>Generated by GTK-Doc V1.32.1</div>
154 </body>
155 </html>