Sophie

Sophie

distrib > Mandriva > 10.0-com > i586 > by-pkgid > 06719cf03808e17ae6f0852ca1052dc2 > files > 2982

libogre1-devel-0.13.0-1mdk.i586.rpm

<html>
<head>
<title>Ogre::ScrollEvent 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> &nbsp; <a class="qindex" href="namespaces.html">Namespace List</a> &nbsp; <a class="qindex" href="hierarchy.html">Class Hierarchy</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="namespacemembers.html">Namespace Members</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="globals.html">File Members</a> &nbsp; <a class="qindex" href="pages.html">Related Pages</a> &nbsp; </center>
<hr><h1>Ogre::ScrollEvent  Class Reference</h1><code>#include &lt;<a class="el" href="OgreScrollEvent_8h-source.html">OgreScrollEvent.h</a>&gt;</code>
<p>
Inheritance diagram for Ogre::ScrollEvent:<p><center><img src="classOgre_1_1ScrollEvent__inherit__graph.png" border="0" usemap="#Ogre_1_1ScrollEvent__inherit__map" alt="Inheritance graph"></center>
<map name="Ogre_1_1ScrollEvent__inherit__map">
<area href="classOgre_1_1InputEvent.html" shape="rect" coords="9,36,119,17" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center>Collaboration diagram for Ogre::ScrollEvent:<p><center><img src="classOgre_1_1ScrollEvent__coll__graph.png" border="0" usemap="#Ogre_1_1ScrollEvent__coll__map" alt="Collaboration graph"></center>
<map name="Ogre_1_1ScrollEvent__coll__map">
<area href="classOgre_1_1InputEvent.html" shape="rect" coords="12,126,121,108" alt="">
<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_1ScrollEvent-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 &nbsp;</td><td valign=bottom>{ <a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEvents3Ogre_1_1ScrollEvents0">SE_SCROLL_FIRST</a> =  2001, 
<a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEvents3Ogre_1_1ScrollEvents1">SE_SCROLL_LAST</a> =  2001
 }</td></tr>
<tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom>{ <a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEvents4Ogre_1_1ScrollEvents2">SE_SCROLL_PERFORMED</a> =  SE_SCROLL_FIRST
 }</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>This event id indicates that a meaningful Scroll occured.</em> <a href="#Ogre_1_1ScrollEvents4">More...</a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>enum &nbsp;</td><td valign=bottom>{ <br>
&nbsp;&nbsp;<a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents5">SHIFT_MASK</a> =  1 &lt;&lt; 0, 
<a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents6">CTRL_MASK</a> =  1 &lt;&lt; 1, 
<a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents7">META_MASK</a> =  1 &lt;&lt; 2, 
<a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents8">ALT_MASK</a> =  1 &lt;&lt; 3, 
<br>
&nbsp;&nbsp;<a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents9">BUTTON0_MASK</a> =  1 &lt;&lt; 4, 
<a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents10">BUTTON1_MASK</a> =  1 &lt;&lt; 5, 
<a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents11">BUTTON2_MASK</a> =  1 &lt;&lt; 6, 
<a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents12">BUTTON3_MASK</a> =  1 &lt;&lt; 7, 
<br>
&nbsp;&nbsp;<a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEvents14Ogre_1_1ScrollEvents13">BUTTON_ANY_MASK</a> =  0x1111 &lt;&lt; 4
<br>
 }</td></tr>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<tr><td nowrap align=right valign=top>&nbsp;</td><td valign=bottom><a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEventa0">ScrollEvent</a> (<a class="el" href="classOgre_1_1ScrollTarget.html">ScrollTarget</a> *source, int id, <a class="el" href="namespaceOgre.html#a349">Real</a> when, int modifiers, size_t topVisible, size_t range, size_t total)</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Constructs a <a class="el" href="classOgre_1_1ScrollEvent.html">ScrollEvent</a> object with the specified source <a class="el" href="classOgre_1_1GuiElement.html">GuiElement</a>,.</em> <a href="#Ogre_1_1ScrollEventa0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>size_t&nbsp;</td><td valign=bottom><a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEventa1">getTopVisible</a> () const</td></tr>
<tr><td nowrap align=right valign=top>size_t&nbsp;</td><td valign=bottom><a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEventa2">getRange</a> () const</td></tr>
<tr><td nowrap align=right valign=top>size_t&nbsp;</td><td valign=bottom><a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEventa3">getTotal</a> () const</td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="classOgre_1_1String.html">String</a>&nbsp;</td><td valign=bottom><a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEventa4">paramString</a> () const</td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>Returns a parameter string identifying this Scroll event.</em> <a href="#Ogre_1_1ScrollEventa4"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>void&nbsp;</td><td valign=bottom><a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEventa5">consume</a> ()</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEventa6">getModifiers</a> () const</td></tr>
<tr><td>&nbsp;</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>&nbsp;</td><td valign=bottom><a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEventa7">getWhen</a> () const</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEventa8">isAltDown</a> () const</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEventa9">isConsumed</a> () const</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEventa10">isControlDown</a> () const</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEventa11">isMetaDown</a> () const</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEventa12">isShiftDown</a> () const</td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEventa13">isEventBetween</a> (int start, int end) const</td></tr>
<tr><td nowrap align=right valign=top>int&nbsp;</td><td valign=bottom><a class="el" href="classOgre_1_1ScrollEvent.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> *&nbsp;</td><td valign=bottom><a class="el" href="classOgre_1_1ScrollEvent.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>size_t&nbsp;</td><td valign=bottom><a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEventn0">mTopVisible</a></td></tr>
<tr><td>&nbsp;</td><td><font size=-1><em>The nonlocalized string that gives more details.</em> <a href="#Ogre_1_1ScrollEventn0"></a><em></em></font><br><br></td></tr>
<tr><td nowrap align=right valign=top>size_t&nbsp;</td><td valign=bottom><a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEventn1">mRange</a></td></tr>
<tr><td nowrap align=right valign=top>size_t&nbsp;</td><td valign=bottom><a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEventn2">mTotal</a></td></tr>
<tr><td nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a349">Real</a>&nbsp;</td><td valign=bottom><a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEventn3">mWhen</a></td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEventn4">mModifiers</a></td></tr>
<tr><td>&nbsp;</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> *&nbsp;</td><td valign=bottom><a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEventn5">mSource</a></td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEventn6">mId</a></td></tr>
<tr><td>&nbsp;</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&nbsp;</td><td valign=bottom><a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEventn7">mConsumed</a></td></tr>
<tr><td>&nbsp;</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><h2>Member Enumeration Documentation</h2>
<a name="Ogre_1_1ScrollEvents3" doxytag="Ogre::ScrollEvent::@16"></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>
      &nbsp;
    </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_1ScrollEvents3Ogre_1_1ScrollEvents0" doxytag="SE_SCROLL_FIRST"></a><em>SE_SCROLL_FIRST</em></em>&nbsp;</td><td>
The first number in the range of ids used for Scroll events.</td></tr>
<tr><td valign=top><em><a name="Ogre_1_1ScrollEvents3Ogre_1_1ScrollEvents1" doxytag="SE_SCROLL_LAST"></a><em>SE_SCROLL_LAST</em></em>&nbsp;</td><td>
The last number in the range of ids used for Scroll events.</td></tr>
</table>
</dl>

<p>
Definition at line <a class="el" href="OgreScrollEvent_8h-source.html#l00155">155</a> of file <a class="el" href="OgreScrollEvent_8h-source.html">OgreScrollEvent.h</a>.    </td>
  </tr>
</table>
<a name="Ogre_1_1ScrollEvents4" doxytag="Ogre::ScrollEvent::@17"></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>
      &nbsp;
    </td>
    <td>

<p>
This event id indicates that a meaningful Scroll occured.
<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_1ScrollEvents4Ogre_1_1ScrollEvents2" doxytag="SE_SCROLL_PERFORMED"></a><em>SE_SCROLL_PERFORMED</em></em>&nbsp;</td><td>
</td></tr>
</table>
</dl>

<p>
Definition at line <a class="el" href="OgreScrollEvent_8h-source.html#l00187">187</a> of file <a class="el" href="OgreScrollEvent_8h-source.html">OgreScrollEvent.h</a>.    </td>
  </tr>
</table>
<a name="Ogre_1_1ScrollEvents14" doxytag="Ogre::ScrollEvent::@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<code> [inherited]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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>&nbsp;</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>&nbsp;</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>&nbsp;</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>&nbsp;</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>&nbsp;</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>&nbsp;</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>&nbsp;</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>&nbsp;</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>&nbsp;</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 &amp; Destructor Documentation</h2>
<a name="Ogre_1_1ScrollEventa0" doxytag="Ogre::ScrollEvent::ScrollEvent"></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::ScrollEvent::ScrollEvent </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1ScrollTarget.html">ScrollTarget</a> *&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>source</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>int&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>id</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap><a class="el" href="namespaceOgre.html#a349">Real</a>&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>when</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>int&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>modifiers</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>size_t&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>topVisible</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>size_t&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>range</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>size_t&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>total</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Constructs a <a class="el" href="classOgre_1_1ScrollEvent.html">ScrollEvent</a> object with the specified source <a class="el" href="classOgre_1_1GuiElement.html">GuiElement</a>,.
<p>
type, modifiers, coordinates, and click count.<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>source</em>&nbsp;</td><td>
the <a class="el" href="classOgre_1_1GuiElement.html">GuiElement</a> that originated the event</td></tr>
<tr><td valign=top><em>id</em>&nbsp;</td><td>
the integer that identifies the event</td></tr>
<tr><td valign=top><em>when</em>&nbsp;</td><td>
a long int that gives the time the event occurred</td></tr>
<tr><td valign=top><em>modifiers</em>&nbsp;</td><td>
the modifier keys down during event</td></tr>
</table>
</dl>(shift, ctrl, alt, meta)<dl compact><dt><b>
Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>x</em>&nbsp;</td><td>
the horizontal x coordinate for the mouse location</td></tr>
<tr><td valign=top><em>y</em>&nbsp;</td><td>
the vertical y coordinate for the mouse location</td></tr>
<tr><td valign=top><em>ScrollCommand</em>&nbsp;</td><td>
The nonlocalized string that gives more details</td></tr>
</table>
</dl>of what actually caused the event. 
<p>
Definition at line <a class="el" href="OgreScrollEvent_8cpp-source.html#l00036">36</a> of file <a class="el" href="OgreScrollEvent_8cpp-source.html">OgreScrollEvent.cpp</a>.
<p>
References <a class="el" href="OgrePrerequisites_8h-source.html#l00086">Ogre::Real</a>.    </td>
  </tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a name="Ogre_1_1ScrollEventa5" doxytag="Ogre::ScrollEvent::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">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap><code> [inherited]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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">Ogre::InputEvent::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::ScrollEvent::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">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap> const<code> [inherited]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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">Ogre::InputEvent::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::ScrollEvent::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">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap> const<code> [inherited]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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">Ogre::InputEvent::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_1ScrollEventa2" doxytag="Ogre::ScrollEvent::getRange"></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"> size_t Ogre::ScrollEvent::getRange </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap> const</td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>

<p>
Definition at line <a class="el" href="OgreScrollEvent_8cpp-source.html#l00052">52</a> of file <a class="el" href="OgreScrollEvent_8cpp-source.html">OgreScrollEvent.cpp</a>.
<p>
References <a class="el" href="OgreScrollEvent_8h-source.html#l00143">mRange</a>.    </td>
  </tr>
</table>
<a name="Ogre_1_1ScrollEventa15" doxytag="Ogre::ScrollEvent::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">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap> const<code> [inherited]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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">Ogre::InputEvent::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_1ScrollEventa1" doxytag="Ogre::ScrollEvent::getTopVisible"></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"> size_t Ogre::ScrollEvent::getTopVisible </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap> const</td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>

<p>
Definition at line <a class="el" href="OgreScrollEvent_8cpp-source.html#l00046">46</a> of file <a class="el" href="OgreScrollEvent_8cpp-source.html">OgreScrollEvent.cpp</a>.
<p>
References <a class="el" href="OgreScrollEvent_8h-source.html#l00141">mTopVisible</a>.
<p>
Referenced by <a class="el" href="OgreTTYGuiElement_8cpp-source.html#l00210">Ogre::TTYGuiElement::scrollPerformed</a>(), and <a class="el" href="OgreListGuiElement_8cpp-source.html#l00402">Ogre::ListGuiElement::scrollPerformed</a>().    </td>
  </tr>
</table>
<a name="Ogre_1_1ScrollEventa3" doxytag="Ogre::ScrollEvent::getTotal"></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"> size_t Ogre::ScrollEvent::getTotal </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap> const</td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>

<p>
Definition at line <a class="el" href="OgreScrollEvent_8cpp-source.html#l00059">59</a> of file <a class="el" href="OgreScrollEvent_8cpp-source.html">OgreScrollEvent.cpp</a>.
<p>
References <a class="el" href="OgreScrollEvent_8h-source.html#l00145">mTotal</a>.    </td>
  </tr>
</table>
<a name="Ogre_1_1ScrollEventa7" doxytag="Ogre::ScrollEvent::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">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap> const<code> [inherited]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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">Ogre::InputEvent::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::ScrollEvent::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">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap> const<code> [inherited]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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">Ogre::InputEvent::mModifiers</a>.    </td>
  </tr>
</table>
<a name="Ogre_1_1ScrollEventa9" doxytag="Ogre::ScrollEvent::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">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap> const<code> [inherited]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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">Ogre::InputEvent::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::ScrollEvent::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">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap> const<code> [inherited]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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">Ogre::InputEvent::mModifiers</a>.    </td>
  </tr>
</table>
<a name="Ogre_1_1ScrollEventa13" doxytag="Ogre::ScrollEvent::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">(&nbsp;</td>
          <td class="md" nowrap valign="top">int&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>start</em>, </td>
        </tr>
        <tr>
          <td></td>
          <td></td>
          <td class="md" nowrap>int&nbsp;</td>
          <td class="mdname" nowrap>&nbsp; <em>end</em></td>
        </tr>
        <tr>
          <td></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"> const<code> [inherited]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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">Ogre::InputEvent::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::ScrollEvent::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">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap> const<code> [inherited]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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">Ogre::InputEvent::mModifiers</a>.    </td>
  </tr>
</table>
<a name="Ogre_1_1ScrollEventa12" doxytag="Ogre::ScrollEvent::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">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap> const<code> [inherited]</code></td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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">Ogre::InputEvent::mModifiers</a>.    </td>
  </tr>
</table>
<a name="Ogre_1_1ScrollEventa4" doxytag="Ogre::ScrollEvent::paramString"></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_1String.html">String</a> Ogre::ScrollEvent::paramString </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="mdname1" valign="top" nowrap>&nbsp;          </td>
          <td class="md" valign="top">)&nbsp;</td>
          <td class="md" nowrap> const</td>
        </tr>

      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
Returns a parameter string identifying this Scroll event.
<p>
This method is useful for event-logging and for debugging.
<p>
<dl compact><dt><b>
Returns: </b><dd>
a string identifying the event and its associated command </dl>
<p>
Definition at line <a class="el" href="OgreScrollEvent_8cpp-source.html#l00065">65</a> of file <a class="el" href="OgreScrollEvent_8cpp-source.html">OgreScrollEvent.cpp</a>.
<p>
References <a class="el" href="OgreScrollEvent_8h-source.html#l00143">mRange</a>, <a class="el" href="OgreScrollEvent_8h-source.html#l00141">mTopVisible</a>, <a class="el" href="OgreScrollEvent_8h-source.html#l00145">mTotal</a>, and <a class="el" href="classOgre_1_1ScrollEvent.html#Ogre_1_1ScrollEvents4Ogre_1_1ScrollEvents2">SE_SCROLL_PERFORMED</a>.    </td>
  </tr>
</table>
<hr><h2>Member Data Documentation</h2>
<a name="Ogre_1_1ScrollEventn7" doxytag="Ogre::ScrollEvent::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, inherited]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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">Ogre::InputEvent::consume</a>(), <a class="el" href="OgreInputEvent_8cpp-source.html#l00033">Ogre::InputEvent::InputEvent</a>(), and <a class="el" href="OgreInputEvent_8cpp-source.html#l00063">Ogre::InputEvent::isConsumed</a>().    </td>
  </tr>
</table>
<a name="Ogre_1_1ScrollEventn6" doxytag="Ogre::ScrollEvent::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, inherited]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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">Ogre::InputEvent::getID</a>(), and <a class="el" href="OgreInputEvent_8cpp-source.html#l00083">Ogre::InputEvent::isEventBetween</a>().    </td>
  </tr>
</table>
<a name="Ogre_1_1ScrollEventn4" doxytag="Ogre::ScrollEvent::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, inherited]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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">Ogre::InputEvent::getModifiers</a>(), <a class="el" href="OgreInputEvent_8cpp-source.html#l00058">Ogre::InputEvent::isAltDown</a>(), <a class="el" href="OgreInputEvent_8cpp-source.html#l00068">Ogre::InputEvent::isControlDown</a>(), <a class="el" href="OgreInputEvent_8cpp-source.html#l00073">Ogre::InputEvent::isMetaDown</a>(), and <a class="el" href="OgreInputEvent_8cpp-source.html#l00078">Ogre::InputEvent::isShiftDown</a>().    </td>
  </tr>
</table>
<a name="Ogre_1_1ScrollEventn1" doxytag="Ogre::ScrollEvent::mRange"></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"> size_t Ogre::ScrollEvent::mRange<code> [protected]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>

<p>
Definition at line <a class="el" href="OgreScrollEvent_8h-source.html#l00143">143</a> of file <a class="el" href="OgreScrollEvent_8h-source.html">OgreScrollEvent.h</a>.
<p>
Referenced by <a class="el" href="OgreScrollEvent_8cpp-source.html#l00052">getRange</a>(), and <a class="el" href="OgreScrollEvent_8cpp-source.html#l00065">paramString</a>().    </td>
  </tr>
</table>
<a name="Ogre_1_1ScrollEventn5" doxytag="Ogre::ScrollEvent::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, inherited]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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">Ogre::InputEvent::getSource</a>().    </td>
  </tr>
</table>
<a name="Ogre_1_1ScrollEventn0" doxytag="Ogre::ScrollEvent::mTopVisible"></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"> size_t Ogre::ScrollEvent::mTopVisible<code> [protected]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
The nonlocalized string that gives more details.
<p>
of what actually caused the event.
<p>
This information is very specific to the component
<p>
that fired it. 
<p>
Definition at line <a class="el" href="OgreScrollEvent_8h-source.html#l00141">141</a> of file <a class="el" href="OgreScrollEvent_8h-source.html">OgreScrollEvent.h</a>.
<p>
Referenced by <a class="el" href="OgreScrollEvent_8cpp-source.html#l00046">getTopVisible</a>(), and <a class="el" href="OgreScrollEvent_8cpp-source.html#l00065">paramString</a>().    </td>
  </tr>
</table>
<a name="Ogre_1_1ScrollEventn2" doxytag="Ogre::ScrollEvent::mTotal"></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"> size_t Ogre::ScrollEvent::mTotal<code> [protected]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>

<p>
Definition at line <a class="el" href="OgreScrollEvent_8h-source.html#l00145">145</a> of file <a class="el" href="OgreScrollEvent_8h-source.html">OgreScrollEvent.h</a>.
<p>
Referenced by <a class="el" href="OgreScrollEvent_8cpp-source.html#l00059">getTotal</a>(), and <a class="el" href="OgreScrollEvent_8cpp-source.html#l00065">paramString</a>().    </td>
  </tr>
</table>
<a name="Ogre_1_1ScrollEventn3" doxytag="Ogre::ScrollEvent::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, inherited]</code>
      </table>
    </td>
  </tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
  <tr>
    <td>
      &nbsp;
    </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">Ogre::InputEvent::getWhen</a>().    </td>
  </tr>
</table>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="OgreScrollEvent_8h-source.html">OgreScrollEvent.h</a><li><a class="el" href="OgreScrollEvent_8cpp-source.html">OgreScrollEvent.cpp</a></ul>
<p>
Copyright &copy; 2002-2003 by The OGRE Team<br />
Last modified Wed Jan 21 00:20:19 2004
</p>
</body>
</html>