#include <OgreScrollEvent.h>
Inheritance diagram for Ogre::ScrollEvent:
Public Types | |
enum | { SE_SCROLL_FIRST = 2001, SE_SCROLL_LAST = 2001 } |
enum | { SE_SCROLL_PERFORMED = SE_SCROLL_FIRST } |
This event id indicates that a meaningful Scroll occured. More... | |
enum | { SHIFT_MASK = 1 << 0, CTRL_MASK = 1 << 1, META_MASK = 1 << 2, ALT_MASK = 1 << 3, BUTTON0_MASK = 1 << 4, BUTTON1_MASK = 1 << 5, BUTTON2_MASK = 1 << 6, BUTTON3_MASK = 1 << 7, BUTTON_ANY_MASK = 0x1111 << 4 } |
Public Methods | |
ScrollEvent (ScrollTarget *source, int id, Real when, int modifiers, size_t topVisible, size_t range, size_t total) | |
Constructs a ScrollEvent object with the specified source GuiElement,. | |
size_t | getTopVisible () const |
size_t | getRange () const |
size_t | getTotal () const |
String | paramString () const |
Returns a parameter string identifying this Scroll event. | |
void | consume () |
Consumes this event so that it will not be processed in the default manner by the source which originated it. | |
int | getModifiers () const |
Returns the modifiers flag for this event. | |
Real | getWhen () const |
Returns the timestamp of when this event occurred. | |
bool | isAltDown () const |
Returns whether or not the Alt modifier is down on this event. | |
bool | isConsumed () const |
Returns whether or not this event has been consumed. | |
bool | isControlDown () const |
Returns whether or not the Control modifier is down on this event. | |
bool | isMetaDown () const |
Returns whether or not the Meta modifier is down on this event. | |
bool | isShiftDown () const |
Returns whether or not the Shift modifier is down on this event. | |
bool | isEventBetween (int start, int end) const |
int | getID () const |
EventTarget * | getSource () const |
Protected Attributes | |
size_t | mTopVisible |
The nonlocalized string that gives more details. | |
size_t | mRange |
size_t | mTotal |
Real | mWhen |
Not implemented yet. | |
int | mModifiers |
The state of the modifier keys at the time the input event was fired. | |
EventTarget * | mSource |
The target to process the event. | |
int | mId |
The ID of the event. | |
bool | mConsumed |
whether the event has been consumed |
|
Definition at line 155 of file OgreScrollEvent.h. |
|
This event id indicates that a meaningful Scroll occured.
Definition at line 187 of file OgreScrollEvent.h. |
|
Definition at line 93 of file OgreInputEvent.h. |
|
Constructs a ScrollEvent object with the specified source GuiElement,. type, modifiers, coordinates, and click count.
Definition at line 36 of file OgreScrollEvent.cpp. References Ogre::Real. |
|
Consumes this event so that it will not be processed in the default manner by the source which originated it.
Definition at line 43 of file OgreInputEvent.cpp. References Ogre::InputEvent::mConsumed. Referenced by Ogre::EventDispatcher::retargetMouseEvent(). |
|
|
Returns the modifiers flag for this event.
Definition at line 48 of file OgreInputEvent.cpp. References Ogre::InputEvent::mModifiers. Referenced by Ogre::MouseEvent::paramString(), Ogre::EventDispatcher::retargetKeyEvent(), and Ogre::EventDispatcher::retargetMouseEvent(). |
|
Definition at line 52 of file OgreScrollEvent.cpp. References mRange. |
|
Definition at line 95 of file OgreInputEvent.cpp. References Ogre::InputEvent::mSource. Referenced by Ogre::ScrollBarGuiElement::mousePressed(), and Ogre::ListGuiElement::mousePressed(). |
|
Definition at line 46 of file OgreScrollEvent.cpp. References mTopVisible. Referenced by Ogre::TTYGuiElement::scrollPerformed(), and Ogre::ListGuiElement::scrollPerformed(). |
|
Definition at line 59 of file OgreScrollEvent.cpp. References mTotal. |
|
Returns the timestamp of when this event occurred. Not implemented yet Definition at line 53 of file OgreInputEvent.cpp. References Ogre::InputEvent::mWhen, and Ogre::Real. Referenced by Ogre::EventDispatcher::retargetKeyEvent(), and Ogre::EventDispatcher::retargetMouseEvent(). |
|
Returns whether or not the Alt modifier is down on this event.
Definition at line 58 of file OgreInputEvent.cpp. References Ogre::InputEvent::mModifiers. |
|
Returns whether or not this event has been consumed.
Definition at line 63 of file OgreInputEvent.cpp. References Ogre::InputEvent::mConsumed. Referenced by Ogre::TextBoxGuiElement::processEvent(), Ogre::ScrollBarGuiElement::processEvent(), Ogre::GuiElement::processEvent(), Ogre::GuiControl::processEvent(), Ogre::EventProcessor::processEvent(), Ogre::EventDispatcher::processKeyEvent(), and Ogre::EventDispatcher::processMouseEvent(). |
|
Returns whether or not the Control modifier is down on this event.
Definition at line 68 of file OgreInputEvent.cpp. References Ogre::InputEvent::mModifiers. |
|
Definition at line 83 of file OgreInputEvent.cpp. References Ogre::InputEvent::mId. Referenced by Ogre::EventDispatcher::dispatchEvent(). |
|
Returns whether or not the Meta modifier is down on this event.
Definition at line 73 of file OgreInputEvent.cpp. References Ogre::InputEvent::mModifiers. |
|
Returns whether or not the Shift modifier is down on this event.
Definition at line 78 of file OgreInputEvent.cpp. References Ogre::InputEvent::mModifiers. |
|
Returns a parameter string identifying this Scroll event. This method is useful for event-logging and for debugging.
Definition at line 65 of file OgreScrollEvent.cpp. References mRange, mTopVisible, mTotal, and SE_SCROLL_PERFORMED. |
|
whether the event has been consumed
Definition at line 88 of file OgreInputEvent.h. Referenced by Ogre::InputEvent::consume(), Ogre::InputEvent::InputEvent(), and Ogre::InputEvent::isConsumed(). |
|
The ID of the event.
Definition at line 83 of file OgreInputEvent.h. Referenced by Ogre::InputEvent::getID(), and Ogre::InputEvent::isEventBetween(). |
|
The state of the modifier keys at the time the input event was fired.
Definition at line 72 of file OgreInputEvent.h. Referenced by Ogre::KeyEvent::getKeyChar(), Ogre::InputEvent::getModifiers(), Ogre::InputEvent::isAltDown(), Ogre::InputEvent::isControlDown(), Ogre::InputEvent::isMetaDown(), and Ogre::InputEvent::isShiftDown(). |
|
Definition at line 143 of file OgreScrollEvent.h. Referenced by getRange(), and paramString(). |
|
The target to process the event. This is ususally found by the dispatcher Definition at line 78 of file OgreInputEvent.h. Referenced by Ogre::InputEvent::getSource(). |
|
The nonlocalized string that gives more details. of what actually caused the event. This information is very specific to the component that fired it. Definition at line 141 of file OgreScrollEvent.h. Referenced by getTopVisible(), and paramString(). |
|
Definition at line 145 of file OgreScrollEvent.h. Referenced by getTotal(), and paramString(). |
|
Not implemented yet.
Definition at line 67 of file OgreInputEvent.h. Referenced by Ogre::InputEvent::getWhen(). |
Copyright © 2002-2003 by The OGRE Team
Last modified Wed Jan 21 00:20:19 2004