<html>
<head>
<title>Ogre::KeyListener class Reference - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<link type="text/css" rel="stylesheet" href="style.css">
</head>
<body>
<!-- Generated by Doxygen 1.2.16 -->
<center>
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="namespaces.html">Namespace List</a> <a class="qindex" href="hierarchy.html">Class Hierarchy</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="namespacemembers.html">Namespace Members</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="globals.html">File Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
<hr><h1>Ogre::KeyListener Class Reference</h1><code>#include <<a class="el" href="OgreEventListeners_8h-source.html">OgreEventListeners.h</a>></code>
<p>
Inheritance diagram for Ogre::KeyListener:<p><center><img src="classOgre_1_1KeyListener__inherit__graph.png" border="0" usemap="#Ogre_1_1KeyListener__inherit__map" alt="Inheritance graph"></center>
<map name="Ogre_1_1KeyListener__inherit__map">
<area href="classOgre_1_1EventListener.html" shape="rect" coords="7,36,135,17" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for Ogre::KeyListener:<p><center><img src="classOgre_1_1KeyListener__coll__graph.png" border="0" usemap="#Ogre_1_1KeyListener__coll__map" alt="Collaboration graph"></center>
<map name="Ogre_1_1KeyListener__coll__map">
<area href="classOgre_1_1EventListener.html" shape="rect" coords="7,36,135,17" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classOgre_1_1KeyListener-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classOgre_1_1KeyListener.html#Ogre_1_1KeyListenera0">keyClicked</a> (<a class="el" href="classOgre_1_1KeyEvent.html">KeyEvent</a> *e)=0</td></tr>
<tr><td> </td><td><font size=-1><em>Invoked when the key has been clicked on a component.</em> <a href="#Ogre_1_1KeyListenera0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classOgre_1_1KeyListener.html#Ogre_1_1KeyListenera1">keyPressed</a> (<a class="el" href="classOgre_1_1KeyEvent.html">KeyEvent</a> *e)=0</td></tr>
<tr><td> </td><td><font size=-1><em>Invoked when a key button has been pressed on a component.</em> <a href="#Ogre_1_1KeyListenera1"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classOgre_1_1KeyListener.html#Ogre_1_1KeyListenera2">keyReleased</a> (<a class="el" href="classOgre_1_1KeyEvent.html">KeyEvent</a> *e)=0</td></tr>
<tr><td> </td><td><font size=-1><em>Invoked when a key button has been released on a component.</em> <a href="#Ogre_1_1KeyListenera2"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classOgre_1_1KeyListener.html#Ogre_1_1KeyListenera3">keyFocusIn</a> (<a class="el" href="classOgre_1_1KeyEvent.html">KeyEvent</a> *e)</td></tr>
<tr><td> </td><td><font size=-1><em>Invoked when the target receives the keyboard focus.</em> <a href="#Ogre_1_1KeyListenera3"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classOgre_1_1KeyListener.html#Ogre_1_1KeyListenera4">keyFocusOut</a> (<a class="el" href="classOgre_1_1KeyEvent.html">KeyEvent</a> *e)</td></tr>
<tr><td> </td><td><font size=-1><em>Invoked when the target loses the keyboard focus.</em> <a href="#Ogre_1_1KeyListenera4"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classOgre_1_1KeyListener.html#Ogre_1_1TTYGuiElementc0">isMulticaster</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns whether or not the listener is a multicaster.</em> <a href="#Ogre_1_1TTYGuiElementc0"></a><em></em></font><br><br></td></tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="Ogre_1_1TTYGuiElementc0" doxytag="Ogre::KeyListener::isMulticaster"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual bool Ogre::EventListener::isMulticaster </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap> const<code> [virtual, inherited]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns whether or not the listener is a multicaster.
<p>
<p>
Reimplemented in <a class="el" href="classOgre_1_1EventMulticaster.html#Ogre_1_1EventMulticastera15">Ogre::EventMulticaster</a>.
<p>
Definition at line <a class="el" href="OgreEventListeners_8h-source.html#l00065">65</a> of file <a class="el" href="OgreEventListeners_8h-source.html">OgreEventListeners.h</a>.
<p>
Referenced by <a class="el" href="OgreEventMulticaster_8cpp-source.html#l00233">Ogre::EventMulticaster::convertListenerToMulti</a>(), and <a class="el" href="OgreEventMulticaster_8cpp-source.html#l00191">Ogre::EventMulticaster::removeInternal</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1KeyListenera0" doxytag="Ogre::KeyListener::keyClicked"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void Ogre::KeyListener::keyClicked </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1KeyEvent.html">KeyEvent</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>e</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Invoked when the key has been clicked on a component.
<p>
<p>
Referenced by <a class="el" href="OgreKeyTarget_8cpp-source.html#l00044">Ogre::KeyTarget::processKeyEvent</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1KeyListenera3" doxytag="Ogre::KeyListener::keyFocusIn"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void Ogre::KeyListener::keyFocusIn </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1KeyEvent.html">KeyEvent</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>e</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Invoked when the target receives the keyboard focus.
<p>
<p>
Definition at line <a class="el" href="OgreEventListeners_8h-source.html#l00129">129</a> of file <a class="el" href="OgreEventListeners_8h-source.html">OgreEventListeners.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1KeyListenera4" doxytag="Ogre::KeyListener::keyFocusOut"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void Ogre::KeyListener::keyFocusOut </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1KeyEvent.html">KeyEvent</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>e</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Invoked when the target loses the keyboard focus.
<p>
<p>
Definition at line <a class="el" href="OgreEventListeners_8h-source.html#l00133">133</a> of file <a class="el" href="OgreEventListeners_8h-source.html">OgreEventListeners.h</a>. </td>
</tr>
</table>
<a name="Ogre_1_1KeyListenera1" doxytag="Ogre::KeyListener::keyPressed"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void Ogre::KeyListener::keyPressed </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1KeyEvent.html">KeyEvent</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>e</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Invoked when a key button has been pressed on a component.
<p>
<p>
Referenced by <a class="el" href="OgreKeyTarget_8cpp-source.html#l00044">Ogre::KeyTarget::processKeyEvent</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1KeyListenera2" doxytag="Ogre::KeyListener::keyReleased"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top"> virtual void Ogre::KeyListener::keyReleased </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1KeyEvent.html">KeyEvent</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>e</em> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap><code> [pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Invoked when a key button has been released on a component.
<p>
<p>
Referenced by <a class="el" href="OgreKeyTarget_8cpp-source.html#l00044">Ogre::KeyTarget::processKeyEvent</a>(). </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="OgreEventListeners_8h-source.html">OgreEventListeners.h</a></ul>
<p>
Copyright © 2002-2003 by The OGRE Team<br />
Last modified Wed Jan 21 00:17:59 2004
</p>
</body>
</html>
