Nui
Public Types | Public Member Functions | Static Public Attributes | List of all members
Nui::EventContext Class Reference

This object can be copied with low cost. More...

#include <event_context.hpp>

Public Types

using EventIdType = EventRegistry::EventIdType
 

Public Member Functions

 EventContext ()
 
 EventContext (EventContext const &)=default
 
 EventContext (EventContext &&)=default
 
EventContextoperator= (EventContext const &)=default
 
EventContextoperator= (EventContext &&)=default
 
 ~EventContext ()=default
 
EventIdType registerEvent (Event event)
 
auto activateEvent (EventIdType id)
 
auto activateAfterEffect (EventIdType id)
 
void executeActiveEventsImmediately ()
 
void executeEvent (EventIdType id)
 
EventIdType registerAfterEffect (Event event)
 
void cleanInvalidEvents ()
 
void removeAfterEffect (EventIdType id)
 
void reset ()
 

Static Public Attributes

constexpr static auto invalidEventId = EventRegistry::invalidEventId
 

Detailed Description

This object can be copied with low cost.

Member Typedef Documentation

◆ EventIdType

Constructor & Destructor Documentation

◆ EventContext() [1/3]

Nui::EventContext::EventContext ( )
inline

◆ EventContext() [2/3]

Nui::EventContext::EventContext ( EventContext const &  )
default

◆ EventContext() [3/3]

Nui::EventContext::EventContext ( EventContext &&  )
default

◆ ~EventContext()

Nui::EventContext::~EventContext ( )
default

Member Function Documentation

◆ activateAfterEffect()

auto Nui::EventContext::activateAfterEffect ( EventIdType  id)
inline

◆ activateEvent()

auto Nui::EventContext::activateEvent ( EventIdType  id)
inline

◆ cleanInvalidEvents()

void Nui::EventContext::cleanInvalidEvents ( )
inline

◆ executeActiveEventsImmediately()

void Nui::EventContext::executeActiveEventsImmediately ( )
inline

◆ executeEvent()

void Nui::EventContext::executeEvent ( EventIdType  id)
inline

◆ operator=() [1/2]

EventContext& Nui::EventContext::operator= ( EventContext &&  )
default

◆ operator=() [2/2]

EventContext& Nui::EventContext::operator= ( EventContext const &  )
default

◆ registerAfterEffect()

EventIdType Nui::EventContext::registerAfterEffect ( Event  event)
inline

◆ registerEvent()

EventIdType Nui::EventContext::registerEvent ( Event  event)
inline

◆ removeAfterEffect()

void Nui::EventContext::removeAfterEffect ( EventIdType  id)
inline

◆ reset()

void Nui::EventContext::reset ( )
inline

Member Data Documentation

◆ invalidEventId

constexpr static auto Nui::EventContext::invalidEventId = EventRegistry::invalidEventId
staticconstexpr

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