ph::editor::Event Class Reference

Base of all event types. Derived classes should strive to keep the size of the object small, as event objects are often passed by value for thread safety and ease of lifetime management, or being captured by functors. The type should also remain trivially-copyable. More...

#include <Event.h>

Inheritance diagram for ph::editor::Event:

Public Member Functions
void	consume ()
bool	isConsumed () const

Protected Member Functions
	PH_DEFINE_INLINE_RULE_OF_5_MEMBERS (Event)

Detailed Description

Base of all event types. Derived classes should strive to keep the size of the object small, as event objects are often passed by value for thread safety and ease of lifetime management, or being captured by functors. The type should also remain trivially-copyable.

Member Function Documentation

consume()

void ph::editor::Event::consume ( )

inline

isConsumed()

bool ph::editor::Event::isConsumed ( ) const

inline

PH_DEFINE_INLINE_RULE_OF_5_MEMBERS()

ph::editor::Event::PH_DEFINE_INLINE_RULE_OF_5_MEMBERS ( Event )

protected

---

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

• Source/EditorCore/Event/Event.h