<!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: Keymap Components</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="#typedef-members">Typedefs</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Keymap Components</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</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::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="func-members"></a>
Functions</h2></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::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::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::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::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::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::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::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::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::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::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::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::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::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::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::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::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::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::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>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Enumeration of state components in a keymap. </p>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="ga40242f70d6c403bfe833dbd61d3b42ae"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga40242f70d6c403bfe833dbd61d3b42ae">◆ </a></span>xkb_keymap_key_iter_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* xkb_keymap_key_iter_t) (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>
</table>
</div><div class="memdoc">
<p>The iterator used by <a class="el" href="group__components.html#gaa6d6a6d4aaf70ca0aa798e491d5616d8" title="Run a specified function for every valid keycode in the keymap.">xkb_keymap_key_for_each()</a>. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__components.html#gaa6d6a6d4aaf70ca0aa798e491d5616d8" title="Run a specified function for every valid keycode in the keymap.">xkb_keymap_key_for_each</a></dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.3.1 </dd></dl>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga331a902b6b73defba931115e684b4180"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga331a902b6b73defba931115e684b4180">◆ </a></span>xkb_keymap_min_keycode()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="xkbcommon_8h.html#ac29aee92124c08d1953910ab28ee1997">xkb_keycode_t</a> xkb_keymap_min_keycode </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> * </td>
<td class="paramname"><em>keymap</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the minimum keycode in the keymap. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="xkbcommon_8h.html#ac29aee92124c08d1953910ab28ee1997" title="A number used to represent a physical key on a keyboard.">xkb_keycode_t</a></dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.3.1 </dd></dl>
</div>
</div>
<a id="gac392e896cf542740dd6e614d2956a33b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gac392e896cf542740dd6e614d2956a33b">◆ </a></span>xkb_keymap_max_keycode()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="xkbcommon_8h.html#ac29aee92124c08d1953910ab28ee1997">xkb_keycode_t</a> xkb_keymap_max_keycode </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> * </td>
<td class="paramname"><em>keymap</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the maximum keycode in the keymap. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="xkbcommon_8h.html#ac29aee92124c08d1953910ab28ee1997" title="A number used to represent a physical key on a keyboard.">xkb_keycode_t</a></dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.3.1 </dd></dl>
</div>
</div>
<a id="gaa6d6a6d4aaf70ca0aa798e491d5616d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa6d6a6d4aaf70ca0aa798e491d5616d8">◆ </a></span>xkb_keymap_key_for_each()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xkb_keymap_key_for_each </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> * </td>
<td class="paramname"><em>keymap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group__components.html#ga40242f70d6c403bfe833dbd61d3b42ae">xkb_keymap_key_iter_t</a> </td>
<td class="paramname"><em>iter</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>data</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Run a specified function for every valid keycode in the keymap. </p>
<p>If a keymap is sparse, this function may be called fewer than (max_keycode - min_keycode + 1) times.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__components.html#ga331a902b6b73defba931115e684b4180" title="Get the minimum keycode in the keymap.">xkb_keymap_min_keycode()</a> <a class="el" href="group__components.html#gac392e896cf542740dd6e614d2956a33b" title="Get the maximum keycode in the keymap.">xkb_keymap_max_keycode()</a> <a class="el" href="xkbcommon_8h.html#ac29aee92124c08d1953910ab28ee1997" title="A number used to represent a physical key on a keyboard.">xkb_keycode_t</a></dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.3.1 </dd></dl>
</div>
</div>
<a id="ga78e5410990705a08f768c0febdb703f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga78e5410990705a08f768c0febdb703f2">◆ </a></span>xkb_keymap_key_get_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * xkb_keymap_key_get_name </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> * </td>
<td class="paramname"><em>keymap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xkbcommon_8h.html#ac29aee92124c08d1953910ab28ee1997">xkb_keycode_t</a> </td>
<td class="paramname"><em>key</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Find the name of the key with the given keycode. </p>
<p>This function always returns the canonical name of the key (see description in xkb_keycode_t).</p>
<dl class="section return"><dt>Returns</dt><dd>The key name. If no key with this keycode exists, returns NULL.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="xkbcommon_8h.html#ac29aee92124c08d1953910ab28ee1997" title="A number used to represent a physical key on a keyboard.">xkb_keycode_t</a></dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.6.0 </dd></dl>
</div>
</div>
<a id="ga433915398b2bc6895822dec9b463dddf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga433915398b2bc6895822dec9b463dddf">◆ </a></span>xkb_keymap_key_by_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="xkbcommon_8h.html#ac29aee92124c08d1953910ab28ee1997">xkb_keycode_t</a> xkb_keymap_key_by_name </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> * </td>
<td class="paramname"><em>keymap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Find the keycode of the key with the given name. </p>
<p>The name can be either a canonical name or an alias.</p>
<dl class="section return"><dt>Returns</dt><dd>The keycode. If no key with this name exists, returns XKB_KEYCODE_INVALID.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="xkbcommon_8h.html#ac29aee92124c08d1953910ab28ee1997" title="A number used to represent a physical key on a keyboard.">xkb_keycode_t</a></dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.6.0 </dd></dl>
</div>
</div>
<a id="gaa7fe37876dfca94b6922cbb90ca36864"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaa7fe37876dfca94b6922cbb90ca36864">◆ </a></span>xkb_keymap_num_mods()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="xkbcommon_8h.html#a638bf7a52db06f383ce5a4ef99dfe539">xkb_mod_index_t</a> xkb_keymap_num_mods </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> * </td>
<td class="paramname"><em>keymap</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of modifiers in the keymap. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="xkbcommon_8h.html#a638bf7a52db06f383ce5a4ef99dfe539" title="Index of a modifier.">xkb_mod_index_t</a> </dd></dl>
</div>
</div>
<a id="ga50872d5d2afc75c942ff93c470822965"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga50872d5d2afc75c942ff93c470822965">◆ </a></span>xkb_keymap_mod_get_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * xkb_keymap_mod_get_name </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> * </td>
<td class="paramname"><em>keymap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xkbcommon_8h.html#a638bf7a52db06f383ce5a4ef99dfe539">xkb_mod_index_t</a> </td>
<td class="paramname"><em>idx</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the name of a modifier by index. </p>
<dl class="section return"><dt>Returns</dt><dd>The name. If the index is invalid, returns NULL.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="xkbcommon_8h.html#a638bf7a52db06f383ce5a4ef99dfe539" title="Index of a modifier.">xkb_mod_index_t</a> </dd></dl>
</div>
</div>
<a id="ga0a0c7dd365962663bc1eaa6f02b9a812"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0a0c7dd365962663bc1eaa6f02b9a812">◆ </a></span>xkb_keymap_mod_get_index()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="xkbcommon_8h.html#a638bf7a52db06f383ce5a4ef99dfe539">xkb_mod_index_t</a> xkb_keymap_mod_get_index </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> * </td>
<td class="paramname"><em>keymap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the index of a modifier by name. </p>
<dl class="section return"><dt>Returns</dt><dd>The index. If no modifier with this name exists, returns XKB_MOD_INVALID.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="xkbcommon_8h.html#a638bf7a52db06f383ce5a4ef99dfe539" title="Index of a modifier.">xkb_mod_index_t</a> </dd></dl>
</div>
</div>
<a id="gadb8f3c82d8d1c3bcd8acbe0b378b4c82"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gadb8f3c82d8d1c3bcd8acbe0b378b4c82">◆ </a></span>xkb_keymap_num_layouts()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="xkbcommon_8h.html#ad37512642806c55955e1cd5a30efcc39">xkb_layout_index_t</a> xkb_keymap_num_layouts </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> * </td>
<td class="paramname"><em>keymap</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of layouts in the keymap. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="xkbcommon_8h.html#ad37512642806c55955e1cd5a30efcc39" title="Index of a keyboard layout.">xkb_layout_index_t</a> <a class="el" href="structxkb__rule__names.html" title="Names to compile a keymap with, also known as RMLVO.">xkb_rule_names</a> <a class="el" href="group__components.html#gad5d59aef2778a33387ffdaf8f992b689" title="Get the number of layouts for a specific key.">xkb_keymap_num_layouts_for_key()</a> </dd></dl>
</div>
</div>
<a id="ga63b85a1431caed99af85e19ff50131f6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga63b85a1431caed99af85e19ff50131f6">◆ </a></span>xkb_keymap_layout_get_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * xkb_keymap_layout_get_name </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> * </td>
<td class="paramname"><em>keymap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xkbcommon_8h.html#ad37512642806c55955e1cd5a30efcc39">xkb_layout_index_t</a> </td>
<td class="paramname"><em>idx</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the name of a layout by index. </p>
<dl class="section return"><dt>Returns</dt><dd>The name. If the index is invalid, or the layout does not have a name, returns NULL.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="xkbcommon_8h.html#ad37512642806c55955e1cd5a30efcc39" title="Index of a keyboard layout.">xkb_layout_index_t</a> </dd></dl>
</div>
</div>
<a id="ga9e4e54af1db83e5871c64a639c94358d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9e4e54af1db83e5871c64a639c94358d">◆ </a></span>xkb_keymap_layout_get_index()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="xkbcommon_8h.html#ad37512642806c55955e1cd5a30efcc39">xkb_layout_index_t</a> xkb_keymap_layout_get_index </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> * </td>
<td class="paramname"><em>keymap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the index of a layout by name. </p>
<dl class="section return"><dt>Returns</dt><dd>The index. If no layout exists with this name, returns XKB_LAYOUT_INVALID. If more than one layout in the keymap has this name, returns the lowest index among them. </dd></dl>
</div>
</div>
<a id="ga8ee40041d8bca197c7f207ab87f9017d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8ee40041d8bca197c7f207ab87f9017d">◆ </a></span>xkb_keymap_num_leds()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="xkbcommon_8h.html#af6e951bdbcba8fb7e2532a8ebc6c9c87">xkb_led_index_t</a> xkb_keymap_num_leds </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> * </td>
<td class="paramname"><em>keymap</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of LEDs in the keymap. </p>
<dl class="section warning"><dt>Warning</dt><dd>The range [ 0...<a class="el" href="group__components.html#ga8ee40041d8bca197c7f207ab87f9017d" title="Get the number of LEDs in the keymap.">xkb_keymap_num_leds()</a> ) includes all of the LEDs in the keymap, but may also contain inactive LEDs. When iterating over this range, you need the handle this case when calling functions such as <a class="el" href="group__components.html#ga68b343be93dab76aed47699346f4225e" title="Get the name of a LED by index.">xkb_keymap_led_get_name()</a> or <a class="el" href="group__state.html#gaa5a02e6f26ccd29b95e32d6fcb8f8149" title="Test whether a LED is active in a given keyboard state by index.">xkb_state_led_index_is_active()</a>.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="xkbcommon_8h.html#af6e951bdbcba8fb7e2532a8ebc6c9c87" title="Index of a keyboard LED.">xkb_led_index_t</a> </dd></dl>
</div>
</div>
<a id="ga68b343be93dab76aed47699346f4225e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga68b343be93dab76aed47699346f4225e">◆ </a></span>xkb_keymap_led_get_name()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const char * xkb_keymap_led_get_name </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> * </td>
<td class="paramname"><em>keymap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xkbcommon_8h.html#af6e951bdbcba8fb7e2532a8ebc6c9c87">xkb_led_index_t</a> </td>
<td class="paramname"><em>idx</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the name of a LED by index. </p>
<dl class="section return"><dt>Returns</dt><dd>The name. If the index is invalid, returns NULL. </dd></dl>
</div>
</div>
<a id="gae7f970e4ba807657c3cc214fc13c998d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae7f970e4ba807657c3cc214fc13c998d">◆ </a></span>xkb_keymap_led_get_index()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="xkbcommon_8h.html#af6e951bdbcba8fb7e2532a8ebc6c9c87">xkb_led_index_t</a> xkb_keymap_led_get_index </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> * </td>
<td class="paramname"><em>keymap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the index of a LED by name. </p>
<dl class="section return"><dt>Returns</dt><dd>The index. If no LED with this name exists, returns XKB_LED_INVALID. </dd></dl>
</div>
</div>
<a id="gad5d59aef2778a33387ffdaf8f992b689"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad5d59aef2778a33387ffdaf8f992b689">◆ </a></span>xkb_keymap_num_layouts_for_key()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="xkbcommon_8h.html#ad37512642806c55955e1cd5a30efcc39">xkb_layout_index_t</a> xkb_keymap_num_layouts_for_key </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> * </td>
<td class="paramname"><em>keymap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xkbcommon_8h.html#ac29aee92124c08d1953910ab28ee1997">xkb_keycode_t</a> </td>
<td class="paramname"><em>key</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of layouts for a specific key. </p>
<p>This number can be different from <a class="el" href="group__components.html#gadb8f3c82d8d1c3bcd8acbe0b378b4c82" title="Get the number of layouts in the keymap.">xkb_keymap_num_layouts()</a>, but is always smaller. It is the appropriate value to use when iterating over the layouts of a key.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="xkbcommon_8h.html#ad37512642806c55955e1cd5a30efcc39" title="Index of a keyboard layout.">xkb_layout_index_t</a> </dd></dl>
</div>
</div>
<a id="gafc5aa736f1eb86a5377b98a03fb6d690"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafc5aa736f1eb86a5377b98a03fb6d690">◆ </a></span>xkb_keymap_num_levels_for_key()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="xkbcommon_8h.html#a7eb38bea2a311b6ff033816278d5bbea">xkb_level_index_t</a> xkb_keymap_num_levels_for_key </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> * </td>
<td class="paramname"><em>keymap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xkbcommon_8h.html#ac29aee92124c08d1953910ab28ee1997">xkb_keycode_t</a> </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xkbcommon_8h.html#ad37512642806c55955e1cd5a30efcc39">xkb_layout_index_t</a> </td>
<td class="paramname"><em>layout</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the number of shift levels for a specific key and layout. </p>
<p>If <code>layout</code> is out of range for this key (that is, larger or equal to the value returned by <a class="el" href="group__components.html#gad5d59aef2778a33387ffdaf8f992b689" title="Get the number of layouts for a specific key.">xkb_keymap_num_layouts_for_key()</a>), it is brought back into range in a manner consistent with <a class="el" href="group__state.html#gac59ad6a608fb36055ecaf8d09449174f" title="Get the effective layout index for a key in a given keyboard state.">xkb_state_key_get_layout()</a>.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="xkbcommon_8h.html#a7eb38bea2a311b6ff033816278d5bbea" title="Index of a shift level.">xkb_level_index_t</a> </dd></dl>
</div>
</div>
<a id="gad92b9334170316926595fbb5d634a181"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad92b9334170316926595fbb5d634a181">◆ </a></span>xkb_keymap_key_get_syms_by_level()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int xkb_keymap_key_get_syms_by_level </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> * </td>
<td class="paramname"><em>keymap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xkbcommon_8h.html#ac29aee92124c08d1953910ab28ee1997">xkb_keycode_t</a> </td>
<td class="paramname"><em>key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xkbcommon_8h.html#ad37512642806c55955e1cd5a30efcc39">xkb_layout_index_t</a> </td>
<td class="paramname"><em>layout</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xkbcommon_8h.html#a7eb38bea2a311b6ff033816278d5bbea">xkb_level_index_t</a> </td>
<td class="paramname"><em>level</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="xkbcommon_8h.html#a79e604a22703391bdfe212cfc10ea007">xkb_keysym_t</a> ** </td>
<td class="paramname"><em>syms_out</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the keysyms obtained from pressing a key in a given layout and shift level. </p>
<p>This function is like <a class="el" href="group__state.html#ga47311e7268935dd2fe3e6ef057a82cb0" title="Get the keysyms obtained from pressing a particular key in a given keyboard state.">xkb_state_key_get_syms()</a>, only the layout and shift level are not derived from the keyboard state but are instead specified explicitly.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">keymap</td><td>The keymap. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">key</td><td>The keycode of the key. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">layout</td><td>The layout for which to get the keysyms. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">level</td><td>The shift level in the layout for which to get the keysyms. This must be smaller than: <div class="fragment"><div class="line"><a class="code" href="group__components.html#gafc5aa736f1eb86a5377b98a03fb6d690">xkb_keymap_num_levels_for_key</a>(keymap, key) </div></div><!-- fragment --> </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">syms_out</td><td>An immutable array of keysyms corresponding to the key in the given layout and shift level.</td></tr>
</table>
</dd>
</dl>
<p>If <code>layout</code> is out of range for this key (that is, larger or equal to the value returned by <a class="el" href="group__components.html#gad5d59aef2778a33387ffdaf8f992b689" title="Get the number of layouts for a specific key.">xkb_keymap_num_layouts_for_key()</a>), it is brought back into range in a manner consistent with <a class="el" href="group__state.html#gac59ad6a608fb36055ecaf8d09449174f" title="Get the effective layout index for a key in a given keyboard state.">xkb_state_key_get_layout()</a>.</p>
<dl class="section return"><dt>Returns</dt><dd>The number of keysyms in the syms_out array. If no keysyms are produced by the key in the given layout and shift level, returns 0 and sets syms_out to NULL.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__state.html#ga47311e7268935dd2fe3e6ef057a82cb0" title="Get the keysyms obtained from pressing a particular key in a given keyboard state.">xkb_state_key_get_syms()</a> </dd></dl>
</div>
</div>
<a id="ga9d7f998efeca98b3afc7c257bbac90a8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9d7f998efeca98b3afc7c257bbac90a8">◆ </a></span>xkb_keymap_key_repeats()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int xkb_keymap_key_repeats </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> * </td>
<td class="paramname"><em>keymap</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="xkbcommon_8h.html#ac29aee92124c08d1953910ab28ee1997">xkb_keycode_t</a> </td>
<td class="paramname"><em>key</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Determine whether a key should repeat or not. </p>
<p>A keymap may specify different repeat behaviors for different keys. Most keys should generally exhibit repeat behavior; for example, holding the 'a' key down in a text editor should normally insert a single 'a' character every few milliseconds, until the key is released. However, there are keys which should not or do not need to be repeated. For example, repeating modifier keys such as Left/Right Shift or Caps Lock is not generally useful or desired.</p>
<dl class="section return"><dt>Returns</dt><dd>1 if the key should repeat, 0 otherwise. </dd></dl>
</div>
</div>
</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>
distrib
>
Mageia
>
7
>
i586
>
media
>
core-release
>
by-pkgid
>
214521e40ee5c5cbd07b2ea0b909bd01
>
files
>
29
