docs/reference/libkeymap/html/charset_8h.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.15"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>libkeymap: src/libkeymap/keymap/charset.h File Reference</title>
   9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  13 </head>
  14 <body>
  15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16 <div id="titlearea">
  17 <table cellspacing="0" cellpadding="0">
  18  <tbody>
  19  <tr style="height: 56px;">
  20   <td id="projectalign" style="padding-left: 0.5em;">
  21    <div id="projectname">libkeymap
  22    &#160;<span id="projectnumber">2.0.4</span>
  23    </div>
  24    <div id="projectbrief">Library to manage the Linux keymaps</div>
  25   </td>
  26  </tr>
  27  </tbody>
  28 </table>
  29 </div>
  30 <!-- end header part -->
  31 <!-- Generated by Doxygen 1.8.15 -->
  32 <script type="text/javascript" src="menudata.js"></script>
  33 <script type="text/javascript" src="menu.js"></script>
  34 <script type="text/javascript">
  35 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36 $(function() {
  37   initMenu('',false,false,'search.php','Search');
  38 });
  39 /* @license-end */</script>
  40 <div id="main-nav"></div>
  41 <div id="nav-path" class="navpath">
  42   <ul>
  43 <li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_5ba4a5643591dc5dc7d346d490557182.html">libkeymap</a></li><li class="navelem"><a class="el" href="dir_62c7a06ab6d0517e94baecab48e4799d.html">keymap</a></li>  </ul>
  44 </div>
  45 </div><!-- top -->
  46 <div class="header">
  47   <div class="summary">
  48 <a href="#func-members">Functions</a>  </div>
  49   <div class="headertitle">
  50 <div class="title">charset.h File Reference</div>  </div>
  51 </div><!--header-->
  52 <div class="contents">
  53
  54 <p>Functions for charset manipulation.
  55 <a href="#details">More...</a></p>
  56 <div class="textblock"><code>#include &lt;<a class="el" href="context_8h_source.html">keymap/context.h</a>&gt;</code><br />
  57 </div>
  58 <p><a href="charset_8h_source.html">Go to the source code of this file.</a></p>
  59 <table class="memberdecls">
  60 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  61 Functions</h2></td></tr>
  62 <tr class="memitem:acd2751c550f08feab993a46176bab74a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="charset_8h.html#acd2751c550f08feab993a46176bab74a">lk_list_charsets</a> (FILE *fp)</td></tr>
  63 <tr class="separator:acd2751c550f08feab993a46176bab74a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64 <tr class="memitem:a41ff58cbd68c7b6b7bb446da649f55b8"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="charset_8h.html#a41ff58cbd68c7b6b7bb446da649f55b8">lk_get_charset</a> (struct lk_ctx *ctx)</td></tr>
  65 <tr class="separator:a41ff58cbd68c7b6b7bb446da649f55b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66 <tr class="memitem:a4c1ae32a30d10d91cd55478dfc261021"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="charset_8h.html#a4c1ae32a30d10d91cd55478dfc261021">lk_set_charset</a> (struct lk_ctx *ctx, const char *name)</td></tr>
  67 <tr class="separator:a4c1ae32a30d10d91cd55478dfc261021"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68 </table>
  69 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  70 <div class="textblock"><p>Functions for charset manipulation. </p>
  71 </div><h2 class="groupheader">Function Documentation</h2>
  72 <a id="acd2751c550f08feab993a46176bab74a"></a>
  73 <h2 class="memtitle"><span class="permalink"><a href="#acd2751c550f08feab993a46176bab74a">&#9670;&nbsp;</a></span>lk_list_charsets()</h2>
  74
  75 <div class="memitem">
  76 <div class="memproto">
  77       <table class="memname">
  78         <tr>
  79           <td class="memname">void lk_list_charsets </td>
  80           <td>(</td>
  81           <td class="paramtype">FILE *&#160;</td>
  82           <td class="paramname"><em>fp</em></td><td>)</td>
  83           <td></td>
  84         </tr>
  85       </table>
  86 </div><div class="memdoc">
  87 <p>Prints into the FILE a list of supported charsets. </p><dl class="params"><dt>Parameters</dt><dd>
  88   <table class="params">
  89     <tr><td class="paramname">fp</td><td>is a stream.</td></tr>
  90   </table>
  91   </dd>
  92 </dl>
  93 <dl class="section return"><dt>Returns</dt><dd>nothing. </dd></dl>
  94
  95 </div>
  96 </div>
  97 <a id="a41ff58cbd68c7b6b7bb446da649f55b8"></a>
  98 <h2 class="memtitle"><span class="permalink"><a href="#a41ff58cbd68c7b6b7bb446da649f55b8">&#9670;&nbsp;</a></span>lk_get_charset()</h2>
  99
 100 <div class="memitem">
 101 <div class="memproto">
 102       <table class="memname">
 103         <tr>
 104           <td class="memname">const char* lk_get_charset </td>
 105           <td>(</td>
 106           <td class="paramtype">struct lk_ctx *&#160;</td>
 107           <td class="paramname"><em>ctx</em></td><td>)</td>
 108           <td></td>
 109         </tr>
 110       </table>
 111 </div><div class="memdoc">
 112 <p>Returns the current name of the charset used by the library. </p><dl class="params"><dt>Parameters</dt><dd>
 113   <table class="params">
 114     <tr><td class="paramname">ctx</td><td>is a keymap library context.</td></tr>
 115   </table>
 116   </dd>
 117 </dl>
 118 <dl class="section return"><dt>Returns</dt><dd>pointer to null-terminated string (Do not pass this pointer to free(3)). </dd></dl>
 119
 120 </div>
 121 </div>
 122 <a id="a4c1ae32a30d10d91cd55478dfc261021"></a>
 123 <h2 class="memtitle"><span class="permalink"><a href="#a4c1ae32a30d10d91cd55478dfc261021">&#9670;&nbsp;</a></span>lk_set_charset()</h2>
 124
 125 <div class="memitem">
 126 <div class="memproto">
 127       <table class="memname">
 128         <tr>
 129           <td class="memname">int lk_set_charset </td>
 130           <td>(</td>
 131           <td class="paramtype">struct lk_ctx *&#160;</td>
 132           <td class="paramname"><em>ctx</em>, </td>
 133         </tr>
 134         <tr>
 135           <td class="paramkey"></td>
 136           <td></td>
 137           <td class="paramtype">const char *&#160;</td>
 138           <td class="paramname"><em>name</em>&#160;</td>
 139         </tr>
 140         <tr>
 141           <td></td>
 142           <td>)</td>
 143           <td></td><td></td>
 144         </tr>
 145       </table>
 146 </div><div class="memdoc">
 147 <p>Sets the charset which will be used by the library. </p><dl class="params"><dt>Parameters</dt><dd>
 148   <table class="params">
 149     <tr><td class="paramname">ctx</td><td>is a keymap library context. </td></tr>
 150     <tr><td class="paramname">name</td><td>is a name of charset.</td></tr>
 151   </table>
 152   </dd>
 153 </dl>
 154 <dl class="section return"><dt>Returns</dt><dd>zero if the charset was found and successfully changed. On error, 1 is returned. </dd></dl>
 155
 156 </div>
 157 </div>
 158 </div><!-- contents -->
 159 <!-- start footer part -->
 160 <hr class="footer"/><address class="footer"><small>
 161 Generated on Wed Jun 26 2019 11:29:12 for libkeymap by &#160;<a href="http://www.doxygen.org/index.html">
 162 <img class="footer" src="doxygen.png" alt="doxygen"/>
 163 </a> 1.8.15
 164 </small></address>
 165 </body>
 166 </html>