<html>
<head>
<title>Ogre::MouseListener 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::MouseListener Class Reference</h1>Specialised <a class="el" href="classOgre_1_1EventListener.html">EventListener</a> for discrete mouse events.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="OgreEventListeners_8h-source.html">OgreEventListeners.h</a>></code>
<p>
Inheritance diagram for Ogre::MouseListener:<p><center><img src="classOgre_1_1MouseListener__inherit__graph.png" border="0" usemap="#Ogre_1_1MouseListener__inherit__map" alt="Inheritance graph"></center>
<map name="Ogre_1_1MouseListener__inherit__map">
<area href="classOgre_1_1EventMulticaster.html" shape="rect" coords="389,23,536,5" alt="">
<area href="classOgre_1_1GuiPressable.html" shape="rect" coords="399,66,527,47" alt="">
<area href="classOgre_1_1ListGuiElement.html" shape="rect" coords="395,109,531,90" alt="">
<area href="classOgre_1_1ScrollBarGuiElement.html" shape="rect" coords="377,151,548,133" alt="">
<area href="classOgre_1_1EventListener.html" shape="rect" coords="19,87,147,69" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for Ogre::MouseListener:<p><center><img src="classOgre_1_1MouseListener__coll__graph.png" border="0" usemap="#Ogre_1_1MouseListener__coll__map" alt="Collaboration graph"></center>
<map name="Ogre_1_1MouseListener__coll__map">
<area href="classOgre_1_1EventListener.html" shape="rect" coords="9,36,137,17" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classOgre_1_1MouseListener-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_1MouseListener.html#Ogre_1_1MouseListenera0">mouseClicked</a> (<a class="el" href="classOgre_1_1MouseEvent.html">MouseEvent</a> *e)=0</td></tr>
<tr><td> </td><td><font size=-1><em>Invoked when the mouse has been clicked on a component.</em> <a href="#Ogre_1_1MouseListenera0"></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_1MouseListener.html#Ogre_1_1MouseListenera1">mouseEntered</a> (<a class="el" href="classOgre_1_1MouseEvent.html">MouseEvent</a> *e)=0</td></tr>
<tr><td> </td><td><font size=-1><em>Invoked when the mouse enters a component.</em> <a href="#Ogre_1_1MouseListenera1"></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_1MouseListener.html#Ogre_1_1MouseListenera2">mouseExited</a> (<a class="el" href="classOgre_1_1MouseEvent.html">MouseEvent</a> *e)=0</td></tr>
<tr><td> </td><td><font size=-1><em>Invoked when the mouse exits a component.</em> <a href="#Ogre_1_1MouseListenera2"></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_1MouseListener.html#Ogre_1_1MouseListenera3">mousePressed</a> (<a class="el" href="classOgre_1_1MouseEvent.html">MouseEvent</a> *e)=0</td></tr>
<tr><td> </td><td><font size=-1><em>Invoked when a mouse button has been pressed on a component.</em> <a href="#Ogre_1_1MouseListenera3"></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_1MouseListener.html#Ogre_1_1MouseListenera4">mouseReleased</a> (<a class="el" href="classOgre_1_1MouseEvent.html">MouseEvent</a> *e)=0</td></tr>
<tr><td> </td><td><font size=-1><em>Invoked when a mouse button has been released on a component.</em> <a href="#Ogre_1_1MouseListenera4"></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_1MouseListener.html#Ogre_1_1ScrollBarGuiElementa117">mouseDragEntered</a> (<a class="el" href="classOgre_1_1MouseEvent.html">MouseEvent</a> *e)</td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classOgre_1_1MouseListener.html#Ogre_1_1ScrollBarGuiElementa118">mouseDragExited</a> (<a class="el" href="classOgre_1_1MouseEvent.html">MouseEvent</a> *e)</td></tr>
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classOgre_1_1MouseListener.html#Ogre_1_1ScrollBarGuiElementa119">mouseDragDropped</a> (<a class="el" href="classOgre_1_1MouseEvent.html">MouseEvent</a> *e)</td></tr>
<tr><td nowrap align=right valign=top>virtual bool </td><td valign=bottom><a class="el" href="classOgre_1_1MouseListener.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><a name="_details"></a><h2>Detailed Description</h2>
Specialised <a class="el" href="classOgre_1_1EventListener.html">EventListener</a> for discrete mouse events.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
This excludes mouse motion (this is not a discrete event), see <a class="el" href="classOgre_1_1MouseMotionListener.html">MouseMotionListener</a> for that. </dl>
<p>
<p>
Definition at line <a class="el" href="OgreEventListeners_8h-source.html#l00075">75</a> of file <a class="el" href="OgreEventListeners_8h-source.html">OgreEventListeners.h</a>.<hr><h2>Member Function Documentation</h2>
<a name="Ogre_1_1TTYGuiElementc0" doxytag="Ogre::MouseListener::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_1MouseListenera0" doxytag="Ogre::MouseListener::mouseClicked"></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::MouseListener::mouseClicked </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1MouseEvent.html">MouseEvent</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 mouse has been clicked on a component.
<p>
<p>
Implemented in <a class="el" href="classOgre_1_1EventMulticaster.html#Ogre_1_1EventMulticastera7">Ogre::EventMulticaster</a>, <a class="el" href="classOgre_1_1GuiPressable.html#Ogre_1_1PopupMenuGuiElementa121">Ogre::GuiPressable</a>, <a class="el" href="classOgre_1_1ListGuiElement.html#Ogre_1_1ListGuiElementa10">Ogre::ListGuiElement</a>, and <a class="el" href="classOgre_1_1ScrollBarGuiElement.html#Ogre_1_1ScrollBarGuiElementa17">Ogre::ScrollBarGuiElement</a>.
<p>
Referenced by <a class="el" href="OgreMouseTarget_8cpp-source.html#l00046">Ogre::MouseTarget::processMouseEvent</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1ScrollBarGuiElementa119" doxytag="Ogre::MouseListener::mouseDragDropped"></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::MouseListener::mouseDragDropped </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1MouseEvent.html">MouseEvent</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>
<p>
Definition at line <a class="el" href="OgreEventListeners_8h-source.html#l00104">104</a> of file <a class="el" href="OgreEventListeners_8h-source.html">OgreEventListeners.h</a>.
<p>
Referenced by <a class="el" href="OgreMouseTarget_8cpp-source.html#l00046">Ogre::MouseTarget::processMouseEvent</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1ScrollBarGuiElementa117" doxytag="Ogre::MouseListener::mouseDragEntered"></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::MouseListener::mouseDragEntered </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1MouseEvent.html">MouseEvent</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>
<p>
Definition at line <a class="el" href="OgreEventListeners_8h-source.html#l00102">102</a> of file <a class="el" href="OgreEventListeners_8h-source.html">OgreEventListeners.h</a>.
<p>
Referenced by <a class="el" href="OgreMouseTarget_8cpp-source.html#l00046">Ogre::MouseTarget::processMouseEvent</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1ScrollBarGuiElementa118" doxytag="Ogre::MouseListener::mouseDragExited"></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::MouseListener::mouseDragExited </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1MouseEvent.html">MouseEvent</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>
<p>
Definition at line <a class="el" href="OgreEventListeners_8h-source.html#l00103">103</a> of file <a class="el" href="OgreEventListeners_8h-source.html">OgreEventListeners.h</a>.
<p>
Referenced by <a class="el" href="OgreMouseTarget_8cpp-source.html#l00046">Ogre::MouseTarget::processMouseEvent</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1MouseListenera1" doxytag="Ogre::MouseListener::mouseEntered"></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::MouseListener::mouseEntered </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1MouseEvent.html">MouseEvent</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 mouse enters a component.
<p>
<p>
Implemented in <a class="el" href="classOgre_1_1EventMulticaster.html#Ogre_1_1EventMulticastera9">Ogre::EventMulticaster</a>, <a class="el" href="classOgre_1_1GuiPressable.html#Ogre_1_1PopupMenuGuiElementa122">Ogre::GuiPressable</a>, <a class="el" href="classOgre_1_1ListGuiElement.html#Ogre_1_1ListGuiElementa11">Ogre::ListGuiElement</a>, and <a class="el" href="classOgre_1_1ScrollBarGuiElement.html#Ogre_1_1ScrollBarGuiElementa18">Ogre::ScrollBarGuiElement</a>.
<p>
Referenced by <a class="el" href="OgreMouseTarget_8cpp-source.html#l00046">Ogre::MouseTarget::processMouseEvent</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1MouseListenera2" doxytag="Ogre::MouseListener::mouseExited"></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::MouseListener::mouseExited </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1MouseEvent.html">MouseEvent</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 mouse exits a component.
<p>
<p>
Implemented in <a class="el" href="classOgre_1_1EventMulticaster.html#Ogre_1_1EventMulticastera10">Ogre::EventMulticaster</a>, <a class="el" href="classOgre_1_1GuiPressable.html#Ogre_1_1PopupMenuGuiElementa123">Ogre::GuiPressable</a>, <a class="el" href="classOgre_1_1ListGuiElement.html#Ogre_1_1ListGuiElementa12">Ogre::ListGuiElement</a>, and <a class="el" href="classOgre_1_1ScrollBarGuiElement.html#Ogre_1_1ScrollBarGuiElementa19">Ogre::ScrollBarGuiElement</a>.
<p>
Referenced by <a class="el" href="OgreMouseTarget_8cpp-source.html#l00046">Ogre::MouseTarget::processMouseEvent</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1MouseListenera3" doxytag="Ogre::MouseListener::mousePressed"></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::MouseListener::mousePressed </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1MouseEvent.html">MouseEvent</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 mouse button has been pressed on a component.
<p>
<p>
Implemented in <a class="el" href="classOgre_1_1EventMulticaster.html#Ogre_1_1EventMulticastera12">Ogre::EventMulticaster</a>, <a class="el" href="classOgre_1_1GuiPressable.html#Ogre_1_1PopupMenuGuiElementa124">Ogre::GuiPressable</a>, <a class="el" href="classOgre_1_1ListGuiElement.html#Ogre_1_1ListGuiElementa13">Ogre::ListGuiElement</a>, and <a class="el" href="classOgre_1_1ScrollBarGuiElement.html#Ogre_1_1ScrollBarGuiElementa20">Ogre::ScrollBarGuiElement</a>.
<p>
Referenced by <a class="el" href="OgreMouseTarget_8cpp-source.html#l00046">Ogre::MouseTarget::processMouseEvent</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1MouseListenera4" doxytag="Ogre::MouseListener::mouseReleased"></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::MouseListener::mouseReleased </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1MouseEvent.html">MouseEvent</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 mouse button has been released on a component.
<p>
<p>
Implemented in <a class="el" href="classOgre_1_1EventMulticaster.html#Ogre_1_1EventMulticastera13">Ogre::EventMulticaster</a>, <a class="el" href="classOgre_1_1GuiPressable.html#Ogre_1_1PopupMenuGuiElementa125">Ogre::GuiPressable</a>, <a class="el" href="classOgre_1_1ListGuiElement.html#Ogre_1_1ListGuiElementa14">Ogre::ListGuiElement</a>, and <a class="el" href="classOgre_1_1ScrollBarGuiElement.html#Ogre_1_1ScrollBarGuiElementa21">Ogre::ScrollBarGuiElement</a>.
<p>
Referenced by <a class="el" href="OgreMouseTarget_8cpp-source.html#l00046">Ogre::MouseTarget::processMouseEvent</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:18:37 2004
</p>
</body>
</html>
