spark::patterns::Slot< Args > Class Template Reference

A slot is a connection between a signal and a callback. More...

#include <Slot.h>

Public Member Functions
	Slot (const std::function< void(Args...)> &f)
	Instantiates a slot with a callback.
	Slot (std::function< void(Args...)> &&f)
	Instantiates a slot with a callback.
template<class T >
	Slot (T *target, void(T::*method)(Args...))
	Instantiates a slot from a non const method pointer.
template<class T >
	Slot (T *target, void(T::*method)(Args...) const)
	Instantiates a slot from a const method pointer.
	Slot (const Slot &slot)
	Slot (Slot &&slot) noexcept
Slot &	operator= (const Slot &slot)
Slot &	operator= (Slot &&slot) noexcept
bool	isConnected () const
	Checks if this slot is connected to a signal.
void	disconnect ()
	Disconnects this slot from the signal.

Friends
class	details::Connection< Args... >
class	Signal< Args... >

Detailed Description

template<typename... Args>
class spark::patterns::Slot< Args >

A slot is a connection between a signal and a callback.

Template Parameters

Args	The types of the arguments of the callback.

Constructor & Destructor Documentation

Slot() [1/4]

template<typename... Args>

spark::patterns::Slot< Args >::Slot ( const std::function< void(Args...)> & f )

explicit

Instantiates a slot with a callback.

Parameters

f	The callback as a function object.

Slot() [2/4]

template<typename... Args>

spark::patterns::Slot< Args >::Slot ( std::function< void(Args...)> && f )

explicit

Instantiates a slot with a callback.

Parameters

f	The callback as a function object.

Slot() [3/4]

template<typename... Args>

template<class T >

spark::patterns::Slot< Args >::Slot	(	T *	target,
		void(T::*	method )(Args...) )

Instantiates a slot from a non const method pointer.

Template Parameters

T	The class containing the method.

Parameters

target	The instance of the class containing the method.
method	The address of the method to use as callback.

Slot() [4/4]

template<typename... Args>

template<class T >

spark::patterns::Slot< Args >::Slot	(	T *	target,
		void(T::*	method )(Args...) const )

Instantiates a slot from a const method pointer.

Template Parameters

T	The class containing the method.

Parameters

target	The instance of the class containing the method.
method	The address of the method to use as callback.

Member Function Documentation

isConnected()

template<typename... Args>

bool spark::patterns::Slot< Args >::isConnected ( ) const

nodiscard

Checks if this slot is connected to a signal.

Returns

True if this slot is connected to a signal, false otherwise.