<!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>FIFE: FIFE::IKeyController Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body onload='searchBox.OnSelectItem(0);'>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript"><!--
var searchBox = new SearchBox("searchBox", "search",false,'Search');
--></script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">FIFE <span id="projectnumber">2008.0</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<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><a href="dirs.html"><span>Directories</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
<li id="searchli">
<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="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
initNavTree('class_f_i_f_e_1_1_i_key_controller.html','');
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<div class="title">FIFE::IKeyController Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="FIFE::IKeyController" -->
<p><code>#include <<a class="el" href="ec__ikeycontroller_8h_source.html">ec_ikeycontroller.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for FIFE::IKeyController:</div>
<div class="dyncontent">
<div class="center"><img src="class_f_i_f_e_1_1_i_key_controller__inherit__graph.png" border="0" usemap="#_f_i_f_e_1_1_i_key_controller_inherit__map" alt="Inheritance graph"/></div>
<map name="_f_i_f_e_1_1_i_key_controller_inherit__map" id="_f_i_f_e_1_1_i_key_controller_inherit__map">
<area shape="rect" id="node3" href="class_f_i_f_e_1_1_event_manager.html" title="{FIFE::EventManager\n|- m_commandlisteners\l- m_pending_commandlisteners\l- m_pending_commandlisteners_front\l- m_pending_cldeletions\l- m_keylisteners\l- m_pending_keylisteners\l- m_pending_keylisteners_front\l- m_pending_kldeletions\l- m_mouselisteners\l- m_pending_mouselisteners\l- m_pending_mouselisteners_front\l- m_pending_mldeletions\l- m_sdleventlisteners\l- m_pending_sdleventlisteners\l- m_pending_sdleventlisteners_front\l- m_pending_sdldeletions\l- m_keystatemap\l- m_keyfilter\l- m_mousestate\l- m_mostrecentbtn\l|+ EventManager()\l+ ~EventManager()\l+ addCommandListener()\l+ addCommandListenerFront()\l+ removeCommandListener()\l+ dispatchCommand()\l+ addKeyListener()\l+ addKeyListenerFront()\l+ removeKeyListener()\l+ addMouseListener()\l+ addMouseListenerFront()\l+ removeMouseListener()\l+ addSdlEventListener()\l+ addSdlEventListenerFront()\l+ removeSdlEventListener()\l+ getEventSourceType()\l+ processEvents()\l+ setKeyFilter()\l- processActiveEvent()\l- processKeyEvent()\l- processMouseEvent()\l- combineEvents()\l- dispatchSdlEvent()\l- dispatchKeyEvent()\l- dispatchMouseEvent()\l- fillModifiers()\l- fillKeyEvent()\l- fillMouseEvent()\l}" alt="" coords="5,192,243,1075"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="class_f_i_f_e_1_1_i_key_controller-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_i_key_controller.html#aabc2715ba71022f742625683a3503e19">addKeyListener</a> (<a class="el" href="class_f_i_f_e_1_1_i_key_listener.html">IKeyListener</a> *listener)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_i_key_controller.html#af2c0e954da6acd08566f48c208097397">addKeyListenerFront</a> (<a class="el" href="class_f_i_f_e_1_1_i_key_listener.html">IKeyListener</a> *listener)=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_f_i_f_e_1_1_i_key_controller.html#a6b6f4265c25f5964c332b8b51d9170dd">removeKeyListener</a> (<a class="el" href="class_f_i_f_e_1_1_i_key_listener.html">IKeyListener</a> *listener)=0</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Controller provides a way to receive events from the system Using this interface, clients can subscribe themselves to receive events </p>
<p>Definition at line <a class="el" href="ec__ikeycontroller_8h_source.html#l00043">43</a> of file <a class="el" href="ec__ikeycontroller_8h_source.html">ec_ikeycontroller.h</a>.</p>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="aabc2715ba71022f742625683a3503e19"></a><!-- doxytag: member="FIFE::IKeyController::addKeyListener" ref="aabc2715ba71022f742625683a3503e19" args="(IKeyListener *listener)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void FIFE::IKeyController::addKeyListener </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_f_i_f_e_1_1_i_key_listener.html">IKeyListener</a> * </td>
<td class="paramname"><em>listener</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds a listener to the back of the listener deque Listener will be notified via the corresponding events </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">listener</td><td>listener to add </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="class_f_i_f_e_1_1_event_manager.html#ada1edd8e4c629f9edb064747ca64053a">FIFE::EventManager</a>.</p>
</div>
</div>
<a class="anchor" id="af2c0e954da6acd08566f48c208097397"></a><!-- doxytag: member="FIFE::IKeyController::addKeyListenerFront" ref="af2c0e954da6acd08566f48c208097397" args="(IKeyListener *listener)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void FIFE::IKeyController::addKeyListenerFront </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_f_i_f_e_1_1_i_key_listener.html">IKeyListener</a> * </td>
<td class="paramname"><em>listener</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Adds a listener to the front of the listener deque Listener will be notified via the corresponding events </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">listener</td><td>listener to add </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="class_f_i_f_e_1_1_event_manager.html#af4d67c482120e620923654665736e3f4">FIFE::EventManager</a>.</p>
</div>
</div>
<a class="anchor" id="a6b6f4265c25f5964c332b8b51d9170dd"></a><!-- doxytag: member="FIFE::IKeyController::removeKeyListener" ref="a6b6f4265c25f5964c332b8b51d9170dd" args="(IKeyListener *listener)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void FIFE::IKeyController::removeKeyListener </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_f_i_f_e_1_1_i_key_listener.html">IKeyListener</a> * </td>
<td class="paramname"><em>listener</em></td><td>)</td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Removes an added listener from the controller. Listener will not be notified anymore via the corresponding events </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">listener</td><td>listener to remove </td></tr>
</table>
</dd>
</dl>
<p>Implemented in <a class="el" href="class_f_i_f_e_1_1_event_manager.html#a5abb5e47ca1a7372c012ce92c6ed60e7">FIFE::EventManager</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>engine/core/eventchannel/key/<a class="el" href="ec__ikeycontroller_8h_source.html">ec_ikeycontroller.h</a></li>
</ul>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_f_i_f_e.html">FIFE</a> </li>
<li class="navelem"><a class="el" href="class_f_i_f_e_1_1_i_key_controller.html">IKeyController</a> </li>
<li class="footer">Generated on Sun Jul 10 2011 for FIFE by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </li>
</ul>
</div>
<!-- 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>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerator</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>
</body>
</html>
