<!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 Creation</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="#define-members">Macros</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Keymap Creation</div> </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga95e4461eb947cc61c3574ee4f0d24fb6"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__keymap.html#ga95e4461eb947cc61c3574ee4f0d24fb6">XKB_KEYMAP_USE_ORIGINAL_FORMAT</a>   ((enum <a class="el" href="group__keymap.html#gab0f75d6cc5773e5dd404e2c3f61366a3">xkb_keymap_format</a>) -1)</td></tr>
<tr class="separator:ga95e4461eb947cc61c3574ee4f0d24fb6"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gad418fa5861e00b37c362075a380299b2"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__keymap.html#gad418fa5861e00b37c362075a380299b2">xkb_keymap_compile_flags</a> { <a class="el" href="group__keymap.html#ggad418fa5861e00b37c362075a380299b2ae274bf0a09997d395e712156b0dbf7fa">XKB_KEYMAP_COMPILE_NO_FLAGS</a> = 0
}</td></tr>
<tr class="separator:gad418fa5861e00b37c362075a380299b2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gab0f75d6cc5773e5dd404e2c3f61366a3"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group__keymap.html#gab0f75d6cc5773e5dd404e2c3f61366a3">xkb_keymap_format</a> { <a class="el" href="group__keymap.html#ggab0f75d6cc5773e5dd404e2c3f61366a3ad63ee709a87611a89b42c3e1275347ed">XKB_KEYMAP_FORMAT_TEXT_V1</a> = 1
}</td></tr>
<tr class="separator:gab0f75d6cc5773e5dd404e2c3f61366a3"><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: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::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::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::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::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::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::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::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>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Creating and destroying keymaps. </p>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a id="ga95e4461eb947cc61c3574ee4f0d24fb6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga95e4461eb947cc61c3574ee4f0d24fb6">◆ </a></span>XKB_KEYMAP_USE_ORIGINAL_FORMAT</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define XKB_KEYMAP_USE_ORIGINAL_FORMAT   ((enum <a class="el" href="group__keymap.html#gab0f75d6cc5773e5dd404e2c3f61366a3">xkb_keymap_format</a>) -1)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the keymap as a string in the format from which it was created. </p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__keymap.html#gab4430b8b2f125b81e6200c39dbd097ea" title="Get the compiled keymap as a string.">xkb_keymap_get_as_string()</a> </dd></dl>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="gad418fa5861e00b37c362075a380299b2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gad418fa5861e00b37c362075a380299b2">◆ </a></span>xkb_keymap_compile_flags</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__keymap.html#gad418fa5861e00b37c362075a380299b2">xkb_keymap_compile_flags</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Flags for keymap compilation. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggad418fa5861e00b37c362075a380299b2ae274bf0a09997d395e712156b0dbf7fa"></a>XKB_KEYMAP_COMPILE_NO_FLAGS </td><td class="fielddoc"><p>Do not apply any flags. </p>
</td></tr>
</table>
</div>
</div>
<a id="gab0f75d6cc5773e5dd404e2c3f61366a3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab0f75d6cc5773e5dd404e2c3f61366a3">◆ </a></span>xkb_keymap_format</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group__keymap.html#gab0f75d6cc5773e5dd404e2c3f61366a3">xkb_keymap_format</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>The possible keymap formats. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggab0f75d6cc5773e5dd404e2c3f61366a3ad63ee709a87611a89b42c3e1275347ed"></a>XKB_KEYMAP_FORMAT_TEXT_V1 </td><td class="fielddoc"><p>The current/classic XKB text format, as generated by xkbcomp -xkb. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga502717aa7148fd17d4970896f1e9e06f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga502717aa7148fd17d4970896f1e9e06f">◆ </a></span>xkb_keymap_new_from_names()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> * xkb_keymap_new_from_names </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxkb__context.html">xkb_context</a> * </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const struct <a class="el" href="structxkb__rule__names.html">xkb_rule_names</a> * </td>
<td class="paramname"><em>names</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="group__keymap.html#gad418fa5861e00b37c362075a380299b2">xkb_keymap_compile_flags</a> </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a keymap from RMLVO names. </p>
<p>The primary keymap entry point: creates a new XKB keymap from a set of RMLVO (Rules + Model + Layouts + Variants + Options) names.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>The context in which to create the keymap. </td></tr>
<tr><td class="paramname">names</td><td>The RMLVO names to use. See <a class="el" href="structxkb__rule__names.html" title="Names to compile a keymap with, also known as RMLVO.">xkb_rule_names</a>. </td></tr>
<tr><td class="paramname">flags</td><td>Optional flags for the keymap, or 0.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A keymap compiled according to the RMLVO names, or NULL if the compilation failed.</dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="structxkb__rule__names.html" title="Names to compile a keymap with, also known as RMLVO.">xkb_rule_names</a> </dd></dl>
</div>
</div>
<a id="ga0cb0badfbe35a571d3b6b4491294fa11"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0cb0badfbe35a571d3b6b4491294fa11">◆ </a></span>xkb_keymap_new_from_file()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> * xkb_keymap_new_from_file </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxkb__context.html">xkb_context</a> * </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FILE * </td>
<td class="paramname"><em>file</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="group__keymap.html#gab0f75d6cc5773e5dd404e2c3f61366a3">xkb_keymap_format</a> </td>
<td class="paramname"><em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="group__keymap.html#gad418fa5861e00b37c362075a380299b2">xkb_keymap_compile_flags</a> </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a keymap from a keymap file. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">context</td><td>The context in which to create the keymap. </td></tr>
<tr><td class="paramname">file</td><td>The keymap file to compile. </td></tr>
<tr><td class="paramname">format</td><td>The text format of the keymap file to compile. </td></tr>
<tr><td class="paramname">flags</td><td>Optional flags for the keymap, or 0.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A keymap compiled from the given XKB keymap file, or NULL if the compilation failed.</dd></dl>
<p>The file must contain a complete keymap. For example, in the XKB_KEYMAP_FORMAT_TEXT_V1 format, this means the file must contain one top level 'xkb_keymap' section, which in turn contains other required sections. </p>
</div>
</div>
<a id="ga9d98e2e1348bd756bd3229d0b9432886"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9d98e2e1348bd756bd3229d0b9432886">◆ </a></span>xkb_keymap_new_from_string()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> * xkb_keymap_new_from_string </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxkb__context.html">xkb_context</a> * </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>string</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="group__keymap.html#gab0f75d6cc5773e5dd404e2c3f61366a3">xkb_keymap_format</a> </td>
<td class="paramname"><em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="group__keymap.html#gad418fa5861e00b37c362075a380299b2">xkb_keymap_compile_flags</a> </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a keymap from a keymap string. </p>
<p>This is just like <a class="el" href="group__keymap.html#ga0cb0badfbe35a571d3b6b4491294fa11" title="Create a keymap from a keymap file.">xkb_keymap_new_from_file()</a>, but instead of a file, gets the keymap as one enormous string.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__keymap.html#ga0cb0badfbe35a571d3b6b4491294fa11" title="Create a keymap from a keymap file.">xkb_keymap_new_from_file()</a> </dd></dl>
</div>
</div>
<a id="ga19e1a8824c7c51bf5ac8a8cb8b7d40d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga19e1a8824c7c51bf5ac8a8cb8b7d40d2">◆ </a></span>xkb_keymap_new_from_buffer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> * xkb_keymap_new_from_buffer </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structxkb__context.html">xkb_context</a> * </td>
<td class="paramname"><em>context</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>length</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="group__keymap.html#gab0f75d6cc5773e5dd404e2c3f61366a3">xkb_keymap_format</a> </td>
<td class="paramname"><em>format</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">enum <a class="el" href="group__keymap.html#gad418fa5861e00b37c362075a380299b2">xkb_keymap_compile_flags</a> </td>
<td class="paramname"><em>flags</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a keymap from a memory buffer. </p>
<p>This is just like <a class="el" href="group__keymap.html#ga9d98e2e1348bd756bd3229d0b9432886" title="Create a keymap from a keymap string.">xkb_keymap_new_from_string()</a>, but takes a length argument so the input string does not have to be zero-terminated.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="group__keymap.html#ga9d98e2e1348bd756bd3229d0b9432886" title="Create a keymap from a keymap string.">xkb_keymap_new_from_string()</a></dd></dl>
<dl class="section since"><dt>Since</dt><dd>0.3.0 </dd></dl>
</div>
</div>
<a id="ga2b04dbdf580d9082b45c44381ae5fed0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2b04dbdf580d9082b45c44381ae5fed0">◆ </a></span>xkb_keymap_ref()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structxkb__keymap.html">xkb_keymap</a> * xkb_keymap_ref </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>Take a new reference on a keymap. </p>
<dl class="section return"><dt>Returns</dt><dd>The passed in keymap. </dd></dl>
</div>
</div>
<a id="gafb6b3d3fce63eb6dde6c1de0850fcf41"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafb6b3d3fce63eb6dde6c1de0850fcf41">◆ </a></span>xkb_keymap_unref()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void xkb_keymap_unref </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>Release a reference on a keymap, and possibly free it. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">keymap</td><td>The keymap. If it is NULL, this function does nothing. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="gab4430b8b2f125b81e6200c39dbd097ea"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gab4430b8b2f125b81e6200c39dbd097ea">◆ </a></span>xkb_keymap_get_as_string()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char * xkb_keymap_get_as_string </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">enum <a class="el" href="group__keymap.html#gab0f75d6cc5773e5dd404e2c3f61366a3">xkb_keymap_format</a> </td>
<td class="paramname"><em>format</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the compiled keymap as a string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">keymap</td><td>The keymap to get as a string. </td></tr>
<tr><td class="paramname">format</td><td>The keymap format to use for the string. You can pass in the special value XKB_KEYMAP_USE_ORIGINAL_FORMAT to use the format from which the keymap was originally created.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The keymap as a NUL-terminated string, or NULL if unsuccessful.</dd></dl>
<p>The returned string may be fed back into <a class="el" href="group__keymap.html#ga9d98e2e1348bd756bd3229d0b9432886" title="Create a keymap from a keymap string.">xkb_keymap_new_from_string()</a> to get the exact same keymap (possibly in another process, etc.).</p>
<p>The returned string is dynamically allocated and should be freed by the caller. </p>
</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
>
33
