---

Ogre::InputEvent Class Reference

The root event class for all GuiElement-level input events. More...

#include <OgreInputEvent.h>

Inheritance diagram for Ogre::InputEvent:

List of all members.

Public Types
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
	InputEvent (EventTarget *source, int id, long when, int modifiers)
	Constructs an InputEvent object with the specified source GuiElement, modifiers, and type. More...
void	consume ()
	Consumes this event so that it will not be processed in the default manner by the source which originated it. More...
int	getModifiers ()
	Returns the modifiers flag for this event. More...
Real	getWhen ()
	Returns the timestamp of when this event occurred. More...
bool	isAltDown ()
	Returns whether or not the Alt modifier is down on this event. More...
bool	isConsumed ()
	Returns whether or not this event has been consumed. More...
bool	isControlDown ()
	Returns whether or not the Control modifier is down on this event. More...
bool	isMetaDown ()
	Returns whether or not the Meta modifier is down on this event. More...
bool	isShiftDown ()
	Returns whether or not the Shift modifier is down on this event. More...
bool	isEventBetween (int start, int end)
int	getID ()
EventTarget *	getSource ()
Protected Attributes
Real	mWhen
	Not implemented yet. More...
int	mModifiers
	The state of the modifier keys at the time the input event was fired. More...
EventTarget *	mSource
	The target to process the event. More...
int	mId
	The ID of the event. More...
bool	mConsumed
	whether the event has been consumed. More...

---

Detailed Description

The root event class for all GuiElement-level input events.

Remarks:

Input events are delivered to listeners before they are processed normally by the source where they originated. This allows listeners and GuiElement 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 GuiElement will prevent the Button from being activated.

---

Member Enumeration Documentation

anonymous enum

Enumeration values: SHIFT_MASK  This flag indicates that the Shift key was down when the event occurred. CTRL_MASK  This flag indicates that the Control key was down when the event occurred. META_MASK  This flag indicates that the Meta key was down when the event occurred. For mouse events, this flag indicates that the right button was pressed or released. ALT_MASK  This flag indicates that the Alt key was down when the event occurred. For mouse events, this flag indicates that the middle mouse button was pressed or released. BUTTON0_MASK  BUTTON1_MASK  BUTTON2_MASK  BUTTON3_MASK  BUTTON_ANY_MASK

---

Constructor & Destructor Documentation

Ogre::InputEvent::InputEvent (  EventTarget *    source, int    id, long    when, int    modifiers )

Constructs an InputEvent object with the specified source GuiElement, modifiers, and type. Parameters: source  the object where the event originated @id the event type @when the time the event occurred @modifiers the modifier keys down while event occurred

---

Member Function Documentation

void Ogre::InputEvent::consume (    )

Consumes this event so that it will not be processed in the default manner by the source which originated it.

int Ogre::InputEvent::getID (    )

int Ogre::InputEvent::getModifiers (    )

Returns the modifiers flag for this event.

EventTarget * Ogre::InputEvent::getSource (    )

Real Ogre::InputEvent::getWhen (    )

Returns the timestamp of when this event occurred. Not implemented yet

bool Ogre::InputEvent::isAltDown (    )

Returns whether or not the Alt modifier is down on this event.

bool Ogre::InputEvent::isConsumed (    )

Returns whether or not this event has been consumed. See also: consume

bool Ogre::InputEvent::isControlDown (    )

Returns whether or not the Control modifier is down on this event.

bool Ogre::InputEvent::isEventBetween (  int    start, int    end )

bool Ogre::InputEvent::isMetaDown (    )

Returns whether or not the Meta modifier is down on this event.

bool Ogre::InputEvent::isShiftDown (    )

Returns whether or not the Shift modifier is down on this event.

---

Member Data Documentation

bool Ogre::InputEvent::mConsumed [protected]

whether the event has been consumed.

int Ogre::InputEvent::mId [protected]

The ID of the event.

int Ogre::InputEvent::mModifiers [protected]

The state of the modifier keys at the time the input event was fired.

EventTarget* Ogre::InputEvent::mSource [protected]

The target to process the event. This is ususally found by the dispatcher

Real Ogre::InputEvent::mWhen [protected]

Not implemented yet.

Copyright © 2002 by The OGRE Team