<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ezfc_alias_t: 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="ch01.html" title="libeasyfc API References">
<link rel="next" href="libeasyfc-ezfc-config-t.html" title="ezfc_config_t">
<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-ezfc-alias-t.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="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="libeasyfc-ezfc-config-t.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="libeasyfc-ezfc-alias-t"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libeasyfc-ezfc-alias-t.top_of_page"></a>ezfc_alias_t</span></h2>
<p>ezfc_alias_t — A class for managing the alias font name.</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="libeasyfc-ezfc-alias-t.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">
<a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-t" title="ezfc_alias_t"><span class="returnvalue">ezfc_alias_t</span></a> *
</td>
<td class="function_name">
<a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-new" title="ezfc_alias_new ()">ezfc_alias_new</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-t" title="ezfc_alias_t"><span class="returnvalue">ezfc_alias_t</span></a> *
</td>
<td class="function_name">
<a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-ref" title="ezfc_alias_ref ()">ezfc_alias_ref</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-ezfc-alias-t.html#ezfc-alias-unref" title="ezfc_alias_unref ()">ezfc_alias_unref</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-get-name" title="ezfc_alias_get_name ()">ezfc_alias_get_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">FcPattern</span> *
</td>
<td class="function_name">
<a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-get-font-pattern" title="ezfc_alias_get_font_pattern ()">ezfc_alias_get_font_pattern</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-ezfc-alias-t.html#ezfc-alias-set-font-pattern" title="ezfc_alias_set_font_pattern ()">ezfc_alias_set_font_pattern</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <span class="returnvalue">gchar</span> *
</td>
<td class="function_name">
<a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-get-font" title="ezfc_alias_get_font ()">ezfc_alias_get_font</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-ezfc-alias-t.html#ezfc-alias-set-font" title="ezfc_alias_set_font ()">ezfc_alias_set_font</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-ezfc-alias-t.html#ezfc-alias-check-font-existence" title="ezfc_alias_check_font_existence ()">ezfc_alias_check_font_existence</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libeasyfc-ezfc-alias-t.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="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-t" title="ezfc_alias_t">ezfc_alias_t</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="libeasyfc-ezfc-alias-t.description"></a><h2>Description</h2>
<p>This class provides an easy access to the alias font name and the font
that actually being assigned to it.</p>
</div>
<div class="refsect1">
<a name="libeasyfc-ezfc-alias-t.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="ezfc-alias-new"></a><h3>ezfc_alias_new ()</h3>
<pre class="programlisting"><a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-t" title="ezfc_alias_t"><span class="returnvalue">ezfc_alias_t</span></a> *
ezfc_alias_new (<em class="parameter"><code>const <span class="type">gchar</span> *alias_name</code></em>);</pre>
<p>Create an instance of <a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-t" title="ezfc_alias_t"><span class="type">ezfc_alias_t</span></a>.</p>
<div class="refsect3">
<a name="ezfc-alias-new.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 like sans-serif, serif and monospace.
This can be the usual font name. in this case, the font added by
<a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-set-font" title="ezfc_alias_set_font ()"><code class="function">ezfc_alias_set_font()</code></a> behaves as the substitution font of it.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ezfc-alias-new.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-t" title="ezfc_alias_t"><span class="type">ezfc_alias_t</span></a>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ezfc-alias-ref"></a><h3>ezfc_alias_ref ()</h3>
<pre class="programlisting"><a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-t" title="ezfc_alias_t"><span class="returnvalue">ezfc_alias_t</span></a> *
ezfc_alias_ref (<em class="parameter"><code><a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-t" title="ezfc_alias_t"><span class="type">ezfc_alias_t</span></a> *alias</code></em>);</pre>
<p>Increases the reference count of <em class="parameter"><code>alias</code></em>
.</p>
<div class="refsect3">
<a name="ezfc-alias-ref.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</p></td>
<td class="parameter_description"><p>a <a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-t" title="ezfc_alias_t"><span class="type">ezfc_alias_t</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ezfc-alias-ref.returns"></a><h4>Returns</h4>
<p>the same <em class="parameter"><code>alias</code></em>
. </p>
<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ezfc-alias-unref"></a><h3>ezfc_alias_unref ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ezfc_alias_unref (<em class="parameter"><code><a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-t" title="ezfc_alias_t"><span class="type">ezfc_alias_t</span></a> *alias</code></em>);</pre>
<p>Decreases the reference count of <em class="parameter"><code>alias</code></em>
. When its reference count
drops to 0, the object is finalized (i.e. its memory is freed).</p>
<div class="refsect3">
<a name="ezfc-alias-unref.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</p></td>
<td class="parameter_description"><p>a <a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-t" title="ezfc_alias_t"><span class="type">ezfc_alias_t</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ezfc-alias-get-name"></a><h3>ezfc_alias_get_name ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
ezfc_alias_get_name (<em class="parameter"><code><a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-t" title="ezfc_alias_t"><span class="type">ezfc_alias_t</span></a> *alias</code></em>);</pre>
<p>Obtains the alias font name in <em class="parameter"><code>alias</code></em>
object.</p>
<div class="refsect3">
<a name="ezfc-alias-get-name.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</p></td>
<td class="parameter_description"><p>a <a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-t" title="ezfc_alias_t"><span class="type">ezfc_alias_t</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ezfc-alias-get-name.returns"></a><h4>Returns</h4>
<p> the alias font name.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ezfc-alias-get-font-pattern"></a><h3>ezfc_alias_get_font_pattern ()</h3>
<pre class="programlisting"><span class="returnvalue">FcPattern</span> *
ezfc_alias_get_font_pattern (<em class="parameter"><code><a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-t" title="ezfc_alias_t"><span class="type">ezfc_alias_t</span></a> *alias</code></em>);</pre>
<p>Obtains <span class="type">FcPattern</span> in <a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-t" title="ezfc_alias_t"><span class="type">ezfc_alias_t</span></a>.</p>
<div class="refsect3">
<a name="ezfc-alias-get-font-pattern.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</p></td>
<td class="parameter_description"><p>a <a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-t" title="ezfc_alias_t"><span class="type">ezfc_alias_t</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ezfc-alias-get-font-pattern.returns"></a><h4>Returns</h4>
<p> a duplicate of <span class="type">FcPattern</span> in the instance. it has to be freed.
<code class="literal">NULL</code> if <em class="parameter"><code>alias</code></em>
doesn't have any font pattern.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ezfc-alias-set-font-pattern"></a><h3>ezfc_alias_set_font_pattern ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
ezfc_alias_set_font_pattern (<em class="parameter"><code><a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-t" title="ezfc_alias_t"><span class="type">ezfc_alias_t</span></a> *alias</code></em>,
<em class="parameter"><code>const <span class="type">FcPattern</span> *pattern</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Set <em class="parameter"><code>pattern</code></em>
as the font pattern. <em class="parameter"><code>alias</code></em>
keeps a duplicate instance of
<em class="parameter"><code>pattern</code></em>
.</p>
<div class="refsect3">
<a name="ezfc-alias-set-font-pattern.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</p></td>
<td class="parameter_description"><p>a <a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-t" title="ezfc_alias_t"><span class="type">ezfc_alias_t</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>pattern</p></td>
<td class="parameter_description"><p>a <span class="type">FcPattern</span>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <span class="type">GError</span>. </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-alias-set-font-pattern.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if it successfully is set. otherwise <code class="literal">FALSE</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ezfc-alias-get-font"></a><h3>ezfc_alias_get_font ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *
ezfc_alias_get_font (<em class="parameter"><code><a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-t" title="ezfc_alias_t"><span class="type">ezfc_alias_t</span></a> *alias</code></em>);</pre>
<p>Obtains the font that is set as the alias font for <em class="parameter"><code>alias</code></em>
.</p>
<div class="refsect3">
<a name="ezfc-alias-get-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</p></td>
<td class="parameter_description"><p>a <a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-t" title="ezfc_alias_t"><span class="type">ezfc_alias_t</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="ezfc-alias-get-font.returns"></a><h4>Returns</h4>
<p> the font name.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ezfc-alias-set-font"></a><h3>ezfc_alias_set_font ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>
ezfc_alias_set_font (<em class="parameter"><code><a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-t" title="ezfc_alias_t"><span class="type">ezfc_alias_t</span></a> *alias</code></em>,
<em class="parameter"><code>const <span class="type">gchar</span> *font_name</code></em>,
<em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
<p>Set <em class="parameter"><code>font_name</code></em>
as the font family name used for the alias font.</p>
<div class="refsect3">
<a name="ezfc-alias-set-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</p></td>
<td class="parameter_description"><p>a <a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-t" title="ezfc_alias_t"><span class="type">ezfc_alias_t</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>font_name</p></td>
<td class="parameter_description"><p>a font name.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <span class="type">GError</span>. </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-alias-set-font.returns"></a><h4>Returns</h4>
<p> <code class="literal">TRUE</code> if it successfully is set. otherwise <code class="literal">FALSE</code>.</p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="ezfc-alias-check-font-existence"></a><h3>ezfc_alias_check_font_existence ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
ezfc_alias_check_font_existence (<em class="parameter"><code><a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-t" title="ezfc_alias_t"><span class="type">ezfc_alias_t</span></a> *alias</code></em>,
<em class="parameter"><code><span class="type">gboolean</span> flag</code></em>);</pre>
<p>Set a flag whether checking the font existence when invoking
<a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-set-font" title="ezfc_alias_set_font ()"><code class="function">ezfc_alias_set_font()</code></a>.</p>
<div class="refsect3">
<a name="ezfc-alias-check-font-existence.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</p></td>
<td class="parameter_description"><p>a <a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-t" title="ezfc_alias_t"><span class="type">ezfc_alias_t</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>flag</p></td>
<td class="parameter_description"><p>a boolean value.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="refsect1">
<a name="libeasyfc-ezfc-alias-t.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="ezfc-alias-t"></a><h3>ezfc_alias_t</h3>
<pre class="programlisting">typedef struct _ezfc_alias_t ezfc_alias_t;</pre>
<p>All the fields in the <span class="structname">ezfc_alias_t</span>
structure are private to the <a class="link" href="libeasyfc-ezfc-alias-t.html#ezfc-alias-t" title="ezfc_alias_t"><span class="type">ezfc_alias_t</span></a> implementation.</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>