<!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 name="robots" content="index,follow"/>
<title>swift::SKeymap Class Reference</title>
<link rel="shortcut icon" href="favicon.ico">
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="stdair.css" rel="stylesheet" type="text/css"/>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-24867310-1']);
_gaq.push(['_setDomainName', 'none']);
_gaq.push(['_setAllowLinker', true]);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
<script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
</head>
<body>
<div id="top"><!-- do not remove this div! -->
<div id="titlearea">
<table width="100%">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname"><a href="http://stdair.sourceforge.net"><img height="45px" alt="StdAir Logo" src="stdair_logo.png"></a>
 <span id="projectnumber">1.00.1</span>
</div>
<div id="projectbrief">C++ Standard Airline IT Object Library</div>
</td>
<!-- begin SOURCEFORGE_CUSTOM-->
<td>
<div id="sflogo"><a href="http://stdair.sourceforge.net"><img height="45px" alt="SourceForge Logo" src="sfx_logo.png"></a></div>
</td>
<!-- end SOURCEFORGE_CUSTOM-->
</tr>
</tbody>
</table>
</div>
<!-- Generated by Doxygen 1.8.3.1 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('a00174.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Friends</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#friends">Friends</a> |
<a href="a00706.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">swift::SKeymap Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>The readline keymap wrapper.
<a href="a00174.html#details">More...</a></p>
<p><code>#include <<a class="el" href="a00522_source.html">stdair/ui/cmdline/SReadline.hpp</a>></code></p>
<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:a0e89f8d4b43ea82651cab1e868bf4c23"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00174.html#a0e89f8d4b43ea82651cab1e868bf4c23">SKeymap</a> (bool PrintableBound=false)</td></tr>
<tr class="memdesc:a0e89f8d4b43ea82651cab1e868bf4c23"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new keymap. <a href="#a0e89f8d4b43ea82651cab1e868bf4c23">More...</a><br/></td></tr>
<tr class="separator:a0e89f8d4b43ea82651cab1e868bf4c23"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a89011a4300cabf9a358e1ccbed70237f"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00174.html#a89011a4300cabf9a358e1ccbed70237f">SKeymap</a> (Keymap Pattern)</td></tr>
<tr class="memdesc:a89011a4300cabf9a358e1ccbed70237f"><td class="mdescLeft"> </td><td class="mdescRight">Creates a new keymap which is a copy of Pattern. <a href="#a89011a4300cabf9a358e1ccbed70237f">More...</a><br/></td></tr>
<tr class="separator:a89011a4300cabf9a358e1ccbed70237f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a07d05dbe168af4677d6c533598effca1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00174.html#a07d05dbe168af4677d6c533598effca1">~SKeymap</a> ()</td></tr>
<tr class="memdesc:a07d05dbe168af4677d6c533598effca1"><td class="mdescLeft"> </td><td class="mdescRight">Frees the allocated keymap. <a href="#a07d05dbe168af4677d6c533598effca1">More...</a><br/></td></tr>
<tr class="separator:a07d05dbe168af4677d6c533598effca1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a08053921f956bc20307f1e4ed6a5d1a9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00174.html#a08053921f956bc20307f1e4ed6a5d1a9">Bind</a> (int Key, KeyCallback Callback)</td></tr>
<tr class="memdesc:a08053921f956bc20307f1e4ed6a5d1a9"><td class="mdescLeft"> </td><td class="mdescRight">Binds the given key to a function. <a href="#a08053921f956bc20307f1e4ed6a5d1a9">More...</a><br/></td></tr>
<tr class="separator:a08053921f956bc20307f1e4ed6a5d1a9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aced21d00e68e1b0b58f7a108299e881d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00174.html#aced21d00e68e1b0b58f7a108299e881d">Unbind</a> (int Key)</td></tr>
<tr class="memdesc:aced21d00e68e1b0b58f7a108299e881d"><td class="mdescLeft"> </td><td class="mdescRight">Unbinds the given key. <a href="#aced21d00e68e1b0b58f7a108299e881d">More...</a><br/></td></tr>
<tr class="separator:aced21d00e68e1b0b58f7a108299e881d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad8f3f86e21685f01f7cc290dfd594237"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00174.html#ad8f3f86e21685f01f7cc290dfd594237">SKeymap</a> (const <a class="el" href="a00174.html">SKeymap</a> &rhs)</td></tr>
<tr class="memdesc:ad8f3f86e21685f01f7cc290dfd594237"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="#ad8f3f86e21685f01f7cc290dfd594237">More...</a><br/></td></tr>
<tr class="separator:ad8f3f86e21685f01f7cc290dfd594237"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1d997b97625ef6dd7c46e56b3fa1f28c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a00174.html">SKeymap</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="a00174.html#a1d997b97625ef6dd7c46e56b3fa1f28c">operator=</a> (const <a class="el" href="a00174.html">SKeymap</a> &rhs)</td></tr>
<tr class="memdesc:a1d997b97625ef6dd7c46e56b3fa1f28c"><td class="mdescLeft"> </td><td class="mdescRight">operator= <a href="#a1d997b97625ef6dd7c46e56b3fa1f28c">More...</a><br/></td></tr>
<tr class="separator:a1d997b97625ef6dd7c46e56b3fa1f28c"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:a6f7cd5caa0ddba1eacbfa81f0c5a67d1"><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00174.html#a6f7cd5caa0ddba1eacbfa81f0c5a67d1">SReadline</a></td></tr>
<tr class="separator:a6f7cd5caa0ddba1eacbfa81f0c5a67d1"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>The readline keymap wrapper. </p>
<p>Attention: It is not thread safe! Supports: key binding, key unbinding </p>
<p>Definition at line <a class="el" href="a00522_source.html#l00307">307</a> of file <a class="el" href="a00522_source.html">SReadline.hpp</a>.</p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a0e89f8d4b43ea82651cab1e868bf4c23"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">swift::SKeymap::SKeymap </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>PrintableBound</em> = <code>false</code></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new keymap. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">PrintableBound</td><td>if true - the printable characters are bound if false - the keymap is empty </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00522_source.html#l00319">319</a> of file <a class="el" href="a00522_source.html">SReadline.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a89011a4300cabf9a358e1ccbed70237f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">swift::SKeymap::SKeymap </td>
<td>(</td>
<td class="paramtype">Keymap </td>
<td class="paramname"><em>Pattern</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a new keymap which is a copy of Pattern. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Pattern</td><td>A keymap to be copied. </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00522_source.html#l00342">342</a> of file <a class="el" href="a00522_source.html">SReadline.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a07d05dbe168af4677d6c533598effca1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">swift::SKeymap::~SKeymap </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Frees the allocated keymap. </p>
<p>Definition at line <a class="el" href="a00522_source.html#l00354">354</a> of file <a class="el" href="a00522_source.html">SReadline.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="ad8f3f86e21685f01f7cc290dfd594237"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">swift::SKeymap::SKeymap </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00174.html">SKeymap</a> & </td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rhs</td><td>Right hand side object of <a class="el" href="a00174.html" title="The readline keymap wrapper.">SKeymap</a> </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00522_source.html#l00395">395</a> of file <a class="el" href="a00522_source.html">SReadline.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a08053921f956bc20307f1e4ed6a5d1a9"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void swift::SKeymap::Bind </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>Key</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">KeyCallback </td>
<td class="paramname"><em>Callback</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Binds the given key to a function. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Key</td><td>A key to be bound </td></tr>
<tr><td class="paramname">Callback</td><td>A function to be called when the Key is pressed </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00522_source.html#l00366">366</a> of file <a class="el" href="a00522_source.html">SReadline.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="aced21d00e68e1b0b58f7a108299e881d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void swift::SKeymap::Unbind </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>Key</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Unbinds the given key. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">Key</td><td>A key to be unbound </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00522_source.html#l00381">381</a> of file <a class="el" href="a00522_source.html">SReadline.hpp</a>.</p>
</div>
</div>
<a class="anchor" id="a1d997b97625ef6dd7c46e56b3fa1f28c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="a00174.html">SKeymap</a>& swift::SKeymap::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="a00174.html">SKeymap</a> & </td>
<td class="paramname"><em>rhs</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>operator= </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">rhs</td><td>Right hand side object of <a class="el" href="a00174.html" title="The readline keymap wrapper.">SKeymap</a> </td></tr>
</table>
</dd>
</dl>
<p>Definition at line <a class="el" href="a00522_source.html#l00407">407</a> of file <a class="el" href="a00522_source.html">SReadline.hpp</a>.</p>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a class="anchor" id="a6f7cd5caa0ddba1eacbfa81f0c5a67d1"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">friend class <a class="el" href="a00178.html">SReadline</a></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">friend</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="a00522_source.html#l00415">415</a> of file <a class="el" href="a00522_source.html">SReadline.hpp</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>stdair/ui/cmdline/<a class="el" href="a00522_source.html">SReadline.hpp</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<li class="footer">Generated on Wed May 22 2013 10:52:03 for StdAir by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a>
1.8.3.1
</li>
<li class="footer">
<a href="http://sourceforge.net/projects/stdair"><img class="footer" src="http://sflogo.sourceforge.net/sflogo.php?group_id=267760&type=12&format=.png" alt="SourceForge Logo"></a>
</li>
</ul>
</div>
</body>
</html>
