<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Utilities: libeasyfc Documentation</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="libeasyfc Documentation">
<link rel="up" href="ch01.html" title="libeasyfc API References">
<link rel="prev" href="libeasyfc-ezfc-font-t.html" title="ezfc_font_t">
<link rel="next" href="object-tree.html" title="Object Hierarchy">
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#libeasyfc-Utilities.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="libeasyfc-ezfc-font-t.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="object-tree.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libeasyfc-Utilities"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libeasyfc-Utilities.top_of_page"></a>Utilities</span></h2>
<p>Utilities — A collection of the utility functions</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libeasyfc-Utilities.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libeasyfc-Utilities.html#ezfc-version" title="ezfc_version ()">ezfc_version</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libeasyfc-Utilities.html#ezfc-init" title="ezfc_init ()">ezfc_init</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="libeasyfc-Utilities.html#ezfc-finalize" title="ezfc_finalize ()">ezfc_finalize</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="define_keyword">#define</td>
<td class="function_name">
<a class="link" href="libeasyfc-Utilities.html#EZFC-DEPRECATED-FOR:CAPS" title="EZFC_DEPRECATED_FOR()">EZFC_DEPRECATED_FOR</a><span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gboolean</span>
</td>
<td class="function_name">
<a class="link" href="libeasyfc-Utilities.html#ezfc-is-alias-font" title="ezfc_is_alias_font ()">ezfc_is_alias_font</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GList</span> *
</td>
<td class="function_name">
<a class="link" href="libeasyfc-Utilities.html#ezfc-get-fonts-list" title="ezfc_get_fonts_list ()">ezfc_get_fonts_list</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">GList</span> *
</td>
<td class="function_name">
<a class="link" href="libeasyfc-Utilities.html#ezfc-get-fonts-pattern-list" title="ezfc_get_fonts_pattern_list ()">ezfc_get_fonts_pattern_list</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libeasyfc-Utilities.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="define_keyword">#define</td>
<td class="function_name"><a class="link" href="libeasyfc-Utilities.html#EZFC-DEPRECATED:CAPS" title="EZFC_DEPRECATED">EZFC_DEPRECATED</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libeasyfc-Utilities.description"></a><h2>Description</h2>
<p>This collects some utility functions.</p>
</div>
<div class="refsect1">
<a name="libeasyfc-Utilities.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="ezfc-version"></a><h3>ezfc_version ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
ezfc_version (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Obtain the version of libeasyfc.</p>
<div class="refsect3">
<a name="ezfc-version.returns"></a><h4>Returns</h4>
<p> a version string.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ezfc-init"></a><h3>ezfc_init ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ezfc_init (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Initialize the library.</p>
</div>
<hr>
<div class="refsect2">
<a name="ezfc-finalize"></a><h3>ezfc_finalize ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ezfc_finalize (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Finalize the library.</p>
</div>
<hr>
<div class="refsect2">
<a name="EZFC-DEPRECATED-FOR:CAPS"></a><h3>EZFC_DEPRECATED_FOR()</h3>
<pre class="programlisting">#define EZFC_DEPRECATED_FOR(f) G_GNUC_DEPRECATED_FOR(f)
</pre>
</div>
<hr>
<div class="refsect2">
<a name="ezfc-is-alias-font"></a><h3>ezfc_is_alias_font ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
ezfc_is_alias_font (<em class="parameter"><code>const <span class="type">gchar</span> *alias_name</code></em>);</pre>
<div class="warning">
<p><code class="literal">ezfc_is_alias_font</code> has been deprecated since version 0.7 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="libeasyfc-ezfc-font-t.html#ezfc-font-is-alias-font" title="ezfc_font_is_alias_font ()"><code class="function">ezfc_font_is_alias_font()</code></a>.</p>
</div>
<p>Checks if <em class="parameter"><code>alias_name</code></em>
is one of sans-serif, serif, monospace, cursive, fantasy,
emoji or math.</p>
<div class="refsect3">
<a name="ezfc-is-alias-font.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>alias_name</p></td>
<td class="parameter_description"><p>the alias font name</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ezfc-is-alias-font.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if <em class="parameter"><code>alias_name</code></em>
is an alias font name, otherwise <code class="literal">FALSE</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ezfc-get-fonts-list"></a><h3>ezfc_get_fonts_list ()</h3>
<pre class="programlisting"><span class="returnvalue">GList</span> *
ezfc_get_fonts_list (<em class="parameter"><code>const <span class="type">gchar</span> *language</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *alias_name</code></em>);</pre>
<div class="warning">
<p><code class="literal">ezfc_get_fonts_list</code> has been deprecated since version 0.7 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="libeasyfc-ezfc-font-t.html#ezfc-font-get-list" title="ezfc_font_get_list ()"><code class="function">ezfc_font_get_list()</code></a>.</p>
</div>
<p>Obtains the fonts list being assigned to <em class="parameter"><code>alias_name</code></em>
for <em class="parameter"><code>language</code></em>
.</p>
<div class="refsect3">
<a name="ezfc-get-fonts-list.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>language</p></td>
<td class="parameter_description"><p>the language name fontconfig can deal with. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>alias_name</p></td>
<td class="parameter_description"><p>the alias name to obtain the fonts list for. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ezfc-get-fonts-list.returns"></a><h4>Returns</h4>
<p>a <span class="type">GList</span> contains the font family name.
if no valid families, <code class="literal">NULL</code> then. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ezfc-get-fonts-pattern-list"></a><h3>ezfc_get_fonts_pattern_list ()</h3>
<pre class="programlisting"><span class="returnvalue">GList</span> *
ezfc_get_fonts_pattern_list (<em class="parameter"><code>const <span class="type">gchar</span> *language</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *alias_name</code></em>);</pre>
<div class="warning">
<p><code class="literal">ezfc_get_fonts_pattern_list</code> has been deprecated since version 0.7 and should not be used in newly-written code.</p>
<p>Use <a class="link" href="libeasyfc-ezfc-font-t.html#ezfc-font-get-pattern-list" title="ezfc_font_get_pattern_list ()"><code class="function">ezfc_font_get_pattern_list()</code></a>.</p>
</div>
<p>Obtains <span class="type">FcPattern</span> list being assigned to <em class="parameter"><code>alias_name</code></em>
for <em class="parameter"><code>language</code></em>
.</p>
<div class="refsect3">
<a name="ezfc-get-fonts-pattern-list.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>language</p></td>
<td class="parameter_description"><p>the language name fontconfig can deal with. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>alias_name</p></td>
<td class="parameter_description"><p>the alias name to obtain the fonts pettern list for. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ezfc-get-fonts-pattern-list.returns"></a><h4>Returns</h4>
<p>a <span class="type">GList</span> contains <span class="type">FcPattern</span>, otherwise <code class="literal">NULL</code>. </p>
<p><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> FcPattern][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="libeasyfc-Utilities.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="EZFC-DEPRECATED:CAPS"></a><h3>EZFC_DEPRECATED</h3>
<pre class="programlisting">#define EZFC_DEPRECATED G_GNUC_DEPRECATED
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>