Acasă Explorează Ajutor
Înregistrare Autentificare
zc
/
tg_windows5.12.6
1
0
Bifurcare 0
Fisiere Probleme 0 Trageți solicitările 0 Wiki
Ramură: master
Ramuri Etichete
tg_windows5.12....
/
Telegram
/
ThirdParty
/
nimf
/
docs
/
html
/
NimfEngine.html

NimfEngine.html 46 KB
Permalink Istoric Crud

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
    2. 

  2. <html>
    3. 

  3. <head>
    4. 

  4. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    5. 

  5. <title>NimfEngine: Nimf Reference Manual</title>
    6. 

  6. <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
    7. 

  7. <link rel="home" href="index.html" title="Nimf Reference Manual">
    8. 

  8. <link rel="up" href="abstract-classes.html" title="Abstract Classes">
    9. 

  9. <link rel="prev" href="abstract-classes.html" title="Abstract Classes">
    10. 

  10. <link rel="next" href="NimfService.html" title="NimfService">
    11. 

  11. <meta name="generator" content="GTK-Doc V1.34.0 (XML mode)">
    12. 

  12. <link rel="stylesheet" href="style.css" type="text/css">
    13. 

  13. </head>
    14. 

  14. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
    15. 

  15. <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
    16. 

  16. <td width="100%" align="left" class="shortcuts">
    17. 

  17. <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
    18. 

  18.                   <a href="#NimfEngine.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
    19. 

  19.                   <a href="#NimfEngine.object-hierarchy" class="shortcut">Object Hierarchy</a></span>
    20. 

  20. </td>
    21. 

  21. <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
    22. 

  22. <td><a accesskey="u" href="abstract-classes.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
    23. 

  23. <td><a accesskey="p" href="abstract-classes.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
    24. 

  24. <td><a accesskey="n" href="NimfService.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
    25. 

  25. </tr></table>
    26. 

  26. <div class="refentry">
    27. 

  27. <a name="NimfEngine"></a><div class="titlepage"></div>
    28. 

  28. <div class="refnamediv"><table width="100%"><tr>
    29. 

  29. <td valign="top">
    30. 

  30. <h2><span class="refentrytitle"><a name="NimfEngine.top_of_page"></a>NimfEngine</span></h2>
    31. 

  31. <p>NimfEngine</p>
    32. 

  32. </td>
    33. 

  33. <td class="gallery_image" valign="top" align="right"></td>
    34. 

  34. </tr></table></div>
    35. 

  35. <div class="refsect1">
    36. 

  36. <a name="NimfEngine.functions"></a><h2>Functions</h2>
    37. 

  37. <div class="informaltable"><table class="informaltable" width="100%" border="0">
    38. 

  38. <colgroup>
    39. 

  39. <col width="150px" class="functions_proto_type">
    40. 

  40. <col class="functions_proto_name">
    41. 

  41. </colgroup>
    42. 

  42. <tbody>
    43. 

  43. <tr>
    44. 

  44. <td class="function_type">
    45. 

  45. <span class="returnvalue">gboolean</span>
    46. 

  46. </td>
    47. 

  47. <td class="function_name">
    48. 

  48. <a class="link" href="NimfEngine.html#nimf-engine-filter-event" title="nimf_engine_filter_event ()">nimf_engine_filter_event</a> <span class="c_punctuation">()</span>
    49. 

  49. </td>
    50. 

  50. </tr>
    51. 

  51. <tr>
    52. 

  52. <td class="function_type">
    53. 

  53. <span class="returnvalue">void</span>
    54. 

  54. </td>
    55. 

  55. <td class="function_name">
    56. 

  56. <a class="link" href="NimfEngine.html#nimf-engine-reset" title="nimf_engine_reset ()">nimf_engine_reset</a> <span class="c_punctuation">()</span>
    57. 

  57. </td>
    58. 

  58. </tr>
    59. 

  59. <tr>
    60. 

  60. <td class="function_type">
    61. 

  61. <span class="returnvalue">void</span>
    62. 

  62. </td>
    63. 

  63. <td class="function_name">
    64. 

  64. <a class="link" href="NimfEngine.html#nimf-engine-focus-in" title="nimf_engine_focus_in ()">nimf_engine_focus_in</a> <span class="c_punctuation">()</span>
    65. 

  65. </td>
    66. 

  66. </tr>
    67. 

  67. <tr>
    68. 

  68. <td class="function_type">
    69. 

  69. <span class="returnvalue">void</span>
    70. 

  70. </td>
    71. 

  71. <td class="function_name">
    72. 

  72. <a class="link" href="NimfEngine.html#nimf-engine-focus-out" title="nimf_engine_focus_out ()">nimf_engine_focus_out</a> <span class="c_punctuation">()</span>
    73. 

  73. </td>
    74. 

  74. </tr>
    75. 

  75. <tr>
    76. 

  76. <td class="function_type">
    77. 

  77. <span class="returnvalue">void</span>
    78. 

  78. </td>
    79. 

  79. <td class="function_name">
    80. 

  80. <a class="link" href="NimfEngine.html#nimf-engine-set-surrounding" title="nimf_engine_set_surrounding ()">nimf_engine_set_surrounding</a> <span class="c_punctuation">()</span>
    81. 

  81. </td>
    82. 

  82. </tr>
    83. 

  83. <tr>
    84. 

  84. <td class="function_type">
    85. 

  85. <span class="returnvalue">gboolean</span>
    86. 

  86. </td>
    87. 

  87. <td class="function_name">
    88. 

  88. <a class="link" href="NimfEngine.html#nimf-engine-get-surrounding" title="nimf_engine_get_surrounding ()">nimf_engine_get_surrounding</a> <span class="c_punctuation">()</span>
    89. 

  89. </td>
    90. 

  90. </tr>
    91. 

  91. <tr>
    92. 

  92. <td class="function_type">
    93. 

  93. <span class="returnvalue">void</span>
    94. 

  94. </td>
    95. 

  95. <td class="function_name">
    96. 

  96. <a class="link" href="NimfEngine.html#nimf-engine-status-changed" title="nimf_engine_status_changed ()">nimf_engine_status_changed</a> <span class="c_punctuation">()</span>
    97. 

  97. </td>
    98. 

  98. </tr>
    99. 

  99. <tr>
    100. 

  100. <td class="function_type">
    101. 

  101. <span class="returnvalue">void</span>
    102. 

  102. </td>
    103. 

  103. <td class="function_name">
    104. 

  104. <a class="link" href="NimfEngine.html#nimf-engine-set-method" title="nimf_engine_set_method ()">nimf_engine_set_method</a> <span class="c_punctuation">()</span>
    105. 

  105. </td>
    106. 

  106. </tr>
    107. 

  107. <tr>
    108. 

  108. <td class="function_type">
    109. 

  109. <span class="returnvalue">void</span>
    110. 

  110. </td>
    111. 

  111. <td class="function_name">
    112. 

  112. <a class="link" href="NimfEngine.html#nimf-engine-emit-preedit-start" title="nimf_engine_emit_preedit_start ()">nimf_engine_emit_preedit_start</a> <span class="c_punctuation">()</span>
    113. 

  113. </td>
    114. 

  114. </tr>
    115. 

  115. <tr>
    116. 

  116. <td class="function_type">
    117. 

  117. <span class="returnvalue">void</span>
    118. 

  118. </td>
    119. 

  119. <td class="function_name">
    120. 

  120. <a class="link" href="NimfEngine.html#nimf-engine-emit-preedit-changed" title="nimf_engine_emit_preedit_changed ()">nimf_engine_emit_preedit_changed</a> <span class="c_punctuation">()</span>
    121. 

  121. </td>
    122. 

  122. </tr>
    123. 

  123. <tr>
    124. 

  124. <td class="function_type">
    125. 

  125. <span class="returnvalue">void</span>
    126. 

  126. </td>
    127. 

  127. <td class="function_name">
    128. 

  128. <a class="link" href="NimfEngine.html#nimf-engine-emit-preedit-end" title="nimf_engine_emit_preedit_end ()">nimf_engine_emit_preedit_end</a> <span class="c_punctuation">()</span>
    129. 

  129. </td>
    130. 

  130. </tr>
    131. 

  131. <tr>
    132. 

  132. <td class="function_type">
    133. 

  133. <span class="returnvalue">void</span>
    134. 

  134. </td>
    135. 

  135. <td class="function_name">
    136. 

  136. <a class="link" href="NimfEngine.html#nimf-engine-emit-commit" title="nimf_engine_emit_commit ()">nimf_engine_emit_commit</a> <span class="c_punctuation">()</span>
    137. 

  137. </td>
    138. 

  138. </tr>
    139. 

  139. <tr>
    140. 

  140. <td class="function_type">
    141. 

  141. <span class="returnvalue">gboolean</span>
    142. 

  142. </td>
    143. 

  143. <td class="function_name">
    144. 

  144. <a class="link" href="NimfEngine.html#nimf-engine-emit-retrieve-surrounding" title="nimf_engine_emit_retrieve_surrounding ()">nimf_engine_emit_retrieve_surrounding</a> <span class="c_punctuation">()</span>
    145. 

  145. </td>
    146. 

  146. </tr>
    147. 

  147. <tr>
    148. 

  148. <td class="function_type">
    149. 

  149. <span class="returnvalue">gboolean</span>
    150. 

  150. </td>
    151. 

  151. <td class="function_name">
    152. 

  152. <a class="link" href="NimfEngine.html#nimf-engine-emit-delete-surrounding" title="nimf_engine_emit_delete_surrounding ()">nimf_engine_emit_delete_surrounding</a> <span class="c_punctuation">()</span>
    153. 

  153. </td>
    154. 

  154. </tr>
    155. 

  155. <tr>
    156. 

  156. <td class="function_type">
    157. 

  157. <span class="returnvalue">void</span>
    158. 

  158. </td>
    159. 

  159. <td class="function_name">
    160. 

  160. <a class="link" href="NimfEngine.html#nimf-engine-emit-beep" title="nimf_engine_emit_beep ()">nimf_engine_emit_beep</a> <span class="c_punctuation">()</span>
    161. 

  161. </td>
    162. 

  162. </tr>
    163. 

  163. <tr>
    164. 

  164. <td class="function_type">const <span class="returnvalue">gchar</span> *
    165. 

  165. </td>
    166. 

  166. <td class="function_name">
    167. 

  167. <a class="link" href="NimfEngine.html#nimf-engine-get-id" title="nimf_engine_get_id ()">nimf_engine_get_id</a> <span class="c_punctuation">()</span>
    168. 

  168. </td>
    169. 

  169. </tr>
    170. 

  170. <tr>
    171. 

  171. <td class="function_type">const <span class="returnvalue">gchar</span> *
    172. 

  172. </td>
    173. 

  173. <td class="function_name">
    174. 

  174. <a class="link" href="NimfEngine.html#nimf-engine-get-icon-name" title="nimf_engine_get_icon_name ()">nimf_engine_get_icon_name</a> <span class="c_punctuation">()</span>
    175. 

  175. </td>
    176. 

  176. </tr>
    177. 

  177. <tr>
    178. 

  178. <td class="function_type">
    179. 

  179. <a class="link" href="NimfCandidatable.html" title="NimfCandidatable"><span class="returnvalue">NimfCandidatable</span></a> *
    180. 

  180. </td>
    181. 

  181. <td class="function_name">
    182. 

  182. <a class="link" href="NimfEngine.html#nimf-engine-get-candidatable" title="nimf_engine_get_candidatable ()">nimf_engine_get_candidatable</a> <span class="c_punctuation">()</span>
    183. 

  183. </td>
    184. 

  184. </tr>
    185. 

  185. </tbody>
    186. 

  186. </table></div>
    187. 

  187. </div>
    188. 

  188. <div class="refsect1">
    189. 

  189. <a name="NimfEngine.other"></a><h2>Types and Values</h2>
    190. 

  190. <div class="informaltable"><table class="informaltable" width="100%" border="0">
    191. 

  191. <colgroup>
    192. 

  192. <col width="150px" class="other_proto_type">
    193. 

  193. <col class="other_proto_name">
    194. 

  194. </colgroup>
    195. 

  195. <tbody><tr>
    196. 

  196. <td class="datatype_keyword">struct</td>
    197. 

  197. <td class="function_name"><a class="link" href="NimfEngine.html#NimfEngineClass" title="struct NimfEngineClass">NimfEngineClass</a></td>
    198. 

  198. </tr></tbody>
    199. 

  199. </table></div>
    200. 

  200. </div>
    201. 

  201. <div class="refsect1">
    202. 

  202. <a name="NimfEngine.object-hierarchy"></a><h2>Object Hierarchy</h2>
    203. 

  203. <pre class="screen">    GObject
    204. 

  204.     <span class="lineart">╰──</span> NimfEngine
    205. 

  205. </pre>
    206. 

  206. </div>
    207. 

  207. <div class="refsect1">
    208. 

  208. <a name="NimfEngine.description"></a><h2>Description</h2>
    209. 

  209. </div>
    210. 

  210. <div class="refsect1">
    211. 

  211. <a name="NimfEngine.functions_details"></a><h2>Functions</h2>
    212. 

  212. <div class="refsect2">
    213. 

  213. <a name="nimf-engine-filter-event"></a><h3>nimf_engine_filter_event ()</h3>
    214. 

  214. <pre class="programlisting"><span class="returnvalue">gboolean</span>
    215. 

  215. nimf_engine_filter_event (<em class="parameter"><code><a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a> *engine</code></em>,
    216. 

  216.                           <em class="parameter"><code><a class="link" href="NimfServiceIC.html" title="NimfServiceIC"><span class="type">NimfServiceIC</span></a> *ic</code></em>,
    217. 

  217.                           <em class="parameter"><code><a class="link" href="nimf-events.html#NimfEvent" title="union NimfEvent"><span class="type">NimfEvent</span></a> *event</code></em>);</pre>
    218. 

  218. <p>Let the language engine handle the event.</p>
    219. 

  219. <div class="refsect3">
    220. 

  220. <a name="nimf-engine-filter-event.parameters"></a><h4>Parameters</h4>
    221. 

  221. <div class="informaltable"><table class="informaltable" width="100%" border="0">
    222. 

  222. <colgroup>
    223. 

  223. <col width="150px" class="parameters_name">
    224. 

  224. <col class="parameters_description">
    225. 

  225. <col width="200px" class="parameters_annotations">
    226. 

  226. </colgroup>
    227. 

  227. <tbody>
    228. 

  228. <tr>
    229. 

  229. <td class="parameter_name"><p>engine</p></td>
    230. 

  230. <td class="parameter_description"><p>a <a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a></p></td>
    231. 

  231. <td class="parameter_annotations"> </td>
    232. 

  232. </tr>
    233. 

  233. <tr>
    234. 

  234. <td class="parameter_name"><p>ic</p></td>
    235. 

  235. <td class="parameter_description"><p>a <a class="link" href="NimfServiceIC.html" title="NimfServiceIC"><span class="type">NimfServiceIC</span></a> associated with <em class="parameter"><code>engine</code></em>
    236. 

  236. </p></td>
    237. 

  237. <td class="parameter_annotations"> </td>
    238. 

  238. </tr>
    239. 

  239. <tr>
    240. 

  240. <td class="parameter_name"><p>event</p></td>
    241. 

  241. <td class="parameter_description"><p>a <a class="link" href="nimf-events.html#NimfEvent" title="union NimfEvent"><span class="type">NimfEvent</span></a></p></td>
    242. 

  242. <td class="parameter_annotations"> </td>
    243. 

  243. </tr>
    244. 

  244. </tbody>
    245. 

  245. </table></div>
    246. 

  246. </div>
    247. 

  247. <div class="refsect3">
    248. 

  248. <a name="nimf-engine-filter-event.returns"></a><h4>Returns</h4>
    249. 

  249. <p> <code class="literal">TRUE</code> if the language engine consumed the event.</p>
    250. 

  250. </div>
    251. 

  251. </div>
    252. 

  252. <hr>
    253. 

  253. <div class="refsect2">
    254. 

  254. <a name="nimf-engine-reset"></a><h3>nimf_engine_reset ()</h3>
    255. 

  255. <pre class="programlisting"><span class="returnvalue">void</span>
    256. 

  256. nimf_engine_reset (<em class="parameter"><code><a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a> *engine</code></em>,
    257. 

  257.                    <em class="parameter"><code><a class="link" href="NimfServiceIC.html" title="NimfServiceIC"><span class="type">NimfServiceIC</span></a> *ic</code></em>);</pre>
    258. 

  258. <p>Resets the <em class="parameter"><code>engine</code></em>
    259. 

  259. .</p>
    260. 

  260. <div class="refsect3">
    261. 

  261. <a name="nimf-engine-reset.parameters"></a><h4>Parameters</h4>
    262. 

  262. <div class="informaltable"><table class="informaltable" width="100%" border="0">
    263. 

  263. <colgroup>
    264. 

  264. <col width="150px" class="parameters_name">
    265. 

  265. <col class="parameters_description">
    266. 

  266. <col width="200px" class="parameters_annotations">
    267. 

  267. </colgroup>
    268. 

  268. <tbody>
    269. 

  269. <tr>
    270. 

  270. <td class="parameter_name"><p>engine</p></td>
    271. 

  271. <td class="parameter_description"><p>a <a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a></p></td>
    272. 

  272. <td class="parameter_annotations"> </td>
    273. 

  273. </tr>
    274. 

  274. <tr>
    275. 

  275. <td class="parameter_name"><p>ic</p></td>
    276. 

  276. <td class="parameter_description"><p>a <a class="link" href="NimfServiceIC.html" title="NimfServiceIC"><span class="type">NimfServiceIC</span></a> associated with <em class="parameter"><code>engine</code></em>
    277. 

  277. </p></td>
    278. 

  278. <td class="parameter_annotations"> </td>
    279. 

  279. </tr>
    280. 

  280. </tbody>
    281. 

  281. </table></div>
    282. 

  282. </div>
    283. 

  283. </div>
    284. 

  284. <hr>
    285. 

  285. <div class="refsect2">
    286. 

  286. <a name="nimf-engine-focus-in"></a><h3>nimf_engine_focus_in ()</h3>
    287. 

  287. <pre class="programlisting"><span class="returnvalue">void</span>
    288. 

  288. nimf_engine_focus_in (<em class="parameter"><code><a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a> *engine</code></em>,
    289. 

  289.                       <em class="parameter"><code><a class="link" href="NimfServiceIC.html" title="NimfServiceIC"><span class="type">NimfServiceIC</span></a> *ic</code></em>);</pre>
    290. 

  290. <p>Notifies the language engine that the caller has gained focus.</p>
    291. 

  291. <div class="refsect3">
    292. 

  292. <a name="nimf-engine-focus-in.parameters"></a><h4>Parameters</h4>
    293. 

  293. <div class="informaltable"><table class="informaltable" width="100%" border="0">
    294. 

  294. <colgroup>
    295. 

  295. <col width="150px" class="parameters_name">
    296. 

  296. <col class="parameters_description">
    297. 

  297. <col width="200px" class="parameters_annotations">
    298. 

  298. </colgroup>
    299. 

  299. <tbody>
    300. 

  300. <tr>
    301. 

  301. <td class="parameter_name"><p>engine</p></td>
    302. 

  302. <td class="parameter_description"><p>a <a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a></p></td>
    303. 

  303. <td class="parameter_annotations"> </td>
    304. 

  304. </tr>
    305. 

  305. <tr>
    306. 

  306. <td class="parameter_name"><p>ic</p></td>
    307. 

  307. <td class="parameter_description"><p>a <a class="link" href="NimfServiceIC.html" title="NimfServiceIC"><span class="type">NimfServiceIC</span></a> associated with <em class="parameter"><code>engine</code></em>
    308. 

  308. </p></td>
    309. 

  309. <td class="parameter_annotations"> </td>
    310. 

  310. </tr>
    311. 

  311. </tbody>
    312. 

  312. </table></div>
    313. 

  313. </div>
    314. 

  314. </div>
    315. 

  315. <hr>
    316. 

  316. <div class="refsect2">
    317. 

  317. <a name="nimf-engine-focus-out"></a><h3>nimf_engine_focus_out ()</h3>
    318. 

  318. <pre class="programlisting"><span class="returnvalue">void</span>
    319. 

  319. nimf_engine_focus_out (<em class="parameter"><code><a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a> *engine</code></em>,
    320. 

  320.                        <em class="parameter"><code><a class="link" href="NimfServiceIC.html" title="NimfServiceIC"><span class="type">NimfServiceIC</span></a> *ic</code></em>);</pre>
    321. 

  321. <p>Notifies the language engine that the caller has lost focus.</p>
    322. 

  322. <div class="refsect3">
    323. 

  323. <a name="nimf-engine-focus-out.parameters"></a><h4>Parameters</h4>
    324. 

  324. <div class="informaltable"><table class="informaltable" width="100%" border="0">
    325. 

  325. <colgroup>
    326. 

  326. <col width="150px" class="parameters_name">
    327. 

  327. <col class="parameters_description">
    328. 

  328. <col width="200px" class="parameters_annotations">
    329. 

  329. </colgroup>
    330. 

  330. <tbody>
    331. 

  331. <tr>
    332. 

  332. <td class="parameter_name"><p>engine</p></td>
    333. 

  333. <td class="parameter_description"><p>a <a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a></p></td>
    334. 

  334. <td class="parameter_annotations"> </td>
    335. 

  335. </tr>
    336. 

  336. <tr>
    337. 

  337. <td class="parameter_name"><p>ic</p></td>
    338. 

  338. <td class="parameter_description"><p>a <a class="link" href="NimfServiceIC.html" title="NimfServiceIC"><span class="type">NimfServiceIC</span></a> associated with <em class="parameter"><code>engine</code></em>
    339. 

  339. </p></td>
    340. 

  340. <td class="parameter_annotations"> </td>
    341. 

  341. </tr>
    342. 

  342. </tbody>
    343. 

  343. </table></div>
    344. 

  344. </div>
    345. 

  345. </div>
    346. 

  346. <hr>
    347. 

  347. <div class="refsect2">
    348. 

  348. <a name="nimf-engine-set-surrounding"></a><h3>nimf_engine_set_surrounding ()</h3>
    349. 

  349. <pre class="programlisting"><span class="returnvalue">void</span>
    350. 

  350. nimf_engine_set_surrounding (<em class="parameter"><code><a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a> *engine</code></em>,
    351. 

  351.                              <em class="parameter"><code>const <span class="type">char</span> *text</code></em>,
    352. 

  352.                              <em class="parameter"><code><span class="type">gint</span> len</code></em>,
    353. 

  353.                              <em class="parameter"><code><span class="type">gint</span> cursor_index</code></em>);</pre>
    354. 

  354. <p>Sets surrounding text in <em class="parameter"><code>engine</code></em>
    355. 

  355. . This function is expected to be
    356. 

  356. called in response to <a class="link" href="NimfEngine.html#nimf-engine-get-surrounding" title="nimf_engine_get_surrounding ()"><code class="function">nimf_engine_get_surrounding()</code></a>.</p>
    357. 

  357. <div class="refsect3">
    358. 

  358. <a name="nimf-engine-set-surrounding.parameters"></a><h4>Parameters</h4>
    359. 

  359. <div class="informaltable"><table class="informaltable" width="100%" border="0">
    360. 

  360. <colgroup>
    361. 

  361. <col width="150px" class="parameters_name">
    362. 

  362. <col class="parameters_description">
    363. 

  363. <col width="200px" class="parameters_annotations">
    364. 

  364. </colgroup>
    365. 

  365. <tbody>
    366. 

  366. <tr>
    367. 

  367. <td class="parameter_name"><p>engine</p></td>
    368. 

  368. <td class="parameter_description"><p>a <a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a></p></td>
    369. 

  369. <td class="parameter_annotations"> </td>
    370. 

  370. </tr>
    371. 

  371. <tr>
    372. 

  372. <td class="parameter_name"><p>text</p></td>
    373. 

  373. <td class="parameter_description"><p>surrounding text</p></td>
    374. 

  374. <td class="parameter_annotations"> </td>
    375. 

  375. </tr>
    376. 

  376. <tr>
    377. 

  377. <td class="parameter_name"><p>len</p></td>
    378. 

  378. <td class="parameter_description"><p>the byte length of <em class="parameter"><code>text</code></em>
    379. 

  379. </p></td>
    380. 

  380. <td class="parameter_annotations"> </td>
    381. 

  381. </tr>
    382. 

  382. <tr>
    383. 

  383. <td class="parameter_name"><p>cursor_index</p></td>
    384. 

  384. <td class="parameter_description"><p>the character index of the cursor within <em class="parameter"><code>text</code></em>
    385. 

  385. .</p></td>
    386. 

  386. <td class="parameter_annotations"> </td>
    387. 

  387. </tr>
    388. 

  388. </tbody>
    389. 

  389. </table></div>
    390. 

  390. </div>
    391. 

  391. </div>
    392. 

  392. <hr>
    393. 

  393. <div class="refsect2">
    394. 

  394. <a name="nimf-engine-get-surrounding"></a><h3>nimf_engine_get_surrounding ()</h3>
    395. 

  395. <pre class="programlisting"><span class="returnvalue">gboolean</span>
    396. 

  396. nimf_engine_get_surrounding (<em class="parameter"><code><a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a> *engine</code></em>,
    397. 

  397.                              <em class="parameter"><code><a class="link" href="NimfServiceIC.html" title="NimfServiceIC"><span class="type">NimfServiceIC</span></a> *ic</code></em>,
    398. 

  398.                              <em class="parameter"><code><span class="type">gchar</span> **text</code></em>,
    399. 

  399.                              <em class="parameter"><code><span class="type">gint</span> *cursor_index</code></em>);</pre>
    400. 

  400. <p>This function internally calls <a class="link" href="NimfEngine.html#nimf-engine-emit-retrieve-surrounding" title="nimf_engine_emit_retrieve_surrounding ()"><code class="function">nimf_engine_emit_retrieve_surrounding()</code></a>.
    401. 

  401. Gets surrounding text from the caller of <a class="link" href="NimfIM.html#nimf-im-set-surrounding" title="nimf_im_set_surrounding ()"><code class="function">nimf_im_set_surrounding()</code></a>,
    402. 

  402. if available.</p>
    403. 

  403. <div class="refsect3">
    404. 

  404. <a name="nimf-engine-get-surrounding.parameters"></a><h4>Parameters</h4>
    405. 

  405. <div class="informaltable"><table class="informaltable" width="100%" border="0">
    406. 

  406. <colgroup>
    407. 

  407. <col width="150px" class="parameters_name">
    408. 

  408. <col class="parameters_description">
    409. 

  409. <col width="200px" class="parameters_annotations">
    410. 

  410. </colgroup>
    411. 

  411. <tbody>
    412. 

  412. <tr>
    413. 

  413. <td class="parameter_name"><p>engine</p></td>
    414. 

  414. <td class="parameter_description"><p>a <a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a></p></td>
    415. 

  415. <td class="parameter_annotations"> </td>
    416. 

  416. </tr>
    417. 

  417. <tr>
    418. 

  418. <td class="parameter_name"><p>ic</p></td>
    419. 

  419. <td class="parameter_description"><p>a <a class="link" href="NimfServiceIC.html" title="NimfServiceIC"><span class="type">NimfServiceIC</span></a> associated with <em class="parameter"><code>engine</code></em>
    420. 

  420. </p></td>
    421. 

  421. <td class="parameter_annotations"> </td>
    422. 

  422. </tr>
    423. 

  423. <tr>
    424. 

  424. <td class="parameter_name"><p>text</p></td>
    425. 

  425. <td class="parameter_description"><p>location to store surrounding text. </p></td>
    426. 

  426. <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></td>
    427. 

  427. </tr>
    428. 

  428. <tr>
    429. 

  429. <td class="parameter_name"><p>cursor_index</p></td>
    430. 

  430. <td class="parameter_description"><p>location to store cursor index. </p></td>
    431. 

  431. <td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="The caller owns the data, and is responsible for free it."><span class="acronym">transfer full</span></acronym>]</span></td>
    432. 

  432. </tr>
    433. 

  433. </tbody>
    434. 

  434. </table></div>
    435. 

  435. </div>
    436. 

  436. <div class="refsect3">
    437. 

  437. <a name="nimf-engine-get-surrounding.returns"></a><h4>Returns</h4>
    438. 

  438. <p> <code class="literal">TRUE</code> if surrounding text is available</p>
    439. 

  439. </div>
    440. 

  440. </div>
    441. 

  441. <hr>
    442. 

  442. <div class="refsect2">
    443. 

  443. <a name="nimf-engine-status-changed"></a><h3>nimf_engine_status_changed ()</h3>
    444. 

  444. <pre class="programlisting"><span class="returnvalue">void</span>
    445. 

  445. nimf_engine_status_changed (<em class="parameter"><code><a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a> *engine</code></em>);</pre>
    446. 

  446. <p>Notifies that the status of the <em class="parameter"><code>engine</code></em>
    447. 

  447.  has changed.</p>
    448. 

  448. <div class="refsect3">
    449. 

  449. <a name="nimf-engine-status-changed.parameters"></a><h4>Parameters</h4>
    450. 

  450. <div class="informaltable"><table class="informaltable" width="100%" border="0">
    451. 

  451. <colgroup>
    452. 

  452. <col width="150px" class="parameters_name">
    453. 

  453. <col class="parameters_description">
    454. 

  454. <col width="200px" class="parameters_annotations">
    455. 

  455. </colgroup>
    456. 

  456. <tbody><tr>
    457. 

  457. <td class="parameter_name"><p>engine</p></td>
    458. 

  458. <td class="parameter_description"><p>a <a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a></p></td>
    459. 

  459. <td class="parameter_annotations"> </td>
    460. 

  460. </tr></tbody>
    461. 

  461. </table></div>
    462. 

  462. </div>
    463. 

  463. </div>
    464. 

  464. <hr>
    465. 

  465. <div class="refsect2">
    466. 

  466. <a name="nimf-engine-set-method"></a><h3>nimf_engine_set_method ()</h3>
    467. 

  467. <pre class="programlisting"><span class="returnvalue">void</span>
    468. 

  468. nimf_engine_set_method (<em class="parameter"><code><a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a> *engine</code></em>,
    469. 

  469.                         <em class="parameter"><code>const <span class="type">gchar</span> *method_id</code></em>);</pre>
    470. 

  470. <p>The engine may provide multiple input methods. Sets an input method by
    471. 

  471. <em class="parameter"><code>method_id</code></em>
    472. 

  472. </p>
    473. 

  473. <div class="refsect3">
    474. 

  474. <a name="nimf-engine-set-method.parameters"></a><h4>Parameters</h4>
    475. 

  475. <div class="informaltable"><table class="informaltable" width="100%" border="0">
    476. 

  476. <colgroup>
    477. 

  477. <col width="150px" class="parameters_name">
    478. 

  478. <col class="parameters_description">
    479. 

  479. <col width="200px" class="parameters_annotations">
    480. 

  480. </colgroup>
    481. 

  481. <tbody>
    482. 

  482. <tr>
    483. 

  483. <td class="parameter_name"><p>engine</p></td>
    484. 

  484. <td class="parameter_description"><p>a <a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a></p></td>
    485. 

  485. <td class="parameter_annotations"> </td>
    486. 

  486. </tr>
    487. 

  487. <tr>
    488. 

  488. <td class="parameter_name"><p>method_id</p></td>
    489. 

  489. <td class="parameter_description"><p>method id</p></td>
    490. 

  490. <td class="parameter_annotations"> </td>
    491. 

  491. </tr>
    492. 

  492. </tbody>
    493. 

  493. </table></div>
    494. 

  494. </div>
    495. 

  495. </div>
    496. 

  496. <hr>
    497. 

  497. <div class="refsect2">
    498. 

  498. <a name="nimf-engine-emit-preedit-start"></a><h3>nimf_engine_emit_preedit_start ()</h3>
    499. 

  499. <pre class="programlisting"><span class="returnvalue">void</span>
    500. 

  500. nimf_engine_emit_preedit_start (<em class="parameter"><code><a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a> *engine</code></em>,
    501. 

  501.                                 <em class="parameter"><code><a class="link" href="NimfServiceIC.html" title="NimfServiceIC"><span class="type">NimfServiceIC</span></a> *ic</code></em>);</pre>
    502. 

  502. <p>Emits the <a class="link" href="NimfIM.html#NimfIM-preedit-start" title="The “preedit-start” signal"><span class="type">“preedit-start”</span></a> signal.</p>
    503. 

  503. <div class="refsect3">
    504. 

  504. <a name="nimf-engine-emit-preedit-start.parameters"></a><h4>Parameters</h4>
    505. 

  505. <div class="informaltable"><table class="informaltable" width="100%" border="0">
    506. 

  506. <colgroup>
    507. 

  507. <col width="150px" class="parameters_name">
    508. 

  508. <col class="parameters_description">
    509. 

  509. <col width="200px" class="parameters_annotations">
    510. 

  510. </colgroup>
    511. 

  511. <tbody>
    512. 

  512. <tr>
    513. 

  513. <td class="parameter_name"><p>engine</p></td>
    514. 

  514. <td class="parameter_description"><p>a <a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a></p></td>
    515. 

  515. <td class="parameter_annotations"> </td>
    516. 

  516. </tr>
    517. 

  517. <tr>
    518. 

  518. <td class="parameter_name"><p>ic</p></td>
    519. 

  519. <td class="parameter_description"><p>a <a class="link" href="NimfServiceIC.html" title="NimfServiceIC"><span class="type">NimfServiceIC</span></a> associated with <em class="parameter"><code>engine</code></em>
    520. 

  520. </p></td>
    521. 

  521. <td class="parameter_annotations"> </td>
    522. 

  522. </tr>
    523. 

  523. </tbody>
    524. 

  524. </table></div>
    525. 

  525. </div>
    526. 

  526. </div>
    527. 

  527. <hr>
    528. 

  528. <div class="refsect2">
    529. 

  529. <a name="nimf-engine-emit-preedit-changed"></a><h3>nimf_engine_emit_preedit_changed ()</h3>
    530. 

  530. <pre class="programlisting"><span class="returnvalue">void</span>
    531. 

  531. nimf_engine_emit_preedit_changed (<em class="parameter"><code><a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a> *engine</code></em>,
    532. 

  532.                                   <em class="parameter"><code><a class="link" href="NimfServiceIC.html" title="NimfServiceIC"><span class="type">NimfServiceIC</span></a> *ic</code></em>,
    533. 

  533.                                   <em class="parameter"><code>const <span class="type">gchar</span> *preedit_string</code></em>,
    534. 

  534.                                   <em class="parameter"><code><a class="link" href="nimf-types.html#NimfPreeditAttr" title="NimfPreeditAttr"><span class="type">NimfPreeditAttr</span></a> **attrs</code></em>,
    535. 

  535.                                   <em class="parameter"><code><span class="type">gint</span> cursor_pos</code></em>);</pre>
    536. 

  536. <p>Emits the <a class="link" href="NimfIM.html#NimfIM-preedit-changed" title="The “preedit-changed” signal"><span class="type">“preedit-changed”</span></a> signal.</p>
    537. 

  537. <div class="refsect3">
    538. 

  538. <a name="nimf-engine-emit-preedit-changed.parameters"></a><h4>Parameters</h4>
    539. 

  539. <div class="informaltable"><table class="informaltable" width="100%" border="0">
    540. 

  540. <colgroup>
    541. 

  541. <col width="150px" class="parameters_name">
    542. 

  542. <col class="parameters_description">
    543. 

  543. <col width="200px" class="parameters_annotations">
    544. 

  544. </colgroup>
    545. 

  545. <tbody>
    546. 

  546. <tr>
    547. 

  547. <td class="parameter_name"><p>engine</p></td>
    548. 

  548. <td class="parameter_description"><p>a <a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a></p></td>
    549. 

  549. <td class="parameter_annotations"> </td>
    550. 

  550. </tr>
    551. 

  551. <tr>
    552. 

  552. <td class="parameter_name"><p>ic</p></td>
    553. 

  553. <td class="parameter_description"><p>a <a class="link" href="NimfServiceIC.html" title="NimfServiceIC"><span class="type">NimfServiceIC</span></a> associated with <em class="parameter"><code>engine</code></em>
    554. 

  554. </p></td>
    555. 

  555. <td class="parameter_annotations"> </td>
    556. 

  556. </tr>
    557. 

  557. <tr>
    558. 

  558. <td class="parameter_name"><p>preedit_string</p></td>
    559. 

  559. <td class="parameter_description"><p>preedit string</p></td>
    560. 

  560. <td class="parameter_annotations"> </td>
    561. 

  561. </tr>
    562. 

  562. <tr>
    563. 

  563. <td class="parameter_name"><p>attrs</p></td>
    564. 

  564. <td class="parameter_description"><p><a class="link" href="nimf-types.html#NimfPreeditAttr" title="NimfPreeditAttr"><span class="type">NimfPreeditAttr</span></a> array</p></td>
    565. 

  565. <td class="parameter_annotations"> </td>
    566. 

  566. </tr>
    567. 

  567. <tr>
    568. 

  568. <td class="parameter_name"><p>cursor_pos</p></td>
    569. 

  569. <td class="parameter_description"><p>cursor position within <em class="parameter"><code>preedit_string</code></em>
    570. 

  570. </p></td>
    571. 

  571. <td class="parameter_annotations"> </td>
    572. 

  572. </tr>
    573. 

  573. </tbody>
    574. 

  574. </table></div>
    575. 

  575. </div>
    576. 

  576. </div>
    577. 

  577. <hr>
    578. 

  578. <div class="refsect2">
    579. 

  579. <a name="nimf-engine-emit-preedit-end"></a><h3>nimf_engine_emit_preedit_end ()</h3>
    580. 

  580. <pre class="programlisting"><span class="returnvalue">void</span>
    581. 

  581. nimf_engine_emit_preedit_end (<em class="parameter"><code><a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a> *engine</code></em>,
    582. 

  582.                               <em class="parameter"><code><a class="link" href="NimfServiceIC.html" title="NimfServiceIC"><span class="type">NimfServiceIC</span></a> *ic</code></em>);</pre>
    583. 

  583. <p>Emits the <a class="link" href="NimfIM.html#NimfIM-preedit-end" title="The “preedit-end” signal"><span class="type">“preedit-end”</span></a> signal.</p>
    584. 

  584. <div class="refsect3">
    585. 

  585. <a name="nimf-engine-emit-preedit-end.parameters"></a><h4>Parameters</h4>
    586. 

  586. <div class="informaltable"><table class="informaltable" width="100%" border="0">
    587. 

  587. <colgroup>
    588. 

  588. <col width="150px" class="parameters_name">
    589. 

  589. <col class="parameters_description">
    590. 

  590. <col width="200px" class="parameters_annotations">
    591. 

  591. </colgroup>
    592. 

  592. <tbody>
    593. 

  593. <tr>
    594. 

  594. <td class="parameter_name"><p>engine</p></td>
    595. 

  595. <td class="parameter_description"><p>a <a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a></p></td>
    596. 

  596. <td class="parameter_annotations"> </td>
    597. 

  597. </tr>
    598. 

  598. <tr>
    599. 

  599. <td class="parameter_name"><p>ic</p></td>
    600. 

  600. <td class="parameter_description"><p>a <a class="link" href="NimfServiceIC.html" title="NimfServiceIC"><span class="type">NimfServiceIC</span></a> associated with <em class="parameter"><code>engine</code></em>
    601. 

  601. </p></td>
    602. 

  602. <td class="parameter_annotations"> </td>
    603. 

  603. </tr>
    604. 

  604. </tbody>
    605. 

  605. </table></div>
    606. 

  606. </div>
    607. 

  607. </div>
    608. 

  608. <hr>
    609. 

  609. <div class="refsect2">
    610. 

  610. <a name="nimf-engine-emit-commit"></a><h3>nimf_engine_emit_commit ()</h3>
    611. 

  611. <pre class="programlisting"><span class="returnvalue">void</span>
    612. 

  612. nimf_engine_emit_commit (<em class="parameter"><code><a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a> *engine</code></em>,
    613. 

  613.                          <em class="parameter"><code><a class="link" href="NimfServiceIC.html" title="NimfServiceIC"><span class="type">NimfServiceIC</span></a> *ic</code></em>,
    614. 

  614.                          <em class="parameter"><code><span class="type">gchar</span> const *text</code></em>);</pre>
    615. 

  615. <p>Emits the <a class="link" href="NimfIM.html#NimfIM-commit" title="The “commit” signal"><span class="type">“commit”</span></a> signal.</p>
    616. 

  616. <div class="refsect3">
    617. 

  617. <a name="nimf-engine-emit-commit.parameters"></a><h4>Parameters</h4>
    618. 

  618. <div class="informaltable"><table class="informaltable" width="100%" border="0">
    619. 

  619. <colgroup>
    620. 

  620. <col width="150px" class="parameters_name">
    621. 

  621. <col class="parameters_description">
    622. 

  622. <col width="200px" class="parameters_annotations">
    623. 

  623. </colgroup>
    624. 

  624. <tbody>
    625. 

  625. <tr>
    626. 

  626. <td class="parameter_name"><p>engine</p></td>
    627. 

  627. <td class="parameter_description"><p>a <a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a></p></td>
    628. 

  628. <td class="parameter_annotations"> </td>
    629. 

  629. </tr>
    630. 

  630. <tr>
    631. 

  631. <td class="parameter_name"><p>ic</p></td>
    632. 

  632. <td class="parameter_description"><p>a <a class="link" href="NimfServiceIC.html" title="NimfServiceIC"><span class="type">NimfServiceIC</span></a> associated with <em class="parameter"><code>engine</code></em>
    633. 

  633. </p></td>
    634. 

  634. <td class="parameter_annotations"> </td>
    635. 

  635. </tr>
    636. 

  636. <tr>
    637. 

  637. <td class="parameter_name"><p>text</p></td>
    638. 

  638. <td class="parameter_description"><p>text to commit</p></td>
    639. 

  639. <td class="parameter_annotations"> </td>
    640. 

  640. </tr>
    641. 

  641. </tbody>
    642. 

  642. </table></div>
    643. 

  643. </div>
    644. 

  644. </div>
    645. 

  645. <hr>
    646. 

  646. <div class="refsect2">
    647. 

  647. <a name="nimf-engine-emit-retrieve-surrounding"></a><h3>nimf_engine_emit_retrieve_surrounding ()</h3>
    648. 

  648. <pre class="programlisting"><span class="returnvalue">gboolean</span>
    649. 

  649. nimf_engine_emit_retrieve_surrounding (<em class="parameter"><code><a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a> *engine</code></em>,
    650. 

  650.                                        <em class="parameter"><code><a class="link" href="NimfServiceIC.html" title="NimfServiceIC"><span class="type">NimfServiceIC</span></a> *ic</code></em>);</pre>
    651. 

  651. <p>Emits the <a class="link" href="NimfIM.html#NimfIM-retrieve-surrounding" title="The “retrieve-surrounding” signal"><span class="type">“retrieve-surrounding”</span></a> signal.</p>
    652. 

  652. <div class="refsect3">
    653. 

  653. <a name="nimf-engine-emit-retrieve-surrounding.parameters"></a><h4>Parameters</h4>
    654. 

  654. <div class="informaltable"><table class="informaltable" width="100%" border="0">
    655. 

  655. <colgroup>
    656. 

  656. <col width="150px" class="parameters_name">
    657. 

  657. <col class="parameters_description">
    658. 

  658. <col width="200px" class="parameters_annotations">
    659. 

  659. </colgroup>
    660. 

  660. <tbody>
    661. 

  661. <tr>
    662. 

  662. <td class="parameter_name"><p>engine</p></td>
    663. 

  663. <td class="parameter_description"><p>a <a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a></p></td>
    664. 

  664. <td class="parameter_annotations"> </td>
    665. 

  665. </tr>
    666. 

  666. <tr>
    667. 

  667. <td class="parameter_name"><p>ic</p></td>
    668. 

  668. <td class="parameter_description"><p>a <a class="link" href="NimfServiceIC.html" title="NimfServiceIC"><span class="type">NimfServiceIC</span></a> associated with <em class="parameter"><code>engine</code></em>
    669. 

  669. </p></td>
    670. 

  670. <td class="parameter_annotations"> </td>
    671. 

  671. </tr>
    672. 

  672. </tbody>
    673. 

  673. </table></div>
    674. 

  674. </div>
    675. 

  675. </div>
    676. 

  676. <hr>
    677. 

  677. <div class="refsect2">
    678. 

  678. <a name="nimf-engine-emit-delete-surrounding"></a><h3>nimf_engine_emit_delete_surrounding ()</h3>
    679. 

  679. <pre class="programlisting"><span class="returnvalue">gboolean</span>
    680. 

  680. nimf_engine_emit_delete_surrounding (<em class="parameter"><code><a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a> *engine</code></em>,
    681. 

  681.                                      <em class="parameter"><code><a class="link" href="NimfServiceIC.html" title="NimfServiceIC"><span class="type">NimfServiceIC</span></a> *ic</code></em>,
    682. 

  682.                                      <em class="parameter"><code><span class="type">gint</span> offset</code></em>,
    683. 

  683.                                      <em class="parameter"><code><span class="type">gint</span> n_chars</code></em>);</pre>
    684. 

  684. <p>Emits the <a class="link" href="NimfIM.html#NimfIM-delete-surrounding" title="The “delete-surrounding” signal"><span class="type">“delete-surrounding”</span></a> signal.</p>
    685. 

  685. <div class="refsect3">
    686. 

  686. <a name="nimf-engine-emit-delete-surrounding.parameters"></a><h4>Parameters</h4>
    687. 

  687. <div class="informaltable"><table class="informaltable" width="100%" border="0">
    688. 

  688. <colgroup>
    689. 

  689. <col width="150px" class="parameters_name">
    690. 

  690. <col class="parameters_description">
    691. 

  691. <col width="200px" class="parameters_annotations">
    692. 

  692. </colgroup>
    693. 

  693. <tbody>
    694. 

  694. <tr>
    695. 

  695. <td class="parameter_name"><p>engine</p></td>
    696. 

  696. <td class="parameter_description"><p>a <a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a></p></td>
    697. 

  697. <td class="parameter_annotations"> </td>
    698. 

  698. </tr>
    699. 

  699. <tr>
    700. 

  700. <td class="parameter_name"><p>ic</p></td>
    701. 

  701. <td class="parameter_description"><p>a <a class="link" href="NimfServiceIC.html" title="NimfServiceIC"><span class="type">NimfServiceIC</span></a> associated with <em class="parameter"><code>engine</code></em>
    702. 

  702. </p></td>
    703. 

  703. <td class="parameter_annotations"> </td>
    704. 

  704. </tr>
    705. 

  705. <tr>
    706. 

  706. <td class="parameter_name"><p>offset</p></td>
    707. 

  707. <td class="parameter_description"><p>the character offset from the cursor position of the text to be
    708. 

  708. deleted. A negative value indicates a position before the cursor.</p></td>
    709. 

  709. <td class="parameter_annotations"> </td>
    710. 

  710. </tr>
    711. 

  711. <tr>
    712. 

  712. <td class="parameter_name"><p>n_chars</p></td>
    713. 

  713. <td class="parameter_description"><p>the number of characters to be deleted</p></td>
    714. 

  714. <td class="parameter_annotations"> </td>
    715. 

  715. </tr>
    716. 

  716. </tbody>
    717. 

  717. </table></div>
    718. 

  718. </div>
    719. 

  719. </div>
    720. 

  720. <hr>
    721. 

  721. <div class="refsect2">
    722. 

  722. <a name="nimf-engine-emit-beep"></a><h3>nimf_engine_emit_beep ()</h3>
    723. 

  723. <pre class="programlisting"><span class="returnvalue">void</span>
    724. 

  724. nimf_engine_emit_beep (<em class="parameter"><code><a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a> *engine</code></em>,
    725. 

  725.                        <em class="parameter"><code><a class="link" href="NimfServiceIC.html" title="NimfServiceIC"><span class="type">NimfServiceIC</span></a> *ic</code></em>);</pre>
    726. 

  726. <p>Emits the <a class="link" href="NimfIM.html#NimfIM-beep" title="The “beep” signal"><span class="type">“beep”</span></a> signal.</p>
    727. 

  727. <div class="refsect3">
    728. 

  728. <a name="nimf-engine-emit-beep.parameters"></a><h4>Parameters</h4>
    729. 

  729. <div class="informaltable"><table class="informaltable" width="100%" border="0">
    730. 

  730. <colgroup>
    731. 

  731. <col width="150px" class="parameters_name">
    732. 

  732. <col class="parameters_description">
    733. 

  733. <col width="200px" class="parameters_annotations">
    734. 

  734. </colgroup>
    735. 

  735. <tbody>
    736. 

  736. <tr>
    737. 

  737. <td class="parameter_name"><p>engine</p></td>
    738. 

  738. <td class="parameter_description"><p>a <a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a></p></td>
    739. 

  739. <td class="parameter_annotations"> </td>
    740. 

  740. </tr>
    741. 

  741. <tr>
    742. 

  742. <td class="parameter_name"><p>ic</p></td>
    743. 

  743. <td class="parameter_description"><p>a <a class="link" href="NimfServiceIC.html" title="NimfServiceIC"><span class="type">NimfServiceIC</span></a> associated with <em class="parameter"><code>engine</code></em>
    744. 

  744. </p></td>
    745. 

  745. <td class="parameter_annotations"> </td>
    746. 

  746. </tr>
    747. 

  747. </tbody>
    748. 

  748. </table></div>
    749. 

  749. </div>
    750. 

  750. </div>
    751. 

  751. <hr>
    752. 

  752. <div class="refsect2">
    753. 

  753. <a name="nimf-engine-get-id"></a><h3>nimf_engine_get_id ()</h3>
    754. 

  754. <pre class="programlisting">const <span class="returnvalue">gchar</span> *
    755. 

  755. nimf_engine_get_id (<em class="parameter"><code><a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a> *engine</code></em>);</pre>
    756. 

  756. <div class="refsect3">
    757. 

  757. <a name="nimf-engine-get-id.parameters"></a><h4>Parameters</h4>
    758. 

  758. <div class="informaltable"><table class="informaltable" width="100%" border="0">
    759. 

  759. <colgroup>
    760. 

  760. <col width="150px" class="parameters_name">
    761. 

  761. <col class="parameters_description">
    762. 

  762. <col width="200px" class="parameters_annotations">
    763. 

  763. </colgroup>
    764. 

  764. <tbody><tr>
    765. 

  765. <td class="parameter_name"><p>engine</p></td>
    766. 

  766. <td class="parameter_description"><p><a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a></p></td>
    767. 

  767. <td class="parameter_annotations"> </td>
    768. 

  768. </tr></tbody>
    769. 

  769. </table></div>
    770. 

  770. </div>
    771. 

  771. <div class="refsect3">
    772. 

  772. <a name="nimf-engine-get-id.returns"></a><h4>Returns</h4>
    773. 

  773. <p>engine id. </p>
    774. 

  774. <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>
    775. 

  775. </div>
    776. 

  776. </div>
    777. 

  777. <hr>
    778. 

  778. <div class="refsect2">
    779. 

  779. <a name="nimf-engine-get-icon-name"></a><h3>nimf_engine_get_icon_name ()</h3>
    780. 

  780. <pre class="programlisting">const <span class="returnvalue">gchar</span> *
    781. 

  781. nimf_engine_get_icon_name (<em class="parameter"><code><a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a> *engine</code></em>);</pre>
    782. 

  782. <div class="refsect3">
    783. 

  783. <a name="nimf-engine-get-icon-name.parameters"></a><h4>Parameters</h4>
    784. 

  784. <div class="informaltable"><table class="informaltable" width="100%" border="0">
    785. 

  785. <colgroup>
    786. 

  786. <col width="150px" class="parameters_name">
    787. 

  787. <col class="parameters_description">
    788. 

  788. <col width="200px" class="parameters_annotations">
    789. 

  789. </colgroup>
    790. 

  790. <tbody><tr>
    791. 

  791. <td class="parameter_name"><p>engine</p></td>
    792. 

  792. <td class="parameter_description"><p><a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a></p></td>
    793. 

  793. <td class="parameter_annotations"> </td>
    794. 

  794. </tr></tbody>
    795. 

  795. </table></div>
    796. 

  796. </div>
    797. 

  797. <div class="refsect3">
    798. 

  798. <a name="nimf-engine-get-icon-name.returns"></a><h4>Returns</h4>
    799. 

  799. <p>icon name. </p>
    800. 

  800. <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>
    801. 

  801. </div>
    802. 

  802. </div>
    803. 

  803. <hr>
    804. 

  804. <div class="refsect2">
    805. 

  805. <a name="nimf-engine-get-candidatable"></a><h3>nimf_engine_get_candidatable ()</h3>
    806. 

  806. <pre class="programlisting"><a class="link" href="NimfCandidatable.html" title="NimfCandidatable"><span class="returnvalue">NimfCandidatable</span></a> *
    807. 

  807. nimf_engine_get_candidatable (<em class="parameter"><code><a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a> *engine</code></em>);</pre>
    808. 

  808. <div class="refsect3">
    809. 

  809. <a name="nimf-engine-get-candidatable.parameters"></a><h4>Parameters</h4>
    810. 

  810. <div class="informaltable"><table class="informaltable" width="100%" border="0">
    811. 

  811. <colgroup>
    812. 

  812. <col width="150px" class="parameters_name">
    813. 

  813. <col class="parameters_description">
    814. 

  814. <col width="200px" class="parameters_annotations">
    815. 

  815. </colgroup>
    816. 

  816. <tbody><tr>
    817. 

  817. <td class="parameter_name"><p>engine</p></td>
    818. 

  818. <td class="parameter_description"><p><a class="link" href="NimfEngine.html" title="NimfEngine"><span class="type">NimfEngine</span></a></p></td>
    819. 

  819. <td class="parameter_annotations"> </td>
    820. 

  820. </tr></tbody>
    821. 

  821. </table></div>
    822. 

  822. </div>
    823. 

  823. <div class="refsect3">
    824. 

  824. <a name="nimf-engine-get-candidatable.returns"></a><h4>Returns</h4>
    825. 

  825. <p>a <a class="link" href="NimfCandidatable.html" title="NimfCandidatable"><span class="type">NimfCandidatable</span></a>. </p>
    826. 

  826. <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>
    827. 

  827. </div>
    828. 

  828. </div>
    829. 

  829. </div>
    830. 

  830. <div class="refsect1">
    831. 

  831. <a name="NimfEngine.other_details"></a><h2>Types and Values</h2>
    832. 

  832. <div class="refsect2">
    833. 

  833. <a name="NimfEngineClass"></a><h3>struct NimfEngineClass</h3>
    834. 

  834. <pre class="programlisting">struct NimfEngineClass {
    835. 

  835.   /* Virtual functions */
    836. 

  836.   gboolean (* filter_event)       (NimfEngine          *engine,
    837. 

  837.                                    NimfServiceIC       *ic,
    838. 

  838.                                    NimfEvent           *event);
    839. 

  839.   void     (* reset)              (NimfEngine          *engine,
    840. 

  840.                                    NimfServiceIC       *ic);
    841. 

  841.   void     (* focus_in)           (NimfEngine          *engine,
    842. 

  842.                                    NimfServiceIC       *ic);
    843. 

  843.   void     (* focus_out)          (NimfEngine          *engine,
    844. 

  844.                                    NimfServiceIC       *ic);
    845. 

  845.   void     (* set_method)         (NimfEngine          *engine,
    846. 

  846.                                    const gchar         *method_id);
    847. 

  847.   /* candidate */
    848. 

  848.   gboolean (* candidate_page_up)   (NimfEngine         *engine,
    849. 

  849.                                     NimfServiceIC      *ic);
    850. 

  850.   gboolean (* candidate_page_down) (NimfEngine         *engine,
    851. 

  851.                                     NimfServiceIC      *ic);
    852. 

  852.   void     (* candidate_clicked)   (NimfEngine         *engine,
    853. 

  853.                                     NimfServiceIC      *ic,
    854. 

  854.                                     gchar              *text,
    855. 

  855.                                     gint                index);
    856. 

  856.   void     (* candidate_scrolled)  (NimfEngine         *engine,
    857. 

  857.                                     NimfServiceIC      *ic,
    858. 

  858.                                     gdouble             value);
    859. 

  859.   /* info */
    860. 

  860.   const gchar * (* get_id)        (NimfEngine          *engine);
    861. 

  861.   const gchar * (* get_icon_name) (NimfEngine          *engine);
    862. 

  862. };
    863. 

  863. </pre>
    864. 

  864. <div class="refsect3">
    865. 

  865. <a name="NimfEngineClass.members"></a><h4>Members</h4>
    866. 

  866. <div class="informaltable"><table class="informaltable" width="100%" border="0">
    867. 

  867. <colgroup>
    868. 

  868. <col width="300px" class="struct_members_name">
    869. 

  869. <col class="struct_members_description">
    870. 

  870. <col width="200px" class="struct_members_annotations">
    871. 

  871. </colgroup>
    872. 

  872. <tbody>
    873. 

  873. <tr>
    874. 

  874. <td class="struct_member_name"><p><em class="structfield"><code><a name="NimfEngineClass.filter-event"></a>filter_event</code></em> ()</p></td>
    875. 

  875. <td class="struct_member_description"><p>If the language engine consumes the event, returns <code class="literal">TRUE</code>.</p></td>
    876. 

  876. <td class="struct_member_annotations"> </td>
    877. 

  877. </tr>
    878. 

  878. <tr>
    879. 

  879. <td class="struct_member_name"><p><em class="structfield"><code><a name="NimfEngineClass.reset"></a>reset</code></em> ()</p></td>
    880. 

  880. <td class="struct_member_description"><p>Resets the language engine.</p></td>
    881. 

  881. <td class="struct_member_annotations"> </td>
    882. 

  882. </tr>
    883. 

  883. <tr>
    884. 

  884. <td class="struct_member_name"><p><em class="structfield"><code><a name="NimfEngineClass.focus-in"></a>focus_in</code></em> ()</p></td>
    885. 

  885. <td class="struct_member_description"><p>Called via <a class="link" href="NimfIM.html#nimf-im-focus-in" title="nimf_im_focus_in ()"><code class="function">nimf_im_focus_in()</code></a> when the caller has gained focus.</p></td>
    886. 

  886. <td class="struct_member_annotations"> </td>
    887. 

  887. </tr>
    888. 

  888. <tr>
    889. 

  889. <td class="struct_member_name"><p><em class="structfield"><code><a name="NimfEngineClass.focus-out"></a>focus_out</code></em> ()</p></td>
    890. 

  890. <td class="struct_member_description"><p>Called via <a class="link" href="NimfIM.html#nimf-im-focus-out" title="nimf_im_focus_out ()"><code class="function">nimf_im_focus_out()</code></a> when the caller has lost focus.</p></td>
    891. 

  891. <td class="struct_member_annotations"> </td>
    892. 

  892. </tr>
    893. 

  893. <tr>
    894. 

  894. <td class="struct_member_name"><p><em class="structfield"><code><a name="NimfEngineClass.set-method"></a>set_method</code></em> ()</p></td>
    895. 

  895. <td class="struct_member_description"><p>Sets the method in the language engine.</p></td>
    896. 

  896. <td class="struct_member_annotations"> </td>
    897. 

  897. </tr>
    898. 

  898. <tr>
    899. 

  899. <td class="struct_member_name"><p><em class="structfield"><code><a name="NimfEngineClass.candidate-page-up"></a>candidate_page_up</code></em> ()</p></td>
    900. 

  900. <td class="struct_member_description"><p>handler when candidate page up</p></td>
    901. 

  901. <td class="struct_member_annotations"> </td>
    902. 

  902. </tr>
    903. 

  903. <tr>
    904. 

  904. <td class="struct_member_name"><p><em class="structfield"><code><a name="NimfEngineClass.candidate-page-down"></a>candidate_page_down</code></em> ()</p></td>
    905. 

  905. <td class="struct_member_description"><p>handler when candidate page down</p></td>
    906. 

  906. <td class="struct_member_annotations"> </td>
    907. 

  907. </tr>
    908. 

  908. <tr>
    909. 

  909. <td class="struct_member_name"><p><em class="structfield"><code><a name="NimfEngineClass.candidate-clicked"></a>candidate_clicked</code></em> ()</p></td>
    910. 

  910. <td class="struct_member_description"><p>handler when candidate clicked</p></td>
    911. 

  911. <td class="struct_member_annotations"> </td>
    912. 

  912. </tr>
    913. 

  913. <tr>
    914. 

  914. <td class="struct_member_name"><p><em class="structfield"><code><a name="NimfEngineClass.candidate-scrolled"></a>candidate_scrolled</code></em> ()</p></td>
    915. 

  915. <td class="struct_member_description"><p>handler when candidate scrolled</p></td>
    916. 

  916. <td class="struct_member_annotations"> </td>
    917. 

  917. </tr>
    918. 

  918. <tr>
    919. 

  919. <td class="struct_member_name"><p><em class="structfield"><code><a name="NimfEngineClass.get-id"></a>get_id</code></em> ()</p></td>
    920. 

  920. <td class="struct_member_description"><p>Gets the language engine id.</p></td>
    921. 

  921. <td class="struct_member_annotations"> </td>
    922. 

  922. </tr>
    923. 

  923. <tr>
    924. 

  924. <td class="struct_member_name"><p><em class="structfield"><code><a name="NimfEngineClass.get-icon-name"></a>get_icon_name</code></em> ()</p></td>
    925. 

  925. <td class="struct_member_description"><p>Gets the language engine name.</p></td>
    926. 

  926. <td class="struct_member_annotations"> </td>
    927. 

  927. </tr>
    928. 

  928. </tbody>
    929. 

  929. </table></div>
    930. 

  930. </div>
    931. 

  931. </div>
    932. 

  932. </div>
    933. 

  933. </div>
    934. 

  934. <div class="footer">
    935. 

  935. <hr>Generated by GTK-Doc V1.34.0</div>
    936. 

  936. </body>
    937. 

  937. </html>
    938.