docs/html/harfbuzz-hb-glib.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-glib: 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-ft.html" title="hb-ft">
  10 <link rel="next" href="harfbuzz-hb-gobject.html" title="hb-gobject">
  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-glib.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-ft.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  23 <td><a accesskey="n" href="harfbuzz-hb-gobject.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-glib"></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-glib.top_of_page"></a>hb-glib</span></h2>
  30 <p>hb-glib — GLib 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-glib.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-glib.html#hb-glib-get-unicode-funcs" title="hb_glib_get_unicode_funcs ()">hb_glib_get_unicode_funcs</a> <span class="c_punctuation">()</span>
  48 </td>
  49 </tr>
  50 <tr>
  51 <td class="function_type">
  52 <a href="/usr/share/gtk-doc/html/glib/glib-Unicode-Manipulation.html#GUnicodeScript"><span class="returnvalue">GUnicodeScript</span></a>
  53 </td>
  54 <td class="function_name">
  55 <a class="link" href="harfbuzz-hb-glib.html#hb-glib-script-from-script" title="hb_glib_script_from_script ()">hb_glib_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-glib.html#hb-glib-script-to-script" title="hb_glib_script_to_script ()">hb_glib_script_to_script</a> <span class="c_punctuation">()</span>
  64 </td>
  65 </tr>
  66 <tr>
  67 <td class="function_type">
  68 <a class="link" href="harfbuzz-hb-blob.html#hb-blob-t" title="hb_blob_t"><span class="returnvalue">hb_blob_t</span></a> *
  69 </td>
  70 <td class="function_name">
  71 <a class="link" href="harfbuzz-hb-glib.html#hb-glib-blob-create" title="hb_glib_blob_create ()">hb_glib_blob_create</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-glib.includes"></a><h2>Includes</h2>
  79 <pre class="synopsis">#include &lt;hb-glib.h&gt;
  80 </pre>
  81 </div>
  82 <div class="refsect1">
  83 <a name="harfbuzz-hb-glib.description"></a><h2>Description</h2>
  84 <p>Functions for using HarfBuzz with the GLib library. </p>
  85 <p>HarfBuzz supports using GLib to provide Unicode data, by attaching
  86 GLib 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
  87 structure.</p>
  88 </div>
  89 <div class="refsect1">
  90 <a name="harfbuzz-hb-glib.functions_details"></a><h2>Functions</h2>
  91 <div class="refsect2">
  92 <a name="hb-glib-get-unicode-funcs"></a><h3>hb_glib_get_unicode_funcs ()</h3>
  93 <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> *
  94 hb_glib_get_unicode_funcs (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
  95 <p>Fetches a Unicode-functions structure that is populated
  96 with the appropriate GLib function for each method.</p>
  97 <div class="refsect3">
  98 <a name="hb-glib-get-unicode-funcs.returns"></a><h4>Returns</h4>
  99 <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>
 100 <p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
 101 </div>
 102 <p class="since">Since: <a class="link" href="api-index-0-9-38.html#api-index-0.9.38">0.9.38</a></p>
 103 </div>
 104 <hr>
 105 <div class="refsect2">
 106 <a name="hb-glib-script-from-script"></a><h3>hb_glib_script_from_script ()</h3>
 107 <pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Unicode-Manipulation.html#GUnicodeScript"><span class="returnvalue">GUnicodeScript</span></a>
 108 hb_glib_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>
 109 <p>Fetches the GUnicodeScript identifier that corresponds to the
 110 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>
 111 <div class="refsect3">
 112 <a name="hb-glib-script-from-script.parameters"></a><h4>Parameters</h4>
 113 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 114 <colgroup>
 115 <col width="150px" class="parameters_name">
 116 <col class="parameters_description">
 117 <col width="200px" class="parameters_annotations">
 118 </colgroup>
 119 <tbody><tr>
 120 <td class="parameter_name"><p>script</p></td>
 121 <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> to query</p></td>
 122 <td class="parameter_annotations"> </td>
 123 </tr></tbody>
 124 </table></div>
 125 </div>
 126 <div class="refsect3">
 127 <a name="hb-glib-script-from-script.returns"></a><h4>Returns</h4>
 128 <p> the GUnicodeScript identifier found</p>
 129 </div>
 130 <p class="since">Since: <a class="link" href="api-index-0-9-38.html#api-index-0.9.38">0.9.38</a></p>
 131 </div>
 132 <hr>
 133 <div class="refsect2">
 134 <a name="hb-glib-script-to-script"></a><h3>hb_glib_script_to_script ()</h3>
 135 <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>
 136 hb_glib_script_to_script (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Unicode-Manipulation.html#GUnicodeScript"><span class="type">GUnicodeScript</span></a> script</code></em>);</pre>
 137 <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
 138 specified GUnicodeScript identifier.</p>
 139 <div class="refsect3">
 140 <a name="hb-glib-script-to-script.parameters"></a><h4>Parameters</h4>
 141 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 142 <colgroup>
 143 <col width="150px" class="parameters_name">
 144 <col class="parameters_description">
 145 <col width="200px" class="parameters_annotations">
 146 </colgroup>
 147 <tbody><tr>
 148 <td class="parameter_name"><p>script</p></td>
 149 <td class="parameter_description"><p>The GUnicodeScript identifier to query</p></td>
 150 <td class="parameter_annotations"> </td>
 151 </tr></tbody>
 152 </table></div>
 153 </div>
 154 <div class="refsect3">
 155 <a name="hb-glib-script-to-script.returns"></a><h4>Returns</h4>
 156 <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>
 157 </div>
 158 <p class="since">Since: <a class="link" href="api-index-0-9-38.html#api-index-0.9.38">0.9.38</a></p>
 159 </div>
 160 <hr>
 161 <div class="refsect2">
 162 <a name="hb-glib-blob-create"></a><h3>hb_glib_blob_create ()</h3>
 163 <pre class="programlisting"><a class="link" href="harfbuzz-hb-blob.html#hb-blob-t" title="hb_blob_t"><span class="returnvalue">hb_blob_t</span></a> *
 164 hb_glib_blob_create (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Byte-Arrays.html#GBytes"><span class="type">GBytes</span></a> *gbytes</code></em>);</pre>
 165 <p>Creates an <a class="link" href="harfbuzz-hb-blob.html#hb-blob-t" title="hb_blob_t"><span class="type">hb_blob_t</span></a> blob from the specified
 166 GBytes data structure.</p>
 167 <div class="refsect3">
 168 <a name="hb-glib-blob-create.parameters"></a><h4>Parameters</h4>
 169 <div class="informaltable"><table class="informaltable" width="100%" border="0">
 170 <colgroup>
 171 <col width="150px" class="parameters_name">
 172 <col class="parameters_description">
 173 <col width="200px" class="parameters_annotations">
 174 </colgroup>
 175 <tbody><tr>
 176 <td class="parameter_name"><p>gbytes</p></td>
 177 <td class="parameter_description"><p>the GBytes structure to work upon</p></td>
 178 <td class="parameter_annotations"> </td>
 179 </tr></tbody>
 180 </table></div>
 181 </div>
 182 <div class="refsect3">
 183 <a name="hb-glib-blob-create.returns"></a><h4>Returns</h4>
 184 <p>the new <a class="link" href="harfbuzz-hb-blob.html#hb-blob-t" title="hb_blob_t"><span class="type">hb_blob_t</span></a> blob object. </p>
 185 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 186 </div>
 187 <p class="since">Since: <a class="link" href="api-index-0-9-38.html#api-index-0.9.38">0.9.38</a></p>
 188 </div>
 189 </div>
 190 </div>
 191 <div class="footer">
 192 <hr>Generated by GTK-Doc V1.32.1</div>
 193 </body>
 194 </html>