Sirikata::Input::EventResponse Class Reference

Defines the set of return values for an EventListener. More...

#include <InputListener.hpp>

Collaboration diagram for Sirikata::Input::EventResponse:

List of all members.

Public Member Functions
bool	operator== (const EventResponse &other)
bool	operator!= (const EventResponse &other)
Static Public Member Functions
static EventResponse	nop ()
	the event listener will be called again, and event stays on the queue.
static EventResponse	del ()
	Never call this function again (One-shot listener).
static EventResponse	cancel ()
	Take the event off the queue after this stage (EARLY,MIDDLE,LATE)
static EventResponse	cancelAndDel ()
	Kill the listener and kill the event (probably not useful).
Private Types
enum	{ NOP, DELETE_LISTENER = 1, CANCEL_EVENT = 2, DELETE_LISTENER_AND_CANCEL_EVENT = DELETE_LISTENER | CANCEL_EVENT }
Private Attributes
enum Sirikata::Input::EventResponse:: { ... }	mResp
Friends
class	EventManager

---

Detailed Description

Defines the set of return values for an EventListener.

An acceptable value includes the bitwise or of any values in the enum.

---

Member Enumeration Documentation

anonymous enum [private]

Enumerator:

NOP
DELETE_LISTENER
CANCEL_EVENT
DELETE_LISTENER_AND_CANCEL_EVENT

---

Member Function Documentation

static EventResponse Sirikata::Input::EventResponse::cancel

(

)

[inline, static]

Take the event off the queue after this stage (EARLY,MIDDLE,LATE)

References mResp.

Referenced by Sirikata::Graphics::OgreSystemInputHandler::DelegateInputListener::onAxisEvent(), Sirikata::Graphics::OgreSystemInputHandler::onAxisEvent(), Sirikata::Graphics::OgreSystemInputHandler::WebViewInputListener::onAxisEvent(), Sirikata::Graphics::WebViewManager::onButton(), Sirikata::Graphics::OgreSystemInputHandler::DelegateInputListener::onInputDeviceEvent(), Sirikata::Graphics::OgreSystemInputHandler::DelegateInputListener::onKeyDownEvent(), Sirikata::Graphics::OgreSystemInputHandler::onKeyDownEvent(), Sirikata::Graphics::OgreSystemInputHandler::DelegateInputListener::onKeyPressedEvent(), Sirikata::Graphics::OgreSystemInputHandler::onKeyPressedEvent(), Sirikata::Graphics::OgreSystemInputHandler::DelegateInputListener::onKeyReleasedEvent(), Sirikata::Graphics::OgreSystemInputHandler::onKeyReleasedEvent(), Sirikata::Graphics::OgreSystemInputHandler::DelegateInputListener::onKeyRepeatedEvent(), Sirikata::Graphics::OgreSystemInputHandler::onKeyRepeatedEvent(), Sirikata::Graphics::WebViewManager::onKeyTextInput(), Sirikata::Graphics::WebViewManager::onMouseClick(), Sirikata::Graphics::OgreSystemInputHandler::DelegateInputListener::onMouseClickEvent(), Sirikata::Graphics::OgreSystemInputHandler::onMouseClickEvent(), Sirikata::Graphics::OgreSystemInputHandler::WebViewInputListener::onMouseClickEvent(), Sirikata::Graphics::WebViewManager::onMouseDrag(), Sirikata::Graphics::OgreSystemInputHandler::DelegateInputListener::onMouseDragEvent(), Sirikata::Graphics::OgreSystemInputHandler::onMouseDragEvent(), Sirikata::Graphics::OgreSystemInputHandler::DelegateInputListener::onMouseHoverEvent(), Sirikata::Graphics::OgreSystemInputHandler::onMouseHoverEvent(), Sirikata::Graphics::WebViewManager::onMousePressed(), Sirikata::Graphics::OgreSystemInputHandler::DelegateInputListener::onMousePressedEvent(), Sirikata::Graphics::OgreSystemInputHandler::onMousePressedEvent(), Sirikata::Graphics::OgreSystemInputHandler::WebViewInputListener::onMousePressedEvent(), Sirikata::Graphics::WebViewManager::onMouseReleased(), Sirikata::Graphics::OgreSystemInputHandler::DelegateInputListener::onMouseReleasedEvent(), Sirikata::Graphics::OgreSystemInputHandler::onMouseReleasedEvent(), Sirikata::Graphics::OgreSystemInputHandler::DelegateInputListener::onTextInputEvent(), Sirikata::Graphics::OgreSystemInputHandler::onTextInputEvent(), Sirikata::Graphics::OgreSystemInputHandler::DelegateInputListener::onWebViewEvent(), and Sirikata::Graphics::OgreSystemInputHandler::onWebViewEvent().

static EventResponse Sirikata::Input::EventResponse::cancelAndDel

(

)

[inline, static]

Kill the listener and kill the event (probably not useful).

References mResp.

static EventResponse Sirikata::Input::EventResponse::del

(

)

[inline, static]

Never call this function again (One-shot listener).

References mResp.

static EventResponse Sirikata::Input::EventResponse::nop

(

)

[inline, static]

the event listener will be called again, and event stays on the queue.

References mResp.

Referenced by Sirikata::Graphics::OgreSystemInputHandler::WebViewInputListener::onAxisEvent(), Sirikata::Input::InputListener::onAxisEvent(), Sirikata::Graphics::WebViewManager::onButton(), Sirikata::Input::InputListener::onDragAndDropEvent(), Sirikata::Graphics::OgreSystemInputHandler::WebViewInputListener::onInputDeviceEvent(), Sirikata::Graphics::OgreSystemInputHandler::onInputDeviceEvent(), Sirikata::Input::InputListener::onInputDeviceEvent(), Sirikata::Input::InputListener::onKeyDownEvent(), Sirikata::Input::InputListener::onKeyPressedEvent(), Sirikata::Input::InputListener::onKeyReleasedEvent(), Sirikata::Input::InputListener::onKeyRepeatedEvent(), Sirikata::Graphics::WebViewManager::onKeyTextInput(), Sirikata::Graphics::WebViewManager::onMouseClick(), Sirikata::Input::InputListener::onMouseClickEvent(), Sirikata::Graphics::WebViewManager::onMouseDrag(), Sirikata::Graphics::OgreSystemInputHandler::onMouseDragEvent(), Sirikata::Graphics::OgreSystemInputHandler::WebViewInputListener::onMouseDragEvent(), Sirikata::Input::InputListener::onMouseDragEvent(), Sirikata::Graphics::WebViewManager::onMouseHover(), Sirikata::Input::InputListener::onMouseHoverEvent(), Sirikata::Graphics::WebViewManager::onMousePressed(), Sirikata::Input::InputListener::onMousePressedEvent(), Sirikata::Graphics::WebViewManager::onMouseReleased(), Sirikata::Input::InputListener::onMouseReleasedEvent(), Sirikata::Input::InputListener::onTextInputEvent(), Sirikata::Graphics::OgreSystemInputHandler::WebViewInputListener::onWebViewEvent(), Sirikata::Input::InputListener::onWebViewEvent(), and Sirikata::Input::InputListener::onWindowEvent().

bool Sirikata::Input::EventResponse::operator!=

(

const EventResponse &

other

)

[inline]

References mResp.

bool Sirikata::Input::EventResponse::operator==

(

const EventResponse &

other

)

[inline]

References mResp.

---

Friends And Related Function Documentation

friend class EventManager [friend]

---

Member Data Documentation

enum { ... } Sirikata::Input::EventResponse::mResp [private]

Referenced by cancel(), cancelAndDel(), del(), nop(), operator!=(), and operator==().

---

The documentation for this class was generated from the following file:

• libogre/include/sirikata/ogre/input/InputListener.hpp