GL Studio C++ Runtime API
StandardInputHandler Class Reference

#include <standard_input_handler.h>

Inheritance diagram for StandardInputHandler:
InputHandler

Public Member Functions

 StandardInputHandler (DisplayFrame *displayFrame)
 
virtual ~StandardInputHandler ()
 Destructor.
 
DisplayObject * HandleInput (DisplayEvent *ev) override
 
ID RegisterGlobalKeyboardHandler (KeyboardCallbackBase *callback) override
 
ID RegisterGlobalMouseHandler (MouseCallbackBase *callback) override
 
void UnregisterGlobalKeyboardHandler (ID id) override
 
void UnregisterGlobalMouseHandler (ID id) override
 
- Public Member Functions inherited from InputHandler
virtual DisplayObject * HandleInput (DisplayEvent *ev)=0
 
virtual ID RegisterGlobalKeyboardHandler (KeyboardCallbackBase *callback)=0
 
virtual ID RegisterGlobalMouseHandler (MouseCallbackBase *callback)=0
 
virtual void UnregisterGlobalKeyboardHandler (ID id)=0
 
virtual void UnregisterGlobalMouseHandler (ID id)=0
 
virtual ~InputHandler ()
 

Protected Types

typedef std::vector< std::pair< ID, KeyboardCallbackBase * > > KeyboardHandlerList
 Registered keyboard callbacks paired with their unique IDs.
 
typedef std::vector< std::pair< ID, MouseCallbackBase * > > MouseHandlerList
 Registered mouse callbacks paired with their unique IDs.
 

Protected Attributes

DisplayFrame * _displayFrame
 The display frame that events are routed through.
 
ID _nextID
 The ID that will be handed out to the next registered handler.
 
KeyboardHandlerList _globalKeyboardHandlers
 The registered global keyboard handlers.
 
MouseHandlerList _globalMouseHandlers
 The registered global mouse handlers.
 

Additional Inherited Members

- Public Types inherited from InputHandler
typedef unsigned int ID
 Type for unique identifiers.
 

Detailed Description

Standard implementation of InputHandler that provides:

Constructor & Destructor Documentation

◆ StandardInputHandler()

StandardInputHandler ( DisplayFrame *  displayFrame)
explicit

Constructor

Parameters
displayFrameThe DisplayFrame this handler is attached to

Member Function Documentation

◆ HandleInput()

DisplayObject * HandleInput ( DisplayEvent *  ev)
overridevirtual

Handle the event

Parameters
evThe event to handle
Returns
The object that handled the event, or NULL if no object handled the event

Implements InputHandler.

◆ RegisterGlobalKeyboardHandler()

ID RegisterGlobalKeyboardHandler ( KeyboardCallbackBase *  callback)
overridevirtual

Register a global keyboard handler

Parameters
callbackThe callback to call when a keyboard event occurs (ownership transferred)
Returns
Unique ID for unregistering

Implements InputHandler.

◆ RegisterGlobalMouseHandler()

ID RegisterGlobalMouseHandler ( MouseCallbackBase *  callback)
overridevirtual

Register a global mouse handler

Parameters
callbackThe callback to call when a mouse event occurs (ownership transferred)
Returns
Unique ID for unregistering

Implements InputHandler.

◆ UnregisterGlobalKeyboardHandler()

void UnregisterGlobalKeyboardHandler ( ID  id)
overridevirtual

Unregister a global keyboard handler

Parameters
idThe unique identifier returned from RegisterGlobalKeyboardHandler

Implements InputHandler.

◆ UnregisterGlobalMouseHandler()

void UnregisterGlobalMouseHandler ( ID  id)
overridevirtual

Unregister a global mouse handler

Parameters
idThe unique identifier returned from RegisterGlobalMouseHandler

Implements InputHandler.


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