<html>
<head>
<title>Ogre::InputEvent 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::InputEvent Class Reference</h1>The root event class for all <a class="el" href="classOgre_1_1GuiElement.html">GuiElement</a>-level input events.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="OgreInputEvent_8h-source.html">OgreInputEvent.h</a>></code>
<p>
Inheritance diagram for Ogre::InputEvent:<p><center><img src="classOgre_1_1InputEvent__inherit__graph.png" border="0" usemap="#Ogre_1_1InputEvent__inherit__map" alt="Inheritance graph"></center>
<map name="Ogre_1_1InputEvent__inherit__map">
<area href="classOgre_1_1ActionEvent.html" shape="rect" coords="197,24,315,5" alt="">
<area href="classOgre_1_1KeyEvent.html" shape="rect" coords="204,66,308,48" alt="">
<area href="classOgre_1_1ListSelectionEvent.html" shape="rect" coords="177,109,335,90" alt="">
<area href="classOgre_1_1MouseEvent.html" shape="rect" coords="196,152,316,133" alt="">
<area href="classOgre_1_1ScrollEvent.html" shape="rect" coords="199,194,313,176" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for Ogre::InputEvent:<p><center><img src="classOgre_1_1InputEvent__coll__graph.png" border="0" usemap="#Ogre_1_1InputEvent__coll__map" alt="Collaboration graph"></center>
<map name="Ogre_1_1InputEvent__coll__map">
<area href="classOgre_1_1EventTarget.html" shape="rect" coords="7,36,127,17" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classOgre_1_1InputEvent-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
<tr><td nowrap align=right valign=top>enum </td><td valign=bottom>{ <br>
<a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents5">SHIFT_MASK</a> = 1 << 0,
<a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents6">CTRL_MASK</a> = 1 << 1,
<a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents7">META_MASK</a> = 1 << 2,
<a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents8">ALT_MASK</a> = 1 << 3,
<br>
<a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents9">BUTTON0_MASK</a> = 1 << 4,
<a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents10">BUTTON1_MASK</a> = 1 << 5,
<a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents11">BUTTON2_MASK</a> = 1 << 6,
<a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents12">BUTTON3_MASK</a> = 1 << 7,
<br>
<a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents13">BUTTON_ANY_MASK</a> = 0x1111 << 4
<br>
}</td></tr>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top> </td><td valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1InputEventa0">InputEvent</a> (<a class="el" href="classOgre_1_1EventTarget.html">EventTarget</a> *source, int id, long when, int modifiers)</td></tr>
<tr><td> </td><td><font size=-1><em>Constructs an <a class="el" href="classOgre_1_1InputEvent.html">InputEvent</a> object with the specified source <a class="el" href="classOgre_1_1GuiElement.html">GuiElement</a>, modifiers, and type.</em> <a href="#Ogre_1_1InputEventa0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void </td><td valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1ScrollEventa5">consume</a> ()</td></tr>
<tr><td> </td><td><font size=-1><em>Consumes this event so that it will not be processed in the default manner by the source which originated it.</em> <a href="#Ogre_1_1ScrollEventa5"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1ScrollEventa6">getModifiers</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns the modifiers flag for this event.</em> <a href="#Ogre_1_1ScrollEventa6"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a349">Real</a> </td><td valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1ScrollEventa7">getWhen</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns the timestamp of when this event occurred.</em> <a href="#Ogre_1_1ScrollEventa7"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1ScrollEventa8">isAltDown</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns whether or not the Alt modifier is down on this event.</em> <a href="#Ogre_1_1ScrollEventa8"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1ScrollEventa9">isConsumed</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns whether or not this event has been consumed.</em> <a href="#Ogre_1_1ScrollEventa9"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1ScrollEventa10">isControlDown</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns whether or not the Control modifier is down on this event.</em> <a href="#Ogre_1_1ScrollEventa10"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1ScrollEventa11">isMetaDown</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns whether or not the Meta modifier is down on this event.</em> <a href="#Ogre_1_1ScrollEventa11"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1ScrollEventa12">isShiftDown</a> () const</td></tr>
<tr><td> </td><td><font size=-1><em>Returns whether or not the Shift modifier is down on this event.</em> <a href="#Ogre_1_1ScrollEventa12"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1ScrollEventa13">isEventBetween</a> (int start, int end) const</td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1ScrollEventa14">getID</a> () const</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1EventTarget.html">EventTarget</a> * </td><td valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1ScrollEventa15">getSource</a> () const</td></tr>
<tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a349">Real</a> </td><td valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1ScrollEventn3">mWhen</a></td></tr>
<tr><td> </td><td><font size=-1><em>Not implemented yet.</em> <a href="#Ogre_1_1ScrollEventn3"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1ScrollEventn4">mModifiers</a></td></tr>
<tr><td> </td><td><font size=-1><em>The state of the modifier keys at the time the input event was fired.</em> <a href="#Ogre_1_1ScrollEventn4"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1EventTarget.html">EventTarget</a> * </td><td valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1ScrollEventn5">mSource</a></td></tr>
<tr><td> </td><td><font size=-1><em>The target to process the event.</em> <a href="#Ogre_1_1ScrollEventn5"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>int </td><td valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1ScrollEventn6">mId</a></td></tr>
<tr><td> </td><td><font size=-1><em>The ID of the event.</em> <a href="#Ogre_1_1ScrollEventn6"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>bool </td><td valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1ScrollEventn7">mConsumed</a></td></tr>
<tr><td> </td><td><font size=-1><em>whether the event has been consumed</em> <a href="#Ogre_1_1ScrollEventn7"></a><em></em></font><br><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
The root event class for all <a class="el" href="classOgre_1_1GuiElement.html">GuiElement</a>-level input events.
<p>
<dl compact><dt><b>
Remarks: </b><dd>
Input events are delivered to listeners before they are processed normally by the source where they originated. This allows listeners and <a class="el" href="classOgre_1_1GuiElement.html">GuiElement</a> subclasses to "consume" the event so that the source will not process them in their default manner. For example, consuming mousePressed events on a Button <a class="el" href="classOgre_1_1GuiElement.html">GuiElement</a> will prevent the Button from being activated. </dl>
<p>
<p>
Definition at line <a class="el" href="OgreInputEvent_8h-source.html#l00060">60</a> of file <a class="el" href="OgreInputEvent_8h-source.html">OgreInputEvent.h</a>.<hr><h2>Member Enumeration Documentation</h2>
<a name="Ogre_1_1ScrollEvents14" doxytag="Ogre::InputEvent::@7"></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"> anonymous enum
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
<dl compact><dt><b>
Enumeration values:</b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em><a name="Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents5" doxytag="SHIFT_MASK"></a><em>SHIFT_MASK</em></em> </td><td>
This flag indicates that the Shift key was down when the event occurred.</td></tr>
<tr><td valign=top><em><a name="Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents6" doxytag="CTRL_MASK"></a><em>CTRL_MASK</em></em> </td><td>
This flag indicates that the Control key was down when the event occurred.</td></tr>
<tr><td valign=top><em><a name="Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents7" doxytag="META_MASK"></a><em>META_MASK</em></em> </td><td>
This flag indicates that the Meta key was down when the event occurred.
<p>
For mouse events, this flag indicates that the right button was pressed or released. </td></tr>
<tr><td valign=top><em><a name="Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents8" doxytag="ALT_MASK"></a><em>ALT_MASK</em></em> </td><td>
This flag indicates that the Alt key was down when the event occurred.
<p>
For mouse events, this flag indicates that the middle mouse button was pressed or released. </td></tr>
<tr><td valign=top><em><a name="Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents9" doxytag="BUTTON0_MASK"></a><em>BUTTON0_MASK</em></em> </td><td>
</td></tr>
<tr><td valign=top><em><a name="Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents10" doxytag="BUTTON1_MASK"></a><em>BUTTON1_MASK</em></em> </td><td>
</td></tr>
<tr><td valign=top><em><a name="Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents11" doxytag="BUTTON2_MASK"></a><em>BUTTON2_MASK</em></em> </td><td>
</td></tr>
<tr><td valign=top><em><a name="Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents12" doxytag="BUTTON3_MASK"></a><em>BUTTON3_MASK</em></em> </td><td>
</td></tr>
<tr><td valign=top><em><a name="Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents13" doxytag="BUTTON_ANY_MASK"></a><em>BUTTON_ANY_MASK</em></em> </td><td>
</td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="OgreInputEvent_8h-source.html#l00093">93</a> of file <a class="el" href="OgreInputEvent_8h-source.html">OgreInputEvent.h</a>. </td>
</tr>
</table>
<hr><h2>Constructor & Destructor Documentation</h2>
<a name="Ogre_1_1InputEventa0" doxytag="Ogre::InputEvent::InputEvent"></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"> Ogre::InputEvent::InputEvent </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1EventTarget.html">EventTarget</a> * </td>
<td class="mdname" nowrap> <em>source</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>id</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>long </td>
<td class="mdname" nowrap> <em>when</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>modifiers</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Constructs an <a class="el" href="classOgre_1_1InputEvent.html">InputEvent</a> object with the specified source <a class="el" href="classOgre_1_1GuiElement.html">GuiElement</a>, modifiers, and type.
<p>
<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>source</em> </td><td>
the object where the event originated @id the event type @when the time the event occurred @modifiers the modifier keys down while event occurred </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="OgreInputEvent_8cpp-source.html#l00033">33</a> of file <a class="el" href="OgreInputEvent_8cpp-source.html">OgreInputEvent.cpp</a>.
<p>
References <a class="el" href="OgreInputEvent_8h-source.html#l00088">mConsumed</a>. </td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="Ogre_1_1ScrollEventa5" doxytag="Ogre::InputEvent::consume"></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"> void Ogre::InputEvent::consume </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top">) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Consumes this event so that it will not be processed in the default manner by the source which originated it.
<p>
<p>
Definition at line <a class="el" href="OgreInputEvent_8cpp-source.html#l00043">43</a> of file <a class="el" href="OgreInputEvent_8cpp-source.html">OgreInputEvent.cpp</a>.
<p>
References <a class="el" href="OgreInputEvent_8h-source.html#l00088">mConsumed</a>.
<p>
Referenced by <a class="el" href="OgreEventDispatcher_8cpp-source.html#l00155">Ogre::EventDispatcher::retargetMouseEvent</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1ScrollEventa14" doxytag="Ogre::InputEvent::getID"></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"> int Ogre::InputEvent::getID </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</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="OgreInputEvent_8cpp-source.html#l00089">89</a> of file <a class="el" href="OgreInputEvent_8cpp-source.html">OgreInputEvent.cpp</a>.
<p>
References <a class="el" href="OgreInputEvent_8h-source.html#l00083">mId</a>.
<p>
Referenced by <a class="el" href="OgreActionTarget_8cpp-source.html#l00045">Ogre::ActionTarget::processActionEvent</a>(), <a class="el" href="OgreTextBoxGuiElement_8cpp-source.html#l00224">Ogre::TextBoxGuiElement::processEvent</a>(), <a class="el" href="OgreScrollBarGuiElement_8cpp-source.html#l00280">Ogre::ScrollBarGuiElement::processEvent</a>(), <a class="el" href="OgreOverlayManager_8cpp-source.html#l00567">Ogre::OverlayManager::processEvent</a>(), <a class="el" href="OgreGuiElement_8cpp-source.html#l00549">Ogre::GuiElement::processEvent</a>(), <a class="el" href="OgreGuiControl_8cpp-source.html#l00045">Ogre::GuiControl::processEvent</a>(), <a class="el" href="OgreEventProcessor_8cpp-source.html#l00152">Ogre::EventProcessor::processEvent</a>(), <a class="el" href="OgreCursor_8cpp-source.html#l00087">Ogre::Cursor::processEvent</a>(), <a class="el" href="OgreKeyTarget_8cpp-source.html#l00044">Ogre::KeyTarget::processKeyEvent</a>(), <a class="el" href="OgreMouseTarget_8cpp-source.html#l00046">Ogre::MouseTarget::processMouseEvent</a>(), <a class="el" href="OgreEventDispatcher_8cpp-source.html#l00093">Ogre::EventDispatcher::processMouseEvent</a>(), <a class="el" href="OgreMouseMotionTarget_8cpp-source.html#l00044">Ogre::MouseMotionTarget::processMouseMotionEvent</a>(), <a class="el" href="OgreScrollTarget_8cpp-source.html#l00045">Ogre::ScrollTarget::processScrollEvent</a>(), and <a class="el" href="OgreEventDispatcher_8cpp-source.html#l00155">Ogre::EventDispatcher::retargetMouseEvent</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1ScrollEventa6" doxytag="Ogre::InputEvent::getModifiers"></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"> int Ogre::InputEvent::getModifiers </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</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns the modifiers flag for this event.
<p>
<p>
Definition at line <a class="el" href="OgreInputEvent_8cpp-source.html#l00048">48</a> of file <a class="el" href="OgreInputEvent_8cpp-source.html">OgreInputEvent.cpp</a>.
<p>
References <a class="el" href="OgreInputEvent_8h-source.html#l00072">mModifiers</a>.
<p>
Referenced by <a class="el" href="OgreMouseEvent_8cpp-source.html#l00109">Ogre::MouseEvent::paramString</a>(), <a class="el" href="OgreEventDispatcher_8cpp-source.html#l00204">Ogre::EventDispatcher::retargetKeyEvent</a>(), and <a class="el" href="OgreEventDispatcher_8cpp-source.html#l00155">Ogre::EventDispatcher::retargetMouseEvent</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1ScrollEventa15" doxytag="Ogre::InputEvent::getSource"></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"> <a class="el" href="classOgre_1_1EventTarget.html">EventTarget</a> * Ogre::InputEvent::getSource </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</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="OgreInputEvent_8cpp-source.html#l00095">95</a> of file <a class="el" href="OgreInputEvent_8cpp-source.html">OgreInputEvent.cpp</a>.
<p>
References <a class="el" href="OgreInputEvent_8h-source.html#l00078">mSource</a>.
<p>
Referenced by <a class="el" href="OgreScrollBarGuiElement_8cpp-source.html#l00316">Ogre::ScrollBarGuiElement::mousePressed</a>(), and <a class="el" href="OgreListGuiElement_8cpp-source.html#l00530">Ogre::ListGuiElement::mousePressed</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1ScrollEventa7" doxytag="Ogre::InputEvent::getWhen"></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"> <a class="el" href="namespaceOgre.html#a349">Real</a> Ogre::InputEvent::getWhen </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</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns the timestamp of when this event occurred.
<p>
Not implemented yet
<p>
Definition at line <a class="el" href="OgreInputEvent_8cpp-source.html#l00053">53</a> of file <a class="el" href="OgreInputEvent_8cpp-source.html">OgreInputEvent.cpp</a>.
<p>
References <a class="el" href="OgreInputEvent_8h-source.html#l00067">mWhen</a>, and <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>.
<p>
Referenced by <a class="el" href="OgreEventDispatcher_8cpp-source.html#l00204">Ogre::EventDispatcher::retargetKeyEvent</a>(), and <a class="el" href="OgreEventDispatcher_8cpp-source.html#l00155">Ogre::EventDispatcher::retargetMouseEvent</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1ScrollEventa8" doxytag="Ogre::InputEvent::isAltDown"></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"> bool Ogre::InputEvent::isAltDown </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</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns whether or not the Alt modifier is down on this event.
<p>
<p>
Definition at line <a class="el" href="OgreInputEvent_8cpp-source.html#l00058">58</a> of file <a class="el" href="OgreInputEvent_8cpp-source.html">OgreInputEvent.cpp</a>.
<p>
References <a class="el" href="OgreInputEvent_8h-source.html#l00072">mModifiers</a>. </td>
</tr>
</table>
<a name="Ogre_1_1ScrollEventa9" doxytag="Ogre::InputEvent::isConsumed"></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"> bool Ogre::InputEvent::isConsumed </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</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns whether or not this event has been consumed.
<p>
<dl compact><dt><b>
See also: </b><dd>
<a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1ScrollEventa5">consume</a> </dl>
<p>
Definition at line <a class="el" href="OgreInputEvent_8cpp-source.html#l00063">63</a> of file <a class="el" href="OgreInputEvent_8cpp-source.html">OgreInputEvent.cpp</a>.
<p>
References <a class="el" href="OgreInputEvent_8h-source.html#l00088">mConsumed</a>.
<p>
Referenced by <a class="el" href="OgreTextBoxGuiElement_8cpp-source.html#l00224">Ogre::TextBoxGuiElement::processEvent</a>(), <a class="el" href="OgreScrollBarGuiElement_8cpp-source.html#l00280">Ogre::ScrollBarGuiElement::processEvent</a>(), <a class="el" href="OgreGuiElement_8cpp-source.html#l00549">Ogre::GuiElement::processEvent</a>(), <a class="el" href="OgreGuiControl_8cpp-source.html#l00045">Ogre::GuiControl::processEvent</a>(), <a class="el" href="OgreEventProcessor_8cpp-source.html#l00152">Ogre::EventProcessor::processEvent</a>(), <a class="el" href="OgreEventDispatcher_8cpp-source.html#l00083">Ogre::EventDispatcher::processKeyEvent</a>(), and <a class="el" href="OgreEventDispatcher_8cpp-source.html#l00093">Ogre::EventDispatcher::processMouseEvent</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1ScrollEventa10" doxytag="Ogre::InputEvent::isControlDown"></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"> bool Ogre::InputEvent::isControlDown </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</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns whether or not the Control modifier is down on this event.
<p>
<p>
Definition at line <a class="el" href="OgreInputEvent_8cpp-source.html#l00068">68</a> of file <a class="el" href="OgreInputEvent_8cpp-source.html">OgreInputEvent.cpp</a>.
<p>
References <a class="el" href="OgreInputEvent_8h-source.html#l00072">mModifiers</a>. </td>
</tr>
</table>
<a name="Ogre_1_1ScrollEventa13" doxytag="Ogre::InputEvent::isEventBetween"></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"> bool Ogre::InputEvent::isEventBetween </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">int </td>
<td class="mdname" nowrap> <em>start</em>, </td>
</tr>
<tr>
<td></td>
<td></td>
<td class="md" nowrap>int </td>
<td class="mdname" nowrap> <em>end</em></td>
</tr>
<tr>
<td></td>
<td class="md">) </td>
<td class="md" colspan="2"> const</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="OgreInputEvent_8cpp-source.html#l00083">83</a> of file <a class="el" href="OgreInputEvent_8cpp-source.html">OgreInputEvent.cpp</a>.
<p>
References <a class="el" href="OgreInputEvent_8h-source.html#l00083">mId</a>.
<p>
Referenced by <a class="el" href="OgreEventDispatcher_8cpp-source.html#l00058">Ogre::EventDispatcher::dispatchEvent</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1ScrollEventa11" doxytag="Ogre::InputEvent::isMetaDown"></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"> bool Ogre::InputEvent::isMetaDown </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</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns whether or not the Meta modifier is down on this event.
<p>
<p>
Definition at line <a class="el" href="OgreInputEvent_8cpp-source.html#l00073">73</a> of file <a class="el" href="OgreInputEvent_8cpp-source.html">OgreInputEvent.cpp</a>.
<p>
References <a class="el" href="OgreInputEvent_8h-source.html#l00072">mModifiers</a>. </td>
</tr>
</table>
<a name="Ogre_1_1ScrollEventa12" doxytag="Ogre::InputEvent::isShiftDown"></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"> bool Ogre::InputEvent::isShiftDown </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</td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Returns whether or not the Shift modifier is down on this event.
<p>
<p>
Definition at line <a class="el" href="OgreInputEvent_8cpp-source.html#l00078">78</a> of file <a class="el" href="OgreInputEvent_8cpp-source.html">OgreInputEvent.cpp</a>.
<p>
References <a class="el" href="OgreInputEvent_8h-source.html#l00072">mModifiers</a>. </td>
</tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="Ogre_1_1ScrollEventn7" doxytag="Ogre::InputEvent::mConsumed"></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"> bool Ogre::InputEvent::mConsumed<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
whether the event has been consumed
<p>
<p>
Definition at line <a class="el" href="OgreInputEvent_8h-source.html#l00088">88</a> of file <a class="el" href="OgreInputEvent_8h-source.html">OgreInputEvent.h</a>.
<p>
Referenced by <a class="el" href="OgreInputEvent_8cpp-source.html#l00043">consume</a>(), <a class="el" href="OgreInputEvent_8cpp-source.html#l00033">InputEvent</a>(), and <a class="el" href="OgreInputEvent_8cpp-source.html#l00063">isConsumed</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1ScrollEventn6" doxytag="Ogre::InputEvent::mId"></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"> int Ogre::InputEvent::mId<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The ID of the event.
<p>
<p>
Definition at line <a class="el" href="OgreInputEvent_8h-source.html#l00083">83</a> of file <a class="el" href="OgreInputEvent_8h-source.html">OgreInputEvent.h</a>.
<p>
Referenced by <a class="el" href="OgreInputEvent_8cpp-source.html#l00089">getID</a>(), and <a class="el" href="OgreInputEvent_8cpp-source.html#l00083">isEventBetween</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1ScrollEventn4" doxytag="Ogre::InputEvent::mModifiers"></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"> int Ogre::InputEvent::mModifiers<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The state of the modifier keys at the time the input event was fired.
<p>
<p>
Definition at line <a class="el" href="OgreInputEvent_8h-source.html#l00072">72</a> of file <a class="el" href="OgreInputEvent_8h-source.html">OgreInputEvent.h</a>.
<p>
Referenced by <a class="el" href="OgreKeyEvent_8cpp-source.html#l00048">Ogre::KeyEvent::getKeyChar</a>(), <a class="el" href="OgreInputEvent_8cpp-source.html#l00048">getModifiers</a>(), <a class="el" href="OgreInputEvent_8cpp-source.html#l00058">isAltDown</a>(), <a class="el" href="OgreInputEvent_8cpp-source.html#l00068">isControlDown</a>(), <a class="el" href="OgreInputEvent_8cpp-source.html#l00073">isMetaDown</a>(), and <a class="el" href="OgreInputEvent_8cpp-source.html#l00078">isShiftDown</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1ScrollEventn5" doxytag="Ogre::InputEvent::mSource"></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"> <a class="el" href="classOgre_1_1EventTarget.html">EventTarget</a>* Ogre::InputEvent::mSource<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
The target to process the event.
<p>
This is ususally found by the dispatcher
<p>
Definition at line <a class="el" href="OgreInputEvent_8h-source.html#l00078">78</a> of file <a class="el" href="OgreInputEvent_8h-source.html">OgreInputEvent.h</a>.
<p>
Referenced by <a class="el" href="OgreInputEvent_8cpp-source.html#l00095">getSource</a>(). </td>
</tr>
</table>
<a name="Ogre_1_1ScrollEventn3" doxytag="Ogre::InputEvent::mWhen"></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"> <a class="el" href="namespaceOgre.html#a349">Real</a> Ogre::InputEvent::mWhen<code> [protected]</code>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
</td>
<td>
<p>
Not implemented yet.
<p>
<p>
Definition at line <a class="el" href="OgreInputEvent_8h-source.html#l00067">67</a> of file <a class="el" href="OgreInputEvent_8h-source.html">OgreInputEvent.h</a>.
<p>
Referenced by <a class="el" href="OgreInputEvent_8cpp-source.html#l00053">getWhen</a>(). </td>
</tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="OgreInputEvent_8h-source.html">OgreInputEvent.h</a><li><a class="el" href="OgreInputEvent_8cpp-source.html">OgreInputEvent.cpp</a></ul>
<p>
Copyright © 2002-2003 by The OGRE Team<br />
Last modified Wed Jan 21 00:17:56 2004
</p>
</body>
</html>
distrib
>
Mandriva
>
10.0
>
i586
>
media
>
contrib
>
by-pkgid
>
06719cf03808e17ae6f0852ca1052dc2
>
files
>
2404
