zc
/
tg_windows5.12.6


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433
							<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>NimfServer: Nimf Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="Nimf Reference Manual">
<link rel="up" href="libnimf-api.html" title="Part I. libnimf API">
<link rel="prev" href="nimf-types.html" title="Types">
<link rel="next" href="nimf-utils.html" title="Utility Functions">
<meta name="generator" content="GTK-Doc V1.34.0 (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="#NimfServer.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
                  <a href="#NimfServer.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_signals">  <span class="dim">|</span> 
                  <a href="#NimfServer.signals" class="shortcut">Signals</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="libnimf-api.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="nimf-types.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="nimf-utils.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="NimfServer"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="NimfServer.top_of_page"></a>NimfServer</span></h2>
<p>NimfServer</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="NimfServer.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_proto_type">
<col class="functions_proto_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="NimfServer.html#nimf-server-change-engine-by-id" title="nimf_server_change_engine_by_id ()">nimf_server_change_engine_by_id</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="NimfServer.html#nimf-server-change-engine" title="nimf_server_change_engine ()">nimf_server_change_engine</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">gchar</span> **
</td>
<td class="function_name">
<a class="link" href="NimfServer.html#nimf-server-get-loaded-engine-ids" title="nimf_server_get_loaded_engine_ids ()">nimf_server_get_loaded_engine_ids</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="NimfServer.html" title="NimfServer"><span class="returnvalue">NimfServer</span></a> *
</td>
<td class="function_name">
<a class="link" href="NimfServer.html#nimf-server-get-default" title="nimf_server_get_default ()">nimf_server_get_default</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="NimfPreeditable.html" title="NimfPreeditable"><span class="returnvalue">NimfPreeditable</span></a> *
</td>
<td class="function_name">
<a class="link" href="NimfServer.html#nimf-server-get-preeditable" title="nimf_server_get_preeditable ()">nimf_server_get_preeditable</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="NimfServer.signals"></a><h2>Signals</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="signal_proto_type">
<col width="300px" class="signal_proto_name">
<col width="200px" class="signal_proto_flags">
</colgroup>
<tbody>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="NimfServer.html#NimfServer-engine-changed" title="The “engine-changed” signal">engine-changed</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="NimfServer.html#NimfServer-engine-loaded" title="The “engine-loaded” signal">engine-loaded</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="NimfServer.html#NimfServer-engine-status-changed" title="The “engine-status-changed” signal">engine-status-changed</a></td>
<td class="signal_flags">Run Last</td>
</tr>
<tr>
<td class="signal_type"><span class="returnvalue">void</span></td>
<td class="signal_name"><a class="link" href="NimfServer.html#NimfServer-engine-unloaded" title="The “engine-unloaded” signal">engine-unloaded</a></td>
<td class="signal_flags">Run Last</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="NimfServer.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen">    GObject
    <span class="lineart">╰──</span> NimfServer
</pre>
</div>
<div class="refsect1">
<a name="NimfServer.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="NimfServer.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="nimf-server-change-engine-by-id"></a><h3>nimf_server_change_engine_by_id ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
nimf_server_change_engine_by_id (<em class="parameter"><code><a class="link" href="NimfServer.html" title="NimfServer"><span class="type">NimfServer</span></a> *server</code></em>,
                                 <em class="parameter"><code>const <span class="type">gchar</span> *engine_id</code></em>);</pre>
<p>Changes the last focused engine to the engine with the given ID.</p>
<div class="refsect3">
<a name="nimf-server-change-engine-by-id.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>server</p></td>
<td class="parameter_description"><p>a <a class="link" href="NimfServer.html" title="NimfServer"><span class="type">NimfServer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>engine_id</p></td>
<td class="parameter_description"><p>engine id</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="nimf-server-change-engine"></a><h3>nimf_server_change_engine ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
nimf_server_change_engine (<em class="parameter"><code><a class="link" href="NimfServer.html" title="NimfServer"><span class="type">NimfServer</span></a> *server</code></em>,
                           <em class="parameter"><code>const <span class="type">gchar</span> *engine_id</code></em>,
                           <em class="parameter"><code>const <span class="type">gchar</span> *method_id</code></em>);</pre>
<div class="refsect3">
<a name="nimf-server-change-engine.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>server</p></td>
<td class="parameter_description"><p>a <a class="link" href="NimfServer.html" title="NimfServer"><span class="type">NimfServer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>engine_id</p></td>
<td class="parameter_description"><p>engine id</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>method_id</p></td>
<td class="parameter_description"><p>method id</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="nimf-server-get-loaded-engine-ids"></a><h3>nimf_server_get_loaded_engine_ids ()</h3>
<pre class="programlisting"><span class="returnvalue">gchar</span> **
nimf_server_get_loaded_engine_ids (<em class="parameter"><code><a class="link" href="NimfServer.html" title="NimfServer"><span class="type">NimfServer</span></a> *server</code></em>);</pre>
<p>The array is <code class="literal">NULL</code>-terminated.</p>
<div class="refsect3">
<a name="nimf-server-get-loaded-engine-ids.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>server</p></td>
<td class="parameter_description"><p>a <a class="link" href="NimfServer.html" title="NimfServer"><span class="type">NimfServer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nimf-server-get-loaded-engine-ids.returns"></a><h4>Returns</h4>
<p>a new <code class="literal">NULL</code>-terminated engine id array. </p>
<p><span class="annotation">[<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="nimf-server-get-default"></a><h3>nimf_server_get_default ()</h3>
<pre class="programlisting"><a class="link" href="NimfServer.html" title="NimfServer"><span class="returnvalue">NimfServer</span></a> *
nimf_server_get_default (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns the default <a class="link" href="NimfServer.html" title="NimfServer"><span class="type">NimfServer</span></a> instance.</p>
<p>If there is no default server then <code class="literal">NULL</code> is returned.</p>
<div class="refsect3">
<a name="nimf-server-get-default.returns"></a><h4>Returns</h4>
<p>the default server, or <code class="literal">NULL</code> if server is not
running. </p>
<p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="nimf-server-get-preeditable"></a><h3>nimf_server_get_preeditable ()</h3>
<pre class="programlisting"><a class="link" href="NimfPreeditable.html" title="NimfPreeditable"><span class="returnvalue">NimfPreeditable</span></a> *
nimf_server_get_preeditable (<em class="parameter"><code><a class="link" href="NimfServer.html" title="NimfServer"><span class="type">NimfServer</span></a> *server</code></em>);</pre>
<p>Returns the <a class="link" href="NimfPreeditable.html" title="NimfPreeditable"><span class="type">NimfPreeditable</span></a> instance.</p>
<p>If there is no default preeditable then <code class="literal">NULL</code> is returned.</p>
<div class="refsect3">
<a name="nimf-server-get-preeditable.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>server</p></td>
<td class="parameter_description"><p>a <a class="link" href="NimfServer.html" title="NimfServer"><span class="type">NimfServer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="nimf-server-get-preeditable.returns"></a><h4>Returns</h4>
<p>a <a class="link" href="NimfPreeditable.html" title="NimfPreeditable"><span class="type">NimfPreeditable</span></a>, or <code class="literal">NULL</code>. </p>
<p><span class="annotation">[<acronym title="The data is owned by the callee, which is responsible of freeing it."><span class="acronym">transfer none</span></acronym>]</span></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="NimfServer.signal-details"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="NimfServer-engine-changed"></a><h3>The <code class="literal">“engine-changed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="NimfServer.html" title="NimfServer"><span class="type">NimfServer</span></a> *server,
               <span class="type">char</span>       *engine_id,
               <span class="type">char</span>       *icon_name,
               <span class="type">gpointer</span>    user_data)</pre>
<p>The <a class="link" href="NimfServer.html#NimfServer-engine-changed" title="The “engine-changed” signal"><span class="type">“engine-changed”</span></a> signal is emitted when the engine is
changed.</p>
<div class="refsect3">
<a name="NimfServer-engine-changed.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>server</p></td>
<td class="parameter_description"><p>a <a class="link" href="NimfServer.html" title="NimfServer"><span class="type">NimfServer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>engine_id</p></td>
<td class="parameter_description"><p>engine id</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>icon_name</p></td>
<td class="parameter_description"><p>icon name</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="NimfServer-engine-loaded"></a><h3>The <code class="literal">“engine-loaded”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="NimfServer.html" title="NimfServer"><span class="type">NimfServer</span></a> *server,
               <span class="type">char</span>       *engine_id,
               <span class="type">gpointer</span>    user_data)</pre>
<p>The <a class="link" href="NimfServer.html#NimfServer-engine-loaded" title="The “engine-loaded” signal"><span class="type">“engine-loaded”</span></a> signal is emitted when the engine is loaded.</p>
<div class="refsect3">
<a name="NimfServer-engine-loaded.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>server</p></td>
<td class="parameter_description"><p>a <a class="link" href="NimfServer.html" title="NimfServer"><span class="type">NimfServer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>engine_id</p></td>
<td class="parameter_description"><p>engine id</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="NimfServer-engine-status-changed"></a><h3>The <code class="literal">“engine-status-changed”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="NimfServer.html" title="NimfServer"><span class="type">NimfServer</span></a> *server,
               <span class="type">char</span>       *engine_id,
               <span class="type">char</span>       *icon_name,
               <span class="type">gpointer</span>    user_data)</pre>
<p>The <a class="link" href="NimfServer.html#NimfServer-engine-status-changed" title="The “engine-status-changed” signal"><span class="type">“engine-status-changed”</span></a> signal is emitted when the engine
status is changed.</p>
<div class="refsect3">
<a name="NimfServer-engine-status-changed.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>server</p></td>
<td class="parameter_description"><p>a <a class="link" href="NimfServer.html" title="NimfServer"><span class="type">NimfServer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>engine_id</p></td>
<td class="parameter_description"><p>engine id</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>icon_name</p></td>
<td class="parameter_description"><p>icon name</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
<hr>
<div class="refsect2">
<a name="NimfServer-engine-unloaded"></a><h3>The <code class="literal">“engine-unloaded”</code> signal</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
user_function (<a class="link" href="NimfServer.html" title="NimfServer"><span class="type">NimfServer</span></a> *server,
               <span class="type">char</span>       *engine_id,
               <span class="type">gpointer</span>    user_data)</pre>
<p>The <a class="link" href="NimfServer.html#NimfServer-engine-unloaded" title="The “engine-unloaded” signal"><span class="type">“engine-unloaded”</span></a> signal is emitted when the engine is
unloaded.</p>
<div class="refsect3">
<a name="NimfServer-engine-unloaded.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>server</p></td>
<td class="parameter_description"><p>a <a class="link" href="NimfServer.html" title="NimfServer"><span class="type">NimfServer</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>engine_id</p></td>
<td class="parameter_description"><p>engine id</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p>user data set when the signal handler was connected.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<p>Flags: Run Last</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.34.0</div>
</body>
</html>