KarmaEngine
Game Engine for practical learning and research purposes
Loading...
Searching...
No Matches
Karma::KeyTypedEvent Class Reference

Event triggered when keyboard key is used in typing. More...

#include <KeyEvent.h>

Inheritance diagram for Karma::KeyTypedEvent:
Collaboration diagram for Karma::KeyTypedEvent:

Public Member Functions

 KeyTypedEvent (int keycode)
 A constructor.
 
std::string ToString () const override
 String representation of the event.
 
- Public Member Functions inherited from Karma::KeyEvent
int GetKeyCode () const
 Getter for key code of the keyboard event.
 
- Public Member Functions inherited from Karma::Event
virtual EventType GetEventType () const =0
 Getter for event name (type)
 
virtual const char * GetName () const =0
 Getter for event type.
 
virtual int GetCategoryFlags () const =0
 Getter for category flags (enum EventCategory)
 
bool IsInCategory (EventCategory category)
 Routine to see if the category of the Event is (or a part of) given category.
 
bool IsHandled () const
 Getter for the m_Handled.
 
EventGetObjPointer ()
 Getter for the pointer to the object.
 

Additional Inherited Members

- Protected Member Functions inherited from Karma::KeyEvent
 KeyEvent (int keycode)
 A constructor.
 
- Protected Attributes inherited from Karma::KeyEvent
int m_KeyCode
 
- Protected Attributes inherited from Karma::Event
bool m_Handled = false
 

Detailed Description

Event triggered when keyboard key is used in typing.

Constructor & Destructor Documentation

◆ KeyTypedEvent()

Karma::KeyTypedEvent::KeyTypedEvent ( int keycode)
inline

A constructor.

Parameters
keycodeGLFW defined key code
See also
https://www.glfw.org/docs/3.3/group__keys.html
Since
Karma 1.0.0

Member Function Documentation

◆ ToString()

std::string Karma::KeyTypedEvent::ToString ( ) const
inlineoverridevirtual

String representation of the event.

Since
Karma 1.0.0

Reimplemented from Karma::Event.


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