neoGFX
C++ GPU-oriented GUI library and app/game creation framework.
Classes | Public Member Functions | Friends | List of all members
neogfx::event< Arguments > Class Template Reference

#include <event.hpp>

Inheritance diagram for neogfx::event< Arguments >:
neolib::basic_lifetime< FlagListRepresentation > neolib::i_lifetime

Public Member Functions

 event ()
 
 event (const event &)
 
 ~event ()
 
event & operator= (const event &)
 
event_trigger_type trigger_type () const
 
void set_trigger_type (event_trigger_type aTriggerType)
 
template<class... Ts>
bool trigger (Ts &&... aArguments) const
 
template<class... Ts>
bool sync_trigger (Ts &&... aArguments) const
 
template<class... Ts>
void async_trigger (Ts &&... aArguments) const
 
void accept () const
 
void ignore () const
 
handle subscribe (const handler_callback &aHandlerCallback, const void *aUniqueId=0) const
 
handle operator() (const handler_callback &aHandlerCallback, const void *aUniqueId=0) const
 
template<typename T >
handle subscribe (const handler_callback &aHandlerCallback, const T *aUniqueIdObject) const
 
template<typename T >
handle operator() (const handler_callback &aHandlerCallback, const T *aUniqueIdObject) const
 
template<typename T >
handle subscribe (const handler_callback &aHandlerCallback, const T &aUniqueIdObject) const
 
template<typename T >
handle operator() (const handler_callback &aHandlerCallback, const T &aUniqueIdObject) const
 
void unsubscribe (const void *aUniqueId) const
 
template<typename T >
void unsubscribe (const T *aUniqueIdObject) const
 
template<typename T >
void unsubscribe (const T &aUniqueIdObject) const
 

Friends

class sink
 
class async_event_queue
 

Additional Inherited Members

- Protected Types inherited from neolib::basic_lifetime< FlagListRepresentation >
typedef neolib::destroyed_flag destroyed_flag
 
typedef flag_list_representation_type::flag_list flag_list
 
- Protected Member Functions inherited from neolib::basic_lifetime< FlagListRepresentation >
 basic_lifetime (enum class lifetime_state aState=lifetime_state::Alive)
 
virtual ~basic_lifetime ()
 
enum lifetime_state lifetime_state () const final
 
bool is_creating () const final
 
bool is_alive () const final
 
bool is_destroying () const final
 
bool is_destroyed () const final
 
void set_alive () override
 
void set_destroying () override
 
void set_destroyed () override
 
void add_flag (i_lifetime_flag *aFlag) const final
 
void remove_flag (i_lifetime_flag *aFlag) const final
 
- Protected Member Functions inherited from neolib::i_lifetime
virtual ~i_lifetime ()
 

Detailed Description

template<typename... Arguments>
class neogfx::event< Arguments >

Definition at line 36 of file event.hpp.

Constructor & Destructor Documentation

◆ event() [1/2]

template<typename... Arguments>
neogfx::event< Arguments >::event ( )
inline

Definition at line 146 of file event.hpp.

◆ event() [2/2]

template<typename... Arguments>
neogfx::event< Arguments >::event ( const event< Arguments > &  )
inline

Definition at line 149 of file event.hpp.

◆ ~event()

template<typename... Arguments>
neogfx::event< Arguments >::~event ( )
inline

Definition at line 153 of file event.hpp.

Member Function Documentation

◆ accept()

template<typename... Arguments>
void neogfx::event< Arguments >::accept ( ) const
inline

Definition at line 222 of file event.hpp.

◆ async_trigger()

template<typename... Arguments>
template<class... Ts>
void neogfx::event< Arguments >::async_trigger ( Ts &&...  aArguments) const
inline

Definition at line 216 of file event.hpp.

◆ ignore()

template<typename... Arguments>
void neogfx::event< Arguments >::ignore ( ) const
inline

Definition at line 226 of file event.hpp.

◆ operator()() [1/3]

template<typename... Arguments>
handle neogfx::event< Arguments >::operator() ( const handler_callback &  aHandlerCallback,
const void *  aUniqueId = 0 
) const
inline

Definition at line 242 of file event.hpp.

◆ operator()() [2/3]

template<typename... Arguments>
template<typename T >
handle neogfx::event< Arguments >::operator() ( const handler_callback &  aHandlerCallback,
const T *  aUniqueIdObject 
) const
inline

Definition at line 252 of file event.hpp.

◆ operator()() [3/3]

template<typename... Arguments>
template<typename T >
handle neogfx::event< Arguments >::operator() ( const handler_callback &  aHandlerCallback,
const T &  aUniqueIdObject 
) const
inline

Definition at line 262 of file event.hpp.

◆ operator=()

template<typename... Arguments>
event& neogfx::event< Arguments >::operator= ( const event< Arguments > &  )
inline

Definition at line 158 of file event.hpp.

◆ set_trigger_type()

template<typename... Arguments>
void neogfx::event< Arguments >::set_trigger_type ( event_trigger_type  aTriggerType)
inline

Definition at line 168 of file event.hpp.

◆ subscribe() [1/3]

template<typename... Arguments>
handle neogfx::event< Arguments >::subscribe ( const handler_callback &  aHandlerCallback,
const void *  aUniqueId = 0 
) const
inline

Definition at line 231 of file event.hpp.

◆ subscribe() [2/3]

template<typename... Arguments>
template<typename T >
handle neogfx::event< Arguments >::subscribe ( const handler_callback &  aHandlerCallback,
const T *  aUniqueIdObject 
) const
inline

Definition at line 247 of file event.hpp.

◆ subscribe() [3/3]

template<typename... Arguments>
template<typename T >
handle neogfx::event< Arguments >::subscribe ( const handler_callback &  aHandlerCallback,
const T &  aUniqueIdObject 
) const
inline

Definition at line 257 of file event.hpp.

◆ sync_trigger()

template<typename... Arguments>
template<class... Ts>
bool neogfx::event< Arguments >::sync_trigger ( Ts &&...  aArguments) const
inline

Definition at line 189 of file event.hpp.

◆ trigger()

template<typename... Arguments>
template<class... Ts>
bool neogfx::event< Arguments >::trigger ( Ts &&...  aArguments) const
inline

Definition at line 173 of file event.hpp.

◆ trigger_type()

template<typename... Arguments>
event_trigger_type neogfx::event< Arguments >::trigger_type ( ) const
inline

Definition at line 164 of file event.hpp.

◆ unsubscribe() [1/3]

template<typename... Arguments>
void neogfx::event< Arguments >::unsubscribe ( const void *  aUniqueId) const
inline

Definition at line 266 of file event.hpp.

◆ unsubscribe() [2/3]

template<typename... Arguments>
template<typename T >
void neogfx::event< Arguments >::unsubscribe ( const T *  aUniqueIdObject) const
inline

Definition at line 273 of file event.hpp.

◆ unsubscribe() [3/3]

template<typename... Arguments>
template<typename T >
void neogfx::event< Arguments >::unsubscribe ( const T &  aUniqueIdObject) const
inline

Definition at line 278 of file event.hpp.

Friends And Related Function Documentation

◆ async_event_queue

template<typename... Arguments>
friend class async_event_queue
friend

Definition at line 122 of file event.hpp.

◆ sink

template<typename... Arguments>
friend class sink
friend

Definition at line 121 of file event.hpp.

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