CoriEngine
Loading...
Searching...
No Matches
Cori::Core::WindowCloseEvent Class Referencefinal

#include <AppEvent.hpp>

Inheritance diagram for Cori::Core::WindowCloseEvent:
Collaboration diagram for Cori::Core::WindowCloseEvent:

Public Member Functions

 WindowCloseEvent ()=default
std::string ToString () const override
 Returns the name of the Event.
constexpr std::type_index GetEventType () const override
 Gives the return type of the Event.
const char * GetName () const override
 This will give you the string version of EventType.
uint32_t GetCategoryFlags () const override
 Gives the flags of particular Event.
bool IsInCategory (const EventCategory category) const
 Checks if the Event is in specific category.

Public Attributes

bool m_Handled = false

Detailed Description

Definition at line 25 of file AppEvent.hpp.

Constructor & Destructor Documentation

◆ WindowCloseEvent()

Cori::Core::WindowCloseEvent::WindowCloseEvent ( )
default

Member Function Documentation

◆ GetCategoryFlags()

uint32_t Cori::Core::WindowCloseEvent::GetCategoryFlags ( ) const
inlineoverridevirtual

Gives the flags of particular Event.

Note
You shouldn't overload this, it is overloaded by EVENT_CLASS_CATEGORY macro!
Returns
Flag variable that stores all the relevant EventCategory flags.

Implements Cori::Core::Event.

Definition at line 34 of file AppEvent.hpp.

◆ GetEventType()

std::type_index Cori::Core::WindowCloseEvent::GetEventType ( ) const
inlineconstexproverridevirtual

Gives the return type of the Event.

Note
You shouldn't overload this, it is overloaded by EVENT_CLASS_TYPE macro!
Returns
Type index of derived event type.

Implements Cori::Core::Event.

Definition at line 33 of file AppEvent.hpp.

Here is the call graph for this function:

◆ GetName()

const char * Cori::Core::WindowCloseEvent::GetName ( ) const
inlineoverridevirtual

This will give you the string version of EventType.

Note
You shouldn't overload this, it is overloaded by EVENT_CLASS_TYPE macro!
Returns
EventType name.

Implements Cori::Core::Event.

Definition at line 33 of file AppEvent.hpp.

◆ IsInCategory()

bool Cori::Core::Event::IsInCategory ( const EventCategory category) const
inlinenodiscardinherited

Checks if the Event is in specific category.

Parameters
categoryBitmask that we need to check presence of.
Returns
True is present, false otherwise.

Definition at line 59 of file Event.hpp.

Here is the call graph for this function:

◆ ToString()

std::string Cori::Core::WindowCloseEvent::ToString ( ) const
inlinenodiscardoverridevirtual

Returns the name of the Event.

Note
This is up to the user to overload, by default return the same thing GetName() does.
Returns
Event name.

Reimplemented from Cori::Core::Event.

Definition at line 29 of file AppEvent.hpp.

Member Data Documentation

◆ m_Handled

bool Cori::Core::Event::m_Handled = false
inherited

Definition at line 63 of file Event.hpp.


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