<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.15"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>libxkbcommon: xkb_keymap 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.4</span> </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.15 --> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',false,false,'search.php','Search'); }); /* @license-end */</script> <div id="main-nav"></div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-types">Public Types</a> | <a href="#pub-methods">Public Member Functions</a> </div> <div class="headertitle"> <div class="title">xkb_keymap 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-types"></a> Public Types</h2></td></tr> <tr class="memitem:ga40242f70d6c403bfe833dbd61d3b42ae"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__components.html#ga40242f70d6c403bfe833dbd61d3b42ae">xkb_keymap_key_iter_t</a>) (struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> *keymap, <a class="el" href="xkbcommon_8h.html#ac29aee92124c08d1953910ab28ee1997">xkb_keycode_t</a> key, void *data)</td></tr> <tr class="separator:ga40242f70d6c403bfe833dbd61d3b42ae"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:ga502717aa7148fd17d4970896f1e9e06f"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__keymap.html#ga502717aa7148fd17d4970896f1e9e06f">xkb_keymap_new_from_names</a> (struct <a class="el" href="structxkb__context.html">xkb_context</a> *context, const struct <a class="el" href="structxkb__rule__names.html">xkb_rule_names</a> *names, enum <a class="el" href="group__keymap.html#gad418fa5861e00b37c362075a380299b2">xkb_keymap_compile_flags</a> flags)</td></tr> <tr class="separator:ga502717aa7148fd17d4970896f1e9e06f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga0cb0badfbe35a571d3b6b4491294fa11"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__keymap.html#ga0cb0badfbe35a571d3b6b4491294fa11">xkb_keymap_new_from_file</a> (struct <a class="el" href="structxkb__context.html">xkb_context</a> *context, FILE *file, enum <a class="el" href="group__keymap.html#gab0f75d6cc5773e5dd404e2c3f61366a3">xkb_keymap_format</a> format, enum <a class="el" href="group__keymap.html#gad418fa5861e00b37c362075a380299b2">xkb_keymap_compile_flags</a> flags)</td></tr> <tr class="separator:ga0cb0badfbe35a571d3b6b4491294fa11"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga9d98e2e1348bd756bd3229d0b9432886"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__keymap.html#ga9d98e2e1348bd756bd3229d0b9432886">xkb_keymap_new_from_string</a> (struct <a class="el" href="structxkb__context.html">xkb_context</a> *context, const char *string, enum <a class="el" href="group__keymap.html#gab0f75d6cc5773e5dd404e2c3f61366a3">xkb_keymap_format</a> format, enum <a class="el" href="group__keymap.html#gad418fa5861e00b37c362075a380299b2">xkb_keymap_compile_flags</a> flags)</td></tr> <tr class="separator:ga9d98e2e1348bd756bd3229d0b9432886"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga19e1a8824c7c51bf5ac8a8cb8b7d40d2"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__keymap.html#ga19e1a8824c7c51bf5ac8a8cb8b7d40d2">xkb_keymap_new_from_buffer</a> (struct <a class="el" href="structxkb__context.html">xkb_context</a> *context, const char *buffer, size_t length, enum <a class="el" href="group__keymap.html#gab0f75d6cc5773e5dd404e2c3f61366a3">xkb_keymap_format</a> format, enum <a class="el" href="group__keymap.html#gad418fa5861e00b37c362075a380299b2">xkb_keymap_compile_flags</a> flags)</td></tr> <tr class="separator:ga19e1a8824c7c51bf5ac8a8cb8b7d40d2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga2b04dbdf580d9082b45c44381ae5fed0"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__keymap.html#ga2b04dbdf580d9082b45c44381ae5fed0">xkb_keymap_ref</a> (struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> *keymap)</td></tr> <tr class="separator:ga2b04dbdf580d9082b45c44381ae5fed0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gafb6b3d3fce63eb6dde6c1de0850fcf41"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__keymap.html#gafb6b3d3fce63eb6dde6c1de0850fcf41">xkb_keymap_unref</a> (struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> *keymap)</td></tr> <tr class="separator:gafb6b3d3fce63eb6dde6c1de0850fcf41"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gab4430b8b2f125b81e6200c39dbd097ea"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__keymap.html#gab4430b8b2f125b81e6200c39dbd097ea">xkb_keymap_get_as_string</a> (struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> *keymap, enum <a class="el" href="group__keymap.html#gab0f75d6cc5773e5dd404e2c3f61366a3">xkb_keymap_format</a> format)</td></tr> <tr class="separator:gab4430b8b2f125b81e6200c39dbd097ea"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga331a902b6b73defba931115e684b4180"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xkbcommon_8h.html#ac29aee92124c08d1953910ab28ee1997">xkb_keycode_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__components.html#ga331a902b6b73defba931115e684b4180">xkb_keymap_min_keycode</a> (struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> *keymap)</td></tr> <tr class="separator:ga331a902b6b73defba931115e684b4180"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gac392e896cf542740dd6e614d2956a33b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xkbcommon_8h.html#ac29aee92124c08d1953910ab28ee1997">xkb_keycode_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__components.html#gac392e896cf542740dd6e614d2956a33b">xkb_keymap_max_keycode</a> (struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> *keymap)</td></tr> <tr class="separator:gac392e896cf542740dd6e614d2956a33b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaa6d6a6d4aaf70ca0aa798e491d5616d8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__components.html#gaa6d6a6d4aaf70ca0aa798e491d5616d8">xkb_keymap_key_for_each</a> (struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> *keymap, <a class="el" href="group__components.html#ga40242f70d6c403bfe833dbd61d3b42ae">xkb_keymap_key_iter_t</a> iter, void *data)</td></tr> <tr class="separator:gaa6d6a6d4aaf70ca0aa798e491d5616d8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga78e5410990705a08f768c0febdb703f2"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__components.html#ga78e5410990705a08f768c0febdb703f2">xkb_keymap_key_get_name</a> (struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> *keymap, <a class="el" href="xkbcommon_8h.html#ac29aee92124c08d1953910ab28ee1997">xkb_keycode_t</a> key)</td></tr> <tr class="separator:ga78e5410990705a08f768c0febdb703f2"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga433915398b2bc6895822dec9b463dddf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xkbcommon_8h.html#ac29aee92124c08d1953910ab28ee1997">xkb_keycode_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__components.html#ga433915398b2bc6895822dec9b463dddf">xkb_keymap_key_by_name</a> (struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> *keymap, const char *name)</td></tr> <tr class="separator:ga433915398b2bc6895822dec9b463dddf"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gaa7fe37876dfca94b6922cbb90ca36864"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xkbcommon_8h.html#a638bf7a52db06f383ce5a4ef99dfe539">xkb_mod_index_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__components.html#gaa7fe37876dfca94b6922cbb90ca36864">xkb_keymap_num_mods</a> (struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> *keymap)</td></tr> <tr class="separator:gaa7fe37876dfca94b6922cbb90ca36864"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga50872d5d2afc75c942ff93c470822965"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__components.html#ga50872d5d2afc75c942ff93c470822965">xkb_keymap_mod_get_name</a> (struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> *keymap, <a class="el" href="xkbcommon_8h.html#a638bf7a52db06f383ce5a4ef99dfe539">xkb_mod_index_t</a> idx)</td></tr> <tr class="separator:ga50872d5d2afc75c942ff93c470822965"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga0a0c7dd365962663bc1eaa6f02b9a812"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xkbcommon_8h.html#a638bf7a52db06f383ce5a4ef99dfe539">xkb_mod_index_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__components.html#ga0a0c7dd365962663bc1eaa6f02b9a812">xkb_keymap_mod_get_index</a> (struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> *keymap, const char *name)</td></tr> <tr class="separator:ga0a0c7dd365962663bc1eaa6f02b9a812"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gadb8f3c82d8d1c3bcd8acbe0b378b4c82"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xkbcommon_8h.html#ad37512642806c55955e1cd5a30efcc39">xkb_layout_index_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__components.html#gadb8f3c82d8d1c3bcd8acbe0b378b4c82">xkb_keymap_num_layouts</a> (struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> *keymap)</td></tr> <tr class="separator:gadb8f3c82d8d1c3bcd8acbe0b378b4c82"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga63b85a1431caed99af85e19ff50131f6"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__components.html#ga63b85a1431caed99af85e19ff50131f6">xkb_keymap_layout_get_name</a> (struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> *keymap, <a class="el" href="xkbcommon_8h.html#ad37512642806c55955e1cd5a30efcc39">xkb_layout_index_t</a> idx)</td></tr> <tr class="separator:ga63b85a1431caed99af85e19ff50131f6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga9e4e54af1db83e5871c64a639c94358d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xkbcommon_8h.html#ad37512642806c55955e1cd5a30efcc39">xkb_layout_index_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__components.html#ga9e4e54af1db83e5871c64a639c94358d">xkb_keymap_layout_get_index</a> (struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> *keymap, const char *name)</td></tr> <tr class="separator:ga9e4e54af1db83e5871c64a639c94358d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga8ee40041d8bca197c7f207ab87f9017d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xkbcommon_8h.html#af6e951bdbcba8fb7e2532a8ebc6c9c87">xkb_led_index_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__components.html#ga8ee40041d8bca197c7f207ab87f9017d">xkb_keymap_num_leds</a> (struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> *keymap)</td></tr> <tr class="separator:ga8ee40041d8bca197c7f207ab87f9017d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga68b343be93dab76aed47699346f4225e"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__components.html#ga68b343be93dab76aed47699346f4225e">xkb_keymap_led_get_name</a> (struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> *keymap, <a class="el" href="xkbcommon_8h.html#af6e951bdbcba8fb7e2532a8ebc6c9c87">xkb_led_index_t</a> idx)</td></tr> <tr class="separator:ga68b343be93dab76aed47699346f4225e"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gae7f970e4ba807657c3cc214fc13c998d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xkbcommon_8h.html#af6e951bdbcba8fb7e2532a8ebc6c9c87">xkb_led_index_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__components.html#gae7f970e4ba807657c3cc214fc13c998d">xkb_keymap_led_get_index</a> (struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> *keymap, const char *name)</td></tr> <tr class="separator:gae7f970e4ba807657c3cc214fc13c998d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gad5d59aef2778a33387ffdaf8f992b689"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xkbcommon_8h.html#ad37512642806c55955e1cd5a30efcc39">xkb_layout_index_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__components.html#gad5d59aef2778a33387ffdaf8f992b689">xkb_keymap_num_layouts_for_key</a> (struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> *keymap, <a class="el" href="xkbcommon_8h.html#ac29aee92124c08d1953910ab28ee1997">xkb_keycode_t</a> key)</td></tr> <tr class="separator:gad5d59aef2778a33387ffdaf8f992b689"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gafc5aa736f1eb86a5377b98a03fb6d690"><td class="memItemLeft" align="right" valign="top"><a class="el" href="xkbcommon_8h.html#a7eb38bea2a311b6ff033816278d5bbea">xkb_level_index_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__components.html#gafc5aa736f1eb86a5377b98a03fb6d690">xkb_keymap_num_levels_for_key</a> (struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> *keymap, <a class="el" href="xkbcommon_8h.html#ac29aee92124c08d1953910ab28ee1997">xkb_keycode_t</a> key, <a class="el" href="xkbcommon_8h.html#ad37512642806c55955e1cd5a30efcc39">xkb_layout_index_t</a> layout)</td></tr> <tr class="separator:gafc5aa736f1eb86a5377b98a03fb6d690"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gad92b9334170316926595fbb5d634a181"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__components.html#gad92b9334170316926595fbb5d634a181">xkb_keymap_key_get_syms_by_level</a> (struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> *keymap, <a class="el" href="xkbcommon_8h.html#ac29aee92124c08d1953910ab28ee1997">xkb_keycode_t</a> key, <a class="el" href="xkbcommon_8h.html#ad37512642806c55955e1cd5a30efcc39">xkb_layout_index_t</a> layout, <a class="el" href="xkbcommon_8h.html#a7eb38bea2a311b6ff033816278d5bbea">xkb_level_index_t</a> level, const <a class="el" href="xkbcommon_8h.html#a79e604a22703391bdfe212cfc10ea007">xkb_keysym_t</a> **syms_out)</td></tr> <tr class="separator:gad92b9334170316926595fbb5d634a181"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga9d7f998efeca98b3afc7c257bbac90a8"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__components.html#ga9d7f998efeca98b3afc7c257bbac90a8">xkb_keymap_key_repeats</a> (struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> *keymap, <a class="el" href="xkbcommon_8h.html#ac29aee92124c08d1953910ab28ee1997">xkb_keycode_t</a> key)</td></tr> <tr class="separator:ga9d7f998efeca98b3afc7c257bbac90a8"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga9ccc80dcb7488167c8466cb833286559"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__x11.html#ga9ccc80dcb7488167c8466cb833286559">xkb_x11_keymap_new_from_device</a> (struct <a class="el" href="structxkb__context.html">xkb_context</a> *context, xcb_connection_t *connection, int32_t device_id, enum <a class="el" href="group__keymap.html#gad418fa5861e00b37c362075a380299b2">xkb_keymap_compile_flags</a> flags)</td></tr> <tr class="separator:ga9ccc80dcb7488167c8466cb833286559"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>Opaque compiled keymap object. </p> <p>The keymap object holds all of the static keyboard information obtained from compiling XKB files.</p> <p>A keymap is immutable after it is created (besides reference counts, etc.); if you need to change it, you must create a new one. </p> </div><hr/>The documentation for this struct was generated from the following files:<ul> <li>xkbcommon/<a class="el" href="xkbcommon_8h.html">xkbcommon.h</a></li> <li>xkbcommon/<a class="el" href="xkbcommon-x11_8h.html">xkbcommon-x11.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.15 </small></address> </body> </html>