<!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"/>
<title>i3: Binding Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2-20100208 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>Binding Struct Reference</h1><!-- doxytag: class="Binding" -->
<p>Holds a keybinding, consisting of a keycode combined with modifiers and the command which is executed as soon as the key is pressed (see src/command.c).
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00036_source.html">data.h</a>></code></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#aa3d67d5970792dad52748bacf6de986d">TAILQ_ENTRY</a> (<a class="el" href="a00003.html">Binding</a>) <a class="el" href="a00071.html#afe67646b6ee7ae51b130a59354fe7f49">bindings</a></td></tr>
<tr><td colspan="2"><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#a82bca43f02debcb9125c8c3f650a573d">symbol</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Symbol the user specified in configfile, if any. <a href="#a82bca43f02debcb9125c8c3f650a573d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">xcb_keycode_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#a66527e5582bc56a6bae1f08fa3af55cb">translated_to</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Only in use if symbol != NULL. <a href="#a66527e5582bc56a6bae1f08fa3af55cb"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#add9435ea373eaa4edab185fc41f69ecc">number_keycodes</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#a7f033747baf05a7cdbe176afdddab7e6">keycode</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Keycode to bind. <a href="#a7f033747baf05a7cdbe176afdddab7e6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#ac1d18080d951bafa7ee0a291aade6e07">mods</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Bitmask consisting of BIND_MOD_1, BIND_MODE_SWITCH, …. <a href="#ac1d18080d951bafa7ee0a291aade6e07"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00003.html#a6b2981f10cc6dc9d285d8091e7c55812">command</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Command, like in command mode. <a href="#a6b2981f10cc6dc9d285d8091e7c55812"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Holds a keybinding, consisting of a keycode combined with modifiers and the command which is executed as soon as the key is pressed (see src/command.c). </p>
<p>Definition at line <a class="el" href="a00036_source.html#l00261">261</a> of file <a class="el" href="a00036_source.html">data.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aa3d67d5970792dad52748bacf6de986d"></a><!-- doxytag: member="Binding::TAILQ_ENTRY" ref="aa3d67d5970792dad52748bacf6de986d" args="(Binding) bindings" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Binding::TAILQ_ENTRY </td>
<td>(</td>
<td class="paramtype"><a class="el" href="a00003.html">Binding</a> </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
</div>
</div>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="a6b2981f10cc6dc9d285d8091e7c55812"></a><!-- doxytag: member="Binding::command" ref="a6b2981f10cc6dc9d285d8091e7c55812" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* <a class="el" href="a00003.html#a6b2981f10cc6dc9d285d8091e7c55812">Binding::command</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Command, like in command mode. </p>
<p>Definition at line <a class="el" href="a00036_source.html#l00283">283</a> of file <a class="el" href="a00036_source.html">data.h</a>.</p>
<p>Referenced by <a class="el" href="a00067_source.html#l00090">handle_key_press()</a>, <a class="el" href="a00062_source.html#l00307">load_configuration()</a>, and <a class="el" href="a00056_source.html#l01427">yyparse()</a>.</p>
</div>
</div>
<a class="anchor" id="a7f033747baf05a7cdbe176afdddab7e6"></a><!-- doxytag: member="Binding::keycode" ref="a7f033747baf05a7cdbe176afdddab7e6" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t <a class="el" href="a00003.html#a7f033747baf05a7cdbe176afdddab7e6">Binding::keycode</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Keycode to bind. </p>
<p>Definition at line <a class="el" href="a00036_source.html#l00277">277</a> of file <a class="el" href="a00036_source.html">data.h</a>.</p>
<p>Referenced by <a class="el" href="a00062_source.html#l00109">get_binding()</a>, <a class="el" href="a00062_source.html#l00188">grab_all_keys()</a>, <a class="el" href="a00062_source.html#l00138">translate_keysyms()</a>, and <a class="el" href="a00056_source.html#l01427">yyparse()</a>.</p>
</div>
</div>
<a class="anchor" id="ac1d18080d951bafa7ee0a291aade6e07"></a><!-- doxytag: member="Binding::mods" ref="ac1d18080d951bafa7ee0a291aade6e07" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t <a class="el" href="a00003.html#ac1d18080d951bafa7ee0a291aade6e07">Binding::mods</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Bitmask consisting of BIND_MOD_1, BIND_MODE_SWITCH, …. </p>
<p>Definition at line <a class="el" href="a00036_source.html#l00280">280</a> of file <a class="el" href="a00036_source.html">data.h</a>.</p>
<p>Referenced by <a class="el" href="a00062_source.html#l00109">get_binding()</a>, <a class="el" href="a00062_source.html#l00188">grab_all_keys()</a>, <a class="el" href="a00062_source.html#l00085">grab_keycode_for_binding()</a>, and <a class="el" href="a00056_source.html#l01427">yyparse()</a>.</p>
</div>
</div>
<a class="anchor" id="add9435ea373eaa4edab185fc41f69ecc"></a><!-- doxytag: member="Binding::number_keycodes" ref="add9435ea373eaa4edab185fc41f69ecc" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t <a class="el" href="a00003.html#add9435ea373eaa4edab185fc41f69ecc">Binding::number_keycodes</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Definition at line <a class="el" href="a00036_source.html#l00274">274</a> of file <a class="el" href="a00036_source.html">data.h</a>.</p>
<p>Referenced by <a class="el" href="a00062_source.html#l00109">get_binding()</a>, <a class="el" href="a00062_source.html#l00188">grab_all_keys()</a>, and <a class="el" href="a00062_source.html#l00138">translate_keysyms()</a>.</p>
</div>
</div>
<a class="anchor" id="a82bca43f02debcb9125c8c3f650a573d"></a><!-- doxytag: member="Binding::symbol" ref="a82bca43f02debcb9125c8c3f650a573d" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char* <a class="el" href="a00003.html#a82bca43f02debcb9125c8c3f650a573d">Binding::symbol</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Symbol the user specified in configfile, if any. </p>
<p>This needs to be stored with the binding to be able to re-convert it into a keycode if the keyboard mapping changes (using Xmodmap for example) </p>
<p>Definition at line <a class="el" href="a00036_source.html#l00265">265</a> of file <a class="el" href="a00036_source.html">data.h</a>.</p>
<p>Referenced by <a class="el" href="a00062_source.html#l00109">get_binding()</a>, <a class="el" href="a00062_source.html#l00138">translate_keysyms()</a>, and <a class="el" href="a00056_source.html#l01427">yyparse()</a>.</p>
</div>
</div>
<a class="anchor" id="a66527e5582bc56a6bae1f08fa3af55cb"></a><!-- doxytag: member="Binding::translated_to" ref="a66527e5582bc56a6bae1f08fa3af55cb" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">xcb_keycode_t* <a class="el" href="a00003.html#a66527e5582bc56a6bae1f08fa3af55cb">Binding::translated_to</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Only in use if symbol != NULL. </p>
<p>Gets set to the value to which the symbol got translated when binding. Useful for unbinding and checking which binding was used when a key press event comes in.</p>
<p>This is an array of number_keycodes size. </p>
<p>Definition at line <a class="el" href="a00036_source.html#l00272">272</a> of file <a class="el" href="a00036_source.html">data.h</a>.</p>
<p>Referenced by <a class="el" href="a00062_source.html#l00109">get_binding()</a>, <a class="el" href="a00062_source.html#l00188">grab_all_keys()</a>, <a class="el" href="a00062_source.html#l00307">load_configuration()</a>, and <a class="el" href="a00062_source.html#l00138">translate_keysyms()</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>include/<a class="el" href="a00036_source.html">data.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address>
</body>
</html>
