Karma::Event Class Reference

The base class of all the events for Karma. More...

#include <Event.h>

Inheritance diagram for Karma::Event:

Public Member Functions
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)
virtual std::string	ToString () const
	String representation of the event.
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.

Protected Attributes
bool	m_Handled = false

Friends
class	EventDispatcher
	An event dispatching class.

Detailed Description

The base class of all the events for Karma.

Member Function Documentation

GetCategoryFlags()

virtual int Karma::Event::GetCategoryFlags ( ) const

pure virtual

Getter for category flags (enum EventCategory)

Since

Karma 1.0.0

GetEventType()

virtual EventType Karma::Event::GetEventType ( ) const

pure virtual

Getter for event name (type)

Since

Karma 1.0.0

GetName()

virtual const char * Karma::Event::GetName ( ) const

pure virtual

Getter for event type.

See also

EVENT_CLASS_TYPE

Since

Karma 1.0.0

GetObjPointer()

Event * Karma::Event::GetObjPointer ( )

inline

Getter for the pointer to the object.

Since

Karma 1.0.0

IsHandled()

bool Karma::Event::IsHandled ( ) const

inline

Getter for the m_Handled.

Since

Karma 1.0.0

IsInCategory()

bool Karma::Event::IsInCategory ( EventCategory category )

inline

Routine to see if the category of the Event is (or a part of) given category.

Since

Karma 1.0.0

ToString()

virtual std::string Karma::Event::ToString ( ) const

inlinevirtual

String representation of the event.

Since

Karma 1.0.0

Reimplemented in Karma::ControllerDeviceConnectedEvent, Karma::ControllerDeviceDisconnectedEvent, Karma::KeyPressedEvent, Karma::KeyReleasedEvent, Karma::KeyTypedEvent, Karma::MouseButtonPressedEvent, Karma::MouseButtonReleasedEvent, Karma::MouseMovedEvent, Karma::MouseScrolledEvent, and Karma::WindowResizeEvent.

Friends And Related Symbol Documentation

EventDispatcher

friend class EventDispatcher

friend

An event dispatching class.

Since

Karma 1.0.0

---

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

• Karma/src/Karma/Events/Event.h