Event triggered when the keyboard key is pressed. More...

#include <KeyEvent.h>

Inheritance diagram for Karma::KeyPressedEvent:

[legend]

Collaboration diagram for Karma::KeyPressedEvent:

[legend]

Public Member Functions
	KeyPressedEvent (int keycode, int repeatCount)
	A constructor.

int	GetRepeatCount () const
	Getter for key repeat counter.

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.

Event *	GetObjPointer ()
	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 the keyboard key is pressed.

Constructor & Destructor Documentation

Karma::KeyPressedEvent::KeyPressedEvent	(	int	keycode,
		int	repeatCount )

inline

A constructor.

Parameters

keycode	GLFW defined key code for the key press event
repeatCount	Counter for key repeatition

int Karma::KeyPressedEvent::GetRepeatCount ( ) const

inline

Getter for key repeat counter.

std::string Karma::KeyPressedEvent::ToString ( ) const

inlineoverridevirtual

String representation of the event.

Reimplemented from Karma::Event.

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