SpiecsEngine
 
Loading...
Searching...
No Matches
Spices::KeyEvent Class Referenceabstract

This Class is inherited from Event Class. Inherit from it and create specific KeyEvent class. More...

#include <KeyEvent.h>

Inheritance diagram for Spices::KeyEvent:
Spices::Event Spices::KeyPressedEvent Spices::KeyReleasedEvent Spices::KeyTypedEvent

Public Types

using EventCallbackFn = std::function<void(Event&)>
 Helper type of Function pointer.
 

Public Member Functions

virtual ~KeyEvent () override=default
 Destructor Function.
 
const int & GetKeyCode () const
 Get Key Input Code.
 
virtual EventType GetEventType () const =0
 Event Information Function, must be implemented by EVENT_CLASS_TYPE and EVENT_CLASS_CATEGORY.
 
virtual const char * GetName () const =0
 
virtual int GetCategoryFlags () const =0
 
virtual std::string ToString () const
 
bool IsInCategory (EventCategory category) const
 Judgement if a given category is contained by this event class.
 

Static Public Member Functions

static EventCallbackFn GetEventCallbackFn ()
 Get Global Root Event Function Pointer.
 
static void SetEventCallbackFn (const EventCallbackFn &callback)
 Set Global Root Event Function Pointer.
 

Public Attributes

bool Handled = false
 True if this event is handled.
 

Protected Member Functions

 KeyEvent (int keycode)
 Specific this Class Category with EventCategoryKeyboard and EventCategoryInput.
 

Protected Attributes

int m_KeyCode
 Input KeyCode.
 

Detailed Description

This Class is inherited from Event Class. Inherit from it and create specific KeyEvent class.

Definition at line 17 of file KeyEvent.h.


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