nimf-utils.html 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104
  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>Utility Functions: 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="libnimf-api.html" title="Part I. libnimf API">
  9. <link rel="prev" href="NimfServer.html" title="NimfServer">
  10. <link rel="next" href="interfaces.html" title="Interfaces">
  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="#nimf-utils.description" class="shortcut">Description</a></span>
  19. </td>
  20. <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
  21. <td><a accesskey="u" href="libnimf-api.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
  22. <td><a accesskey="p" href="NimfServer.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
  23. <td><a accesskey="n" href="interfaces.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
  24. </tr></table>
  25. <div class="refentry">
  26. <a name="nimf-utils"></a><div class="titlepage"></div>
  27. <div class="refnamediv"><table width="100%"><tr>
  28. <td valign="top">
  29. <h2><span class="refentrytitle"><a name="nimf-utils.top_of_page"></a>Utility Functions</span></h2>
  30. <p>Utility Functions</p>
  31. </td>
  32. <td class="gallery_image" valign="top" align="right"></td>
  33. </tr></table></div>
  34. <div class="refsect1">
  35. <a name="nimf-utils.functions"></a><h2>Functions</h2>
  36. <div class="informaltable"><table class="informaltable" width="100%" border="0">
  37. <colgroup>
  38. <col width="150px" class="functions_proto_type">
  39. <col class="functions_proto_name">
  40. </colgroup>
  41. <tbody>
  42. <tr>
  43. <td class="function_type">const <span class="returnvalue">gchar</span> *
  44. </td>
  45. <td class="function_name">
  46. <a class="link" href="nimf-utils.html#nimf-keyval-to-keysym-name" title="nimf_keyval_to_keysym_name ()">nimf_keyval_to_keysym_name</a> <span class="c_punctuation">()</span>
  47. </td>
  48. </tr>
  49. <tr>
  50. <td class="function_type">
  51. <span class="returnvalue">gchar</span> *
  52. </td>
  53. <td class="function_name">
  54. <a class="link" href="nimf-utils.html#nimf-get-socket-path" title="nimf_get_socket_path ()">nimf_get_socket_path</a> <span class="c_punctuation">()</span>
  55. </td>
  56. </tr>
  57. </tbody>
  58. </table></div>
  59. </div>
  60. <div class="refsect1">
  61. <a name="nimf-utils.description"></a><h2>Description</h2>
  62. </div>
  63. <div class="refsect1">
  64. <a name="nimf-utils.functions_details"></a><h2>Functions</h2>
  65. <div class="refsect2">
  66. <a name="nimf-keyval-to-keysym-name"></a><h3>nimf_keyval_to_keysym_name ()</h3>
  67. <pre class="programlisting">const <span class="returnvalue">gchar</span> *
  68. nimf_keyval_to_keysym_name (<em class="parameter"><code><span class="type">guint</span> keyval</code></em>);</pre>
  69. <div class="refsect3">
  70. <a name="nimf-keyval-to-keysym-name.parameters"></a><h4>Parameters</h4>
  71. <div class="informaltable"><table class="informaltable" width="100%" border="0">
  72. <colgroup>
  73. <col width="150px" class="parameters_name">
  74. <col class="parameters_description">
  75. <col width="200px" class="parameters_annotations">
  76. </colgroup>
  77. <tbody><tr>
  78. <td class="parameter_name"><p>keyval</p></td>
  79. <td class="parameter_description"><p>a keyval</p></td>
  80. <td class="parameter_annotations"> </td>
  81. </tr></tbody>
  82. </table></div>
  83. </div>
  84. <div class="refsect3">
  85. <a name="nimf-keyval-to-keysym-name.returns"></a><h4>Returns</h4>
  86. <p> keysym name</p>
  87. </div>
  88. </div>
  89. <hr>
  90. <div class="refsect2">
  91. <a name="nimf-get-socket-path"></a><h3>nimf_get_socket_path ()</h3>
  92. <pre class="programlisting"><span class="returnvalue">gchar</span> *
  93. nimf_get_socket_path (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
  94. <div class="refsect3">
  95. <a name="nimf-get-socket-path.returns"></a><h4>Returns</h4>
  96. <p> nimf socket path, which should be freed with <code class="function">g_free()</code></p>
  97. </div>
  98. </div>
  99. </div>
  100. </div>
  101. <div class="footer">
  102. <hr>Generated by GTK-Doc V1.34.0</div>
  103. </body>
  104. </html>