omni::event
NAME

omni::event

A class of omni

#include <omni/delegate/0.hpp>
class omni::event

MEMBERS

omni::event::event()
omni::event::~event()
void omni::event::attach(const omni::delegate< Ret >& d)
template < class T, ret_t (T::*fnptr)() const > void omni::event::attach_const(const T& obj)
void omni::event::clear()
bool omni::event::contains(const omni::delegate< Ret >& d)
template < class T, ret_t (T::*fnptr)() const > bool omni::event::contains_const(const T& obj)
void omni::event::detach(const omni::delegate< Ret >& d)
void omni::event::detach_all(const omni::delegate< Ret >& d)
template < class T, ret_t (T::*fnptr)() const > void omni::event::detach_const(const T& obj)
bool omni::event::empty()
container_t omni::event::invocation_list()
ret_t omni::event::invoke()
ret_t omni::event::invoke_direct()
void omni::event::swap(event< Ret >& e)
ret_t omni::event::operator()
omni::event::operator bool()
bool omni::event::operator!()
bool omni::event::operator!=(const event< Ret >& e)
event< Ret > omni::event::operator+(const omni::delegate< Ret >& d)
event< Ret >& omni::event::operator+=(const omni::delegate< Ret >& d)
event< Ret > omni::event::operator-(const omni::delegate< Ret >& d)
event< Ret >& omni::event::operator-=(const omni::delegate< Ret >& d)
event< Ret >& omni::event::operator=(const event< Ret >& e)
bool omni::event::operator==(const event< Ret >& e)
omni::delegate< Ret >& omni::event::operator[](std::size_t idx)
omni::event::const_iterator_t
omni::event::const_reverse_iterator_t
omni::event::container_t
omni::event::delegate_t
omni::event::iterator_t
omni::event::ret_t
omni::event::reverse_iterator_t

SYNOPSIS

The event class is a type of multicast delegate.

top

DESCRIPTION

Events are a type of multi-cast delegate that allows client code to attach multiple handlers of various classes, structs and anonymous functions, to a single event handler. As long as each target method is signature compatable with the underlying delegate type, classes and structs of various types can be attached to the same event object.

Invoking an event will invoke each attached handler (delegate) in the order they have been attached.

top

PARAMETERS

Ret - Specifies the return type of the delegates to be attached

top