Sophie

Sophie

distrib > Mageia > 6 > armv7hl > media > core-updates > by-pkgid > 38dab587768953aca88376a81d96f344 > files > 30

libxkbcommon-doc-0.8.2-1.mga6.armv7hl.rpm

<!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: Library Context</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
   &#160;<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="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">Library Context</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:gaea2acb5b9e06239e20a7c34f5b223092"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__context.html#gaea2acb5b9e06239e20a7c34f5b223092">xkb_context_flags</a> { <br />
&#160;&#160;<a class="el" href="group__context.html#ggaea2acb5b9e06239e20a7c34f5b223092a52382673b85690e1990796b1c9c20538">XKB_CONTEXT_NO_FLAGS</a> = 0, 
<br />
&#160;&#160;<a class="el" href="group__context.html#ggaea2acb5b9e06239e20a7c34f5b223092a8a5fa2136c435d7f336731d8bae21cf8">XKB_CONTEXT_NO_DEFAULT_INCLUDES</a> = (1 &lt;&lt; 0), 
<br />
&#160;&#160;<a class="el" href="group__context.html#ggaea2acb5b9e06239e20a7c34f5b223092a666e72d87e14b18903353685813d9033">XKB_CONTEXT_NO_ENVIRONMENT_NAMES</a> = (1 &lt;&lt; 1)
<br />
 }</td></tr>
<tr class="separator:gaea2acb5b9e06239e20a7c34f5b223092"><td class="memSeparator" colspan="2">&#160;</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:gacecddbdb020205f335719fe445dc9fdc"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxkb__context.html">xkb_context</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__context.html#gacecddbdb020205f335719fe445dc9fdc">xkb_context::xkb_context_new</a> (enum <a class="el" href="group__context.html#gaea2acb5b9e06239e20a7c34f5b223092">xkb_context_flags</a> flags)</td></tr>
<tr class="separator:gacecddbdb020205f335719fe445dc9fdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga546c69074b55997bbeb4cf836f2c9ec9"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structxkb__context.html">xkb_context</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__context.html#ga546c69074b55997bbeb4cf836f2c9ec9">xkb_context::xkb_context_ref</a> (struct <a class="el" href="structxkb__context.html">xkb_context</a> *context)</td></tr>
<tr class="separator:ga546c69074b55997bbeb4cf836f2c9ec9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2c02737136dbc738b3c0db0a3a85e23a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__context.html#ga2c02737136dbc738b3c0db0a3a85e23a">xkb_context::xkb_context_unref</a> (struct <a class="el" href="structxkb__context.html">xkb_context</a> *context)</td></tr>
<tr class="separator:ga2c02737136dbc738b3c0db0a3a85e23a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf4c113ff9c46fbf5083c0684c7cdad08"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__context.html#gaf4c113ff9c46fbf5083c0684c7cdad08">xkb_context::xkb_context_set_user_data</a> (struct <a class="el" href="structxkb__context.html">xkb_context</a> *context, void *user_data)</td></tr>
<tr class="separator:gaf4c113ff9c46fbf5083c0684c7cdad08"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0ca68921be9faf45ff24d33ffd36f2ab"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__context.html#ga0ca68921be9faf45ff24d33ffd36f2ab">xkb_context::xkb_context_get_user_data</a> (struct <a class="el" href="structxkb__context.html">xkb_context</a> *context)</td></tr>
<tr class="separator:ga0ca68921be9faf45ff24d33ffd36f2ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>Creating, destroying and using library contexts. </p>
<p>Every keymap compilation request must have a context associated with it. The context keeps around state such as the include path. </p>


<h3><a id="envvars"></a>Environment Variables</h3><div class="textblock">The user may set some environment variables which affect the library:<ul>
<li><code>XKB_CONFIG_ROOT</code>, <code>HOME</code> - see <a class="el" href="group__include-path.html">Include Paths</a>.</li>
<li><code>XKB_LOG_LEVEL</code> - see <a class="el" href="group__logging.html#ga5577f09c6731e0cd4e7a04533c8e98d9" title="Set the current logging level. ">xkb_context_set_log_level()</a>.</li>
<li><code>XKB_LOG_VERBOSITY</code> - see <a class="el" href="group__logging.html#ga7ca5e54b5d6d39461679a360f4c3f418" title="Sets the current logging verbosity. ">xkb_context_set_log_verbosity()</a>.</li>
<li><code>XKB_DEFAULT_RULES</code>, <code>XKB_DEFAULT_MODEL</code>, <code>XKB_DEFAULT_LAYOUT</code>, <code>XKB_DEFAULT_VARIANT</code>, <code>XKB_DEFAULT_OPTIONS</code> - see <a class="el" href="structxkb__rule__names.html" title="Names to compile a keymap with, also known as RMLVO. ">xkb_rule_names</a>. </li>
</ul>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="gaea2acb5b9e06239e20a7c34f5b223092"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaea2acb5b9e06239e20a7c34f5b223092">&#9670;&nbsp;</a></span>xkb_context_flags</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__context.html#gaea2acb5b9e06239e20a7c34f5b223092">xkb_context_flags</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Flags for context creation. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ggaea2acb5b9e06239e20a7c34f5b223092a52382673b85690e1990796b1c9c20538"></a>XKB_CONTEXT_NO_FLAGS&#160;</td><td class="fielddoc"><p>Do not apply any context flags. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaea2acb5b9e06239e20a7c34f5b223092a8a5fa2136c435d7f336731d8bae21cf8"></a>XKB_CONTEXT_NO_DEFAULT_INCLUDES&#160;</td><td class="fielddoc"><p>Create this context with an empty include path. </p>
</td></tr>
<tr><td class="fieldname"><a id="ggaea2acb5b9e06239e20a7c34f5b223092a666e72d87e14b18903353685813d9033"></a>XKB_CONTEXT_NO_ENVIRONMENT_NAMES&#160;</td><td class="fielddoc"><p>Don't take RMLVO names from the environment. </p>
<dl class="section since"><dt>Since</dt><dd>0.3.0 </dd></dl>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="gacecddbdb020205f335719fe445dc9fdc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gacecddbdb020205f335719fe445dc9fdc">&#9670;&nbsp;</a></span>xkb_context_new()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structxkb__context.html">xkb_context</a> * xkb_context_new </td>
          <td>(</td>
          <td class="paramtype">enum <a class="el" href="group__context.html#gaea2acb5b9e06239e20a7c34f5b223092">xkb_context_flags</a>&#160;</td>
          <td class="paramname"><em>flags</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Create a new context. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">flags</td><td>Optional flags for the context, or 0.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A new context, or NULL on failure. </dd></dl>

</div>
</div>
<a id="ga546c69074b55997bbeb4cf836f2c9ec9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga546c69074b55997bbeb4cf836f2c9ec9">&#9670;&nbsp;</a></span>xkb_context_ref()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">struct <a class="el" href="structxkb__context.html">xkb_context</a> * xkb_context_ref </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structxkb__context.html">xkb_context</a> *&#160;</td>
          <td class="paramname"><em>context</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Take a new reference on a context. </p>
<dl class="section return"><dt>Returns</dt><dd>The passed in context. </dd></dl>

</div>
</div>
<a id="ga2c02737136dbc738b3c0db0a3a85e23a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2c02737136dbc738b3c0db0a3a85e23a">&#9670;&nbsp;</a></span>xkb_context_unref()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void xkb_context_unref </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structxkb__context.html">xkb_context</a> *&#160;</td>
          <td class="paramname"><em>context</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Release a reference on a context, and possibly free it. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">context</td><td>The context. If it is NULL, this function does nothing. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="gaf4c113ff9c46fbf5083c0684c7cdad08"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf4c113ff9c46fbf5083c0684c7cdad08">&#9670;&nbsp;</a></span>xkb_context_set_user_data()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void xkb_context_set_user_data </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structxkb__context.html">xkb_context</a> *&#160;</td>
          <td class="paramname"><em>context</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>user_data</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Store custom user data in the context. </p>
<p>This may be useful in conjunction with <a class="el" href="group__logging.html#ga52d8ebc2e0025ff6b6c57cda73b08d8e" title="Set a custom function to handle logging messages. ">xkb_context_set_log_fn()</a> or other callbacks. </p>

</div>
</div>
<a id="ga0ca68921be9faf45ff24d33ffd36f2ab"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga0ca68921be9faf45ff24d33ffd36f2ab">&#9670;&nbsp;</a></span>xkb_context_get_user_data()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void * xkb_context_get_user_data </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structxkb__context.html">xkb_context</a> *&#160;</td>
          <td class="paramname"><em>context</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Retrieves stored user data from the context. </p>
<dl class="section return"><dt>Returns</dt><dd>The stored user data. If the user data wasn't set, or the passed in context is NULL, returns NULL.</dd></dl>
<p>This may be useful to access private user data from callbacks like a custom logging function. </p>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional