NimfPreeditable.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
  2. <html>
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  5. <title>NimfPreeditable: Nimf Reference Manual</title>
  6. <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
  7. <link rel="home" href="index.html" title="Nimf Reference Manual">
  8. <link rel="up" href="interfaces.html" title="Interfaces">
  9. <link rel="prev" href="NimfCandidatable.html" title="NimfCandidatable">
  10. <link rel="next" href="abstract-classes.html" title="Abstract Classes">
  11. <meta name="generator" content="GTK-Doc V1.34.0 (XML mode)">
  12. <link rel="stylesheet" href="style.css" type="text/css">
  13. </head>
  14. <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  15. <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
  16. <td width="100%" align="left" class="shortcuts">
  17. <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
  18. <a href="#NimfPreeditable.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
  19. <a href="#NimfPreeditable.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites">  <span class="dim">|</span> 
  20. <a href="#NimfPreeditable.prerequisites" class="shortcut">Prerequisites</a></span>
  21. </td>
  22. <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  23. <td><a accesskey="u" href="interfaces.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  24. <td><a accesskey="p" href="NimfCandidatable.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  25. <td><a accesskey="n" href="abstract-classes.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  26. </tr></table>
  27. <div class="refentry">
  28. <a name="NimfPreeditable"></a><div class="titlepage"></div>
  29. <div class="refnamediv"><table width="100%"><tr>
  30. <td valign="top">
  31. <h2><span class="refentrytitle"><a name="NimfPreeditable.top_of_page"></a>NimfPreeditable</span></h2>
  32. <p>NimfPreeditable</p>
  33. </td>
  34. <td class="gallery_image" valign="top" align="right"></td>
  35. </tr></table></div>
  36. <div class="refsect1">
  37. <a name="NimfPreeditable.functions"></a><h2>Functions</h2>
  38. <div class="informaltable"><table class="informaltable" width="100%" border="0">
  39. <colgroup>
  40. <col width="150px" class="functions_proto_type">
  41. <col class="functions_proto_name">
  42. </colgroup>
  43. <tbody>
  44. <tr>
  45. <td class="function_type">
  46. <span class="returnvalue">void</span>
  47. </td>
  48. <td class="function_name">
  49. <a class="link" href="NimfPreeditable.html#nimf-preeditable-show" title="nimf_preeditable_show ()">nimf_preeditable_show</a> <span class="c_punctuation">()</span>
  50. </td>
  51. </tr>
  52. <tr>
  53. <td class="function_type">
  54. <span class="returnvalue">void</span>
  55. </td>
  56. <td class="function_name">
  57. <a class="link" href="NimfPreeditable.html#nimf-preeditable-hide" title="nimf_preeditable_hide ()">nimf_preeditable_hide</a> <span class="c_punctuation">()</span>
  58. </td>
  59. </tr>
  60. <tr>
  61. <td class="function_type">
  62. <span class="returnvalue">gboolean</span>
  63. </td>
  64. <td class="function_name">
  65. <a class="link" href="NimfPreeditable.html#nimf-preeditable-is-visible" title="nimf_preeditable_is_visible ()">nimf_preeditable_is_visible</a> <span class="c_punctuation">()</span>
  66. </td>
  67. </tr>
  68. <tr>
  69. <td class="function_type">
  70. <span class="returnvalue">void</span>
  71. </td>
  72. <td class="function_name">
  73. <a class="link" href="NimfPreeditable.html#nimf-preeditable-set-text" title="nimf_preeditable_set_text ()">nimf_preeditable_set_text</a> <span class="c_punctuation">()</span>
  74. </td>
  75. </tr>
  76. <tr>
  77. <td class="function_type">
  78. <span class="returnvalue">void</span>
  79. </td>
  80. <td class="function_name">
  81. <a class="link" href="NimfPreeditable.html#nimf-preeditable-set-cursor-location" title="nimf_preeditable_set_cursor_location ()">nimf_preeditable_set_cursor_location</a> <span class="c_punctuation">()</span>
  82. </td>
  83. </tr>
  84. </tbody>
  85. </table></div>
  86. </div>
  87. <div class="refsect1">
  88. <a name="NimfPreeditable.other"></a><h2>Types and Values</h2>
  89. <div class="informaltable"><table class="informaltable" width="100%" border="0">
  90. <colgroup>
  91. <col width="150px" class="other_proto_type">
  92. <col class="other_proto_name">
  93. </colgroup>
  94. <tbody>
  95. <tr>
  96. <td class="define_keyword">#define</td>
  97. <td class="function_name"><a class="link" href="NimfPreeditable.html#NIMF-TYPE-PREEDITABLE:CAPS" title="NIMF_TYPE_PREEDITABLE">NIMF_TYPE_PREEDITABLE</a></td>
  98. </tr>
  99. <tr>
  100. <td class="datatype_keyword">struct</td>
  101. <td class="function_name"><a class="link" href="NimfPreeditable.html#NimfPreeditableInterface" title="struct NimfPreeditableInterface">NimfPreeditableInterface</a></td>
  102. </tr>
  103. <tr>
  104. <td class="datatype_keyword"> </td>
  105. <td class="function_name"><a class="link" href="NimfPreeditable.html#NimfPreeditable-struct" title="NimfPreeditable">NimfPreeditable</a></td>
  106. </tr>
  107. </tbody>
  108. </table></div>
  109. </div>
  110. <div class="refsect1">
  111. <a name="NimfPreeditable.object-hierarchy"></a><h2>Object Hierarchy</h2>
  112. <pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/GTypeModule.html">GInterface</a>
  113. <span class="lineart">╰──</span> NimfPreeditable
  114. </pre>
  115. </div>
  116. <div class="refsect1">
  117. <a name="NimfPreeditable.prerequisites"></a><h2>Prerequisites</h2>
  118. <p>
  119. NimfPreeditable requires
  120. GObject.</p>
  121. </div>
  122. <div class="refsect1">
  123. <a name="NimfPreeditable.description"></a><h2>Description</h2>
  124. </div>
  125. <div class="refsect1">
  126. <a name="NimfPreeditable.functions_details"></a><h2>Functions</h2>
  127. <div class="refsect2">
  128. <a name="nimf-preeditable-show"></a><h3>nimf_preeditable_show ()</h3>
  129. <pre class="programlisting"><span class="returnvalue">void</span>
  130. nimf_preeditable_show (<em class="parameter"><code><a class="link" href="NimfPreeditable.html" title="NimfPreeditable"><span class="type">NimfPreeditable</span></a> *preeditable</code></em>);</pre>
  131. <p>Shows <em class="parameter"><code>preeditable</code></em>
  132. </p>
  133. <div class="refsect3">
  134. <a name="nimf-preeditable-show.parameters"></a><h4>Parameters</h4>
  135. <div class="informaltable"><table class="informaltable" width="100%" border="0">
  136. <colgroup>
  137. <col width="150px" class="parameters_name">
  138. <col class="parameters_description">
  139. <col width="200px" class="parameters_annotations">
  140. </colgroup>
  141. <tbody><tr>
  142. <td class="parameter_name"><p>preeditable</p></td>
  143. <td class="parameter_description"><p>a <a class="link" href="NimfPreeditable.html" title="NimfPreeditable"><span class="type">NimfPreeditable</span></a></p></td>
  144. <td class="parameter_annotations"> </td>
  145. </tr></tbody>
  146. </table></div>
  147. </div>
  148. </div>
  149. <hr>
  150. <div class="refsect2">
  151. <a name="nimf-preeditable-hide"></a><h3>nimf_preeditable_hide ()</h3>
  152. <pre class="programlisting"><span class="returnvalue">void</span>
  153. nimf_preeditable_hide (<em class="parameter"><code><a class="link" href="NimfPreeditable.html" title="NimfPreeditable"><span class="type">NimfPreeditable</span></a> *preeditable</code></em>);</pre>
  154. <p>Hides the <em class="parameter"><code>preeditable</code></em>
  155. </p>
  156. <div class="refsect3">
  157. <a name="nimf-preeditable-hide.parameters"></a><h4>Parameters</h4>
  158. <div class="informaltable"><table class="informaltable" width="100%" border="0">
  159. <colgroup>
  160. <col width="150px" class="parameters_name">
  161. <col class="parameters_description">
  162. <col width="200px" class="parameters_annotations">
  163. </colgroup>
  164. <tbody><tr>
  165. <td class="parameter_name"><p>preeditable</p></td>
  166. <td class="parameter_description"><p>a <a class="link" href="NimfPreeditable.html" title="NimfPreeditable"><span class="type">NimfPreeditable</span></a></p></td>
  167. <td class="parameter_annotations"> </td>
  168. </tr></tbody>
  169. </table></div>
  170. </div>
  171. </div>
  172. <hr>
  173. <div class="refsect2">
  174. <a name="nimf-preeditable-is-visible"></a><h3>nimf_preeditable_is_visible ()</h3>
  175. <pre class="programlisting"><span class="returnvalue">gboolean</span>
  176. nimf_preeditable_is_visible (<em class="parameter"><code><a class="link" href="NimfPreeditable.html" title="NimfPreeditable"><span class="type">NimfPreeditable</span></a> *preeditable</code></em>);</pre>
  177. <div class="refsect3">
  178. <a name="nimf-preeditable-is-visible.parameters"></a><h4>Parameters</h4>
  179. <div class="informaltable"><table class="informaltable" width="100%" border="0">
  180. <colgroup>
  181. <col width="150px" class="parameters_name">
  182. <col class="parameters_description">
  183. <col width="200px" class="parameters_annotations">
  184. </colgroup>
  185. <tbody><tr>
  186. <td class="parameter_name"><p>preeditable</p></td>
  187. <td class="parameter_description"><p>a <a class="link" href="NimfPreeditable.html" title="NimfPreeditable"><span class="type">NimfPreeditable</span></a></p></td>
  188. <td class="parameter_annotations"> </td>
  189. </tr></tbody>
  190. </table></div>
  191. </div>
  192. <div class="refsect3">
  193. <a name="nimf-preeditable-is-visible.returns"></a><h4>Returns</h4>
  194. <p> <code class="literal">TRUE</code> if the <em class="parameter"><code>preeditable</code></em>
  195. is visible</p>
  196. </div>
  197. </div>
  198. <hr>
  199. <div class="refsect2">
  200. <a name="nimf-preeditable-set-text"></a><h3>nimf_preeditable_set_text ()</h3>
  201. <pre class="programlisting"><span class="returnvalue">void</span>
  202. nimf_preeditable_set_text (<em class="parameter"><code><a class="link" href="NimfPreeditable.html" title="NimfPreeditable"><span class="type">NimfPreeditable</span></a> *preeditable</code></em>,
  203. <em class="parameter"><code>const <span class="type">gchar</span> *text</code></em>,
  204. <em class="parameter"><code><span class="type">gint</span> cursor_pos</code></em>);</pre>
  205. <p>Sets <em class="parameter"><code>text</code></em>
  206. to <em class="parameter"><code>preeditable</code></em>
  207. .</p>
  208. <div class="refsect3">
  209. <a name="nimf-preeditable-set-text.parameters"></a><h4>Parameters</h4>
  210. <div class="informaltable"><table class="informaltable" width="100%" border="0">
  211. <colgroup>
  212. <col width="150px" class="parameters_name">
  213. <col class="parameters_description">
  214. <col width="200px" class="parameters_annotations">
  215. </colgroup>
  216. <tbody>
  217. <tr>
  218. <td class="parameter_name"><p>preeditable</p></td>
  219. <td class="parameter_description"><p>a <a class="link" href="NimfPreeditable.html" title="NimfPreeditable"><span class="type">NimfPreeditable</span></a></p></td>
  220. <td class="parameter_annotations"> </td>
  221. </tr>
  222. <tr>
  223. <td class="parameter_name"><p>text</p></td>
  224. <td class="parameter_description"><p>text</p></td>
  225. <td class="parameter_annotations"> </td>
  226. </tr>
  227. <tr>
  228. <td class="parameter_name"><p>cursor_pos</p></td>
  229. <td class="parameter_description"><p>cursor position</p></td>
  230. <td class="parameter_annotations"> </td>
  231. </tr>
  232. </tbody>
  233. </table></div>
  234. </div>
  235. </div>
  236. <hr>
  237. <div class="refsect2">
  238. <a name="nimf-preeditable-set-cursor-location"></a><h3>nimf_preeditable_set_cursor_location ()</h3>
  239. <pre class="programlisting"><span class="returnvalue">void</span>
  240. nimf_preeditable_set_cursor_location (<em class="parameter"><code><a class="link" href="NimfPreeditable.html" title="NimfPreeditable"><span class="type">NimfPreeditable</span></a> *preeditable</code></em>,
  241. <em class="parameter"><code>const <a class="link" href="nimf-types.html#NimfRectangle" title="NimfRectangle"><span class="type">NimfRectangle</span></a> *area</code></em>);</pre>
  242. <p>Notifies the <em class="parameter"><code>preeditable</code></em>
  243. that a change in cursor position has been made.
  244. The location is the position of a window position in root window coordinates.</p>
  245. <div class="refsect3">
  246. <a name="nimf-preeditable-set-cursor-location.parameters"></a><h4>Parameters</h4>
  247. <div class="informaltable"><table class="informaltable" width="100%" border="0">
  248. <colgroup>
  249. <col width="150px" class="parameters_name">
  250. <col class="parameters_description">
  251. <col width="200px" class="parameters_annotations">
  252. </colgroup>
  253. <tbody>
  254. <tr>
  255. <td class="parameter_name"><p>preeditable</p></td>
  256. <td class="parameter_description"><p>a <a class="link" href="NimfPreeditable.html" title="NimfPreeditable"><span class="type">NimfPreeditable</span></a></p></td>
  257. <td class="parameter_annotations"> </td>
  258. </tr>
  259. <tr>
  260. <td class="parameter_name"><p>area</p></td>
  261. <td class="parameter_description"><p>a <a class="link" href="nimf-types.html#NimfRectangle" title="NimfRectangle"><span class="type">NimfRectangle</span></a></p></td>
  262. <td class="parameter_annotations"> </td>
  263. </tr>
  264. </tbody>
  265. </table></div>
  266. </div>
  267. </div>
  268. </div>
  269. <div class="refsect1">
  270. <a name="NimfPreeditable.other_details"></a><h2>Types and Values</h2>
  271. <div class="refsect2">
  272. <a name="NIMF-TYPE-PREEDITABLE:CAPS"></a><h3>NIMF_TYPE_PREEDITABLE</h3>
  273. <pre class="programlisting">#define NIMF_TYPE_PREEDITABLE nimf_preeditable_get_type ()
  274. </pre>
  275. </div>
  276. <hr>
  277. <div class="refsect2">
  278. <a name="NimfPreeditableInterface"></a><h3>struct NimfPreeditableInterface</h3>
  279. <pre class="programlisting">struct NimfPreeditableInterface {
  280. GTypeInterface parent;
  281. void (* show) (NimfPreeditable *preeditable);
  282. void (* hide) (NimfPreeditable *preeditable);
  283. gboolean (* is_visible) (NimfPreeditable *preeditable);
  284. void (* set_text) (NimfPreeditable *preeditable,
  285. const gchar *text,
  286. gint cursor_pos);
  287. void (* set_cursor_location) (NimfPreeditable *preeditable,
  288. const NimfRectangle *area);
  289. };
  290. </pre>
  291. <p>Provides an interface for preedit gadget.</p>
  292. <div class="refsect3">
  293. <a name="NimfPreeditableInterface.members"></a><h4>Members</h4>
  294. <div class="informaltable"><table class="informaltable" width="100%" border="0">
  295. <colgroup>
  296. <col width="300px" class="struct_members_name">
  297. <col class="struct_members_description">
  298. <col width="200px" class="struct_members_annotations">
  299. </colgroup>
  300. <tbody>
  301. <tr>
  302. <td class="struct_member_name"><p><span class="type">GTypeInterface</span> <em class="structfield"><code><a name="NimfPreeditableInterface.parent"></a>parent</code></em>;</p></td>
  303. <td class="struct_member_description"><p>The parent interface.</p></td>
  304. <td class="struct_member_annotations"> </td>
  305. </tr>
  306. <tr>
  307. <td class="struct_member_name"><p><em class="structfield"><code><a name="NimfPreeditableInterface.show"></a>show</code></em> ()</p></td>
  308. <td class="struct_member_description"><p>Shows the preeditable.</p></td>
  309. <td class="struct_member_annotations"> </td>
  310. </tr>
  311. <tr>
  312. <td class="struct_member_name"><p><em class="structfield"><code><a name="NimfPreeditableInterface.hide"></a>hide</code></em> ()</p></td>
  313. <td class="struct_member_description"><p>Hides the preeditable.</p></td>
  314. <td class="struct_member_annotations"> </td>
  315. </tr>
  316. <tr>
  317. <td class="struct_member_name"><p><em class="structfield"><code><a name="NimfPreeditableInterface.is-visible"></a>is_visible</code></em> ()</p></td>
  318. <td class="struct_member_description"><p>Checks if the preeditable is visible.</p></td>
  319. <td class="struct_member_annotations"> </td>
  320. </tr>
  321. <tr>
  322. <td class="struct_member_name"><p><em class="structfield"><code><a name="NimfPreeditableInterface.set-text"></a>set_text</code></em> ()</p></td>
  323. <td class="struct_member_description"><p>Sets the text in the preeditable to the given value, replacing
  324. the current contents.</p></td>
  325. <td class="struct_member_annotations"> </td>
  326. </tr>
  327. <tr>
  328. <td class="struct_member_name"><p><em class="structfield"><code><a name="NimfPreeditableInterface.set-cursor-location"></a>set_cursor_location</code></em> ()</p></td>
  329. <td class="struct_member_description"><p>Sets the cursor position.</p></td>
  330. <td class="struct_member_annotations"> </td>
  331. </tr>
  332. </tbody>
  333. </table></div>
  334. </div>
  335. </div>
  336. <hr>
  337. <div class="refsect2">
  338. <a name="NimfPreeditable-struct"></a><h3>NimfPreeditable</h3>
  339. <pre class="programlisting">typedef struct _NimfPreeditable NimfPreeditable;</pre>
  340. </div>
  341. </div>
  342. </div>
  343. <div class="footer">
  344. <hr>Generated by GTK-Doc V1.34.0</div>
  345. </body>
  346. </html>