carb::eventdispatcher¶
Namespace for carb.eventdispatcher.plugin and related utilities.
Classes¶
carb::eventdispatcher::EventData: Structure definition for event data. Typically not used; instead use the carb::eventdispatcher::Event wrapper-class.
carb::eventdispatcher::IEventDispatcher: Interface for carb.eventdispatcher.plugin.
carb::eventdispatcher::NamedVariant: Structure definition for a named variant: a key/value pair with a value of varying type.
carb::eventdispatcher::Event: A presentation class for carb::eventdispatcher::EventData. Allows querying the data via a simple C++ interface.
carb::eventdispatcher::ObserverGuard: Structure to manage the lifetime of an observer. Similar to
std::unique_ptr
.
Typedefs¶
carb::eventdispatcher::CleanupFn: Callback function called when an observer is terminated with IEventDispatcher::stopObserving(). Typically not manually used as it is generated by IEventDispatcher::observeEvent().
carb::eventdispatcher::Observer: A handle to an observer, registered with IEventDispatcher::observeEvent().
carb::eventdispatcher::ObserverFn: Callback function called when an event is dispatched. Typically not manually used as it is generated by IEventDispatcher::observeEvent().
Variables¶
carb::eventdispatcher::kInvalidObserver: Special value indicating an invalid observer.