<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.13"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>libxkbcommon: xkb_rule_names Struct Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> <link href="doxygen-extra.css" rel="stylesheet" type="text/css"/> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">libxkbcommon  <span id="projectnumber">0.8.2</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.13 --> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> $(function() { initMenu('',false,false,'search.php','Search'); }); </script> <div id="main-nav"></div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-attribs">Data Fields</a> </div> <div class="headertitle"> <div class="title">xkb_rule_names Struct Reference</div> </div> </div><!--header--> <div class="contents"> <p><code>#include <xkbcommon.h></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a> Data Fields</h2></td></tr> <tr class="memitem:a0968f4602001f2306febd32c34bd2280"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structxkb__rule__names.html#a0968f4602001f2306febd32c34bd2280">rules</a></td></tr> <tr class="separator:a0968f4602001f2306febd32c34bd2280"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a1c897b49b49c7cd495db4a424bd27265"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structxkb__rule__names.html#a1c897b49b49c7cd495db4a424bd27265">model</a></td></tr> <tr class="separator:a1c897b49b49c7cd495db4a424bd27265"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a243bb3aa36b4ea9ca402ed330a757746"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structxkb__rule__names.html#a243bb3aa36b4ea9ca402ed330a757746">layout</a></td></tr> <tr class="separator:a243bb3aa36b4ea9ca402ed330a757746"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a758e1865c002d8f4fb59b2e3dda83b66"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structxkb__rule__names.html#a758e1865c002d8f4fb59b2e3dda83b66">variant</a></td></tr> <tr class="separator:a758e1865c002d8f4fb59b2e3dda83b66"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a556899eafb333c440be64ede408644df"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="structxkb__rule__names.html#a556899eafb333c440be64ede408644df">options</a></td></tr> <tr class="separator:a556899eafb333c440be64ede408644df"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Names to compile a keymap with, also known as RMLVO. </p> <p>The names are the common configuration values by which a user picks a keymap.</p> <p>If the entire struct is NULL, then each field is taken to be NULL. You should prefer passing NULL instead of choosing your own defaults. </p> </div><h2 class="groupheader">Field Documentation</h2> <a id="a0968f4602001f2306febd32c34bd2280"></a> <h2 class="memtitle"><span class="permalink"><a href="#a0968f4602001f2306febd32c34bd2280">◆ </a></span>rules</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* xkb_rule_names::rules</td> </tr> </table> </div><div class="memdoc"> <p>The rules file to use. </p> <p>The rules file describes how to interpret the values of the model, layout, variant and options fields.</p> <p>If NULL or the empty string "", a default value is used. If the XKB_DEFAULT_RULES environment variable is set, it is used as the default. Otherwise the system default is used. </p> </div> </div> <a id="a1c897b49b49c7cd495db4a424bd27265"></a> <h2 class="memtitle"><span class="permalink"><a href="#a1c897b49b49c7cd495db4a424bd27265">◆ </a></span>model</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* xkb_rule_names::model</td> </tr> </table> </div><div class="memdoc"> <p>The keyboard model by which to interpret keycodes and LEDs. </p> <p>If NULL or the empty string "", a default value is used. If the XKB_DEFAULT_MODEL environment variable is set, it is used as the default. Otherwise the system default is used. </p> </div> </div> <a id="a243bb3aa36b4ea9ca402ed330a757746"></a> <h2 class="memtitle"><span class="permalink"><a href="#a243bb3aa36b4ea9ca402ed330a757746">◆ </a></span>layout</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* xkb_rule_names::layout</td> </tr> </table> </div><div class="memdoc"> <p>A comma separated list of layouts (languages) to include in the keymap. </p> <p>If NULL or the empty string "", a default value is used. If the XKB_DEFAULT_LAYOUT environment variable is set, it is used as the default. Otherwise the system default is used. </p> </div> </div> <a id="a758e1865c002d8f4fb59b2e3dda83b66"></a> <h2 class="memtitle"><span class="permalink"><a href="#a758e1865c002d8f4fb59b2e3dda83b66">◆ </a></span>variant</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* xkb_rule_names::variant</td> </tr> </table> </div><div class="memdoc"> <p>A comma separated list of variants, one per layout, which may modify or augment the respective layout in various ways. </p> <p>If NULL or the empty string "", and a default value is also used for the layout, a default value is used. Otherwise no variant is used. If the XKB_DEFAULT_VARIANT environment variable is set, it is used as the default. Otherwise the system default is used. </p> </div> </div> <a id="a556899eafb333c440be64ede408644df"></a> <h2 class="memtitle"><span class="permalink"><a href="#a556899eafb333c440be64ede408644df">◆ </a></span>options</h2> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const char* xkb_rule_names::options</td> </tr> </table> </div><div class="memdoc"> <p>A comma separated list of options, through which the user specifies non-layout related preferences, like which key combinations are used for switching layouts, or which key is the Compose key. </p> <p>If NULL, a default value is used. If the empty string "", no options are used. If the XKB_DEFAULT_OPTIONS environment variable is set, it is used as the default. Otherwise the system default is used. </p> </div> </div> <hr/>The documentation for this struct was generated from the following file:<ul> <li>xkbcommon/<a class="el" href="xkbcommon_8h.html">xkbcommon.h</a></li> </ul> </div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.13 </small></address> </body> </html>