HydroCouple::ISignal< Args > Class Template Reference

Forward declarations. More...

#include <hydrocouple.h>

Collaboration diagram for HydroCouple::ISignal< Args >:

Public Member Functions
virtual	~ISignal ()=default
	ISignal::~ISignal is a virtual destructor.
virtual void	connect (const shared_ptr< ISlot< Args... > > &slot)=0
	connect is used to connect a slot to the signal.
virtual void	disconnect (const shared_ptr< ISlot< Args... > > &slot)=0
	disconnect is used to disconnect a slot from the signal.
virtual void	blockSignals (bool block)=0
	blockSignals is used to block signals from being emitted.

Protected Member Functions
virtual void	emit (Args... args)=0
	emit is used to emit the signal.

Detailed Description

template<typename... Args>
class HydroCouple::ISignal< Args >

Forward declarations.

ISignal interface class is used to emit signals/events to listeners.

Template Parameters

Args	are the arguments that will be passed by the signal.

See also

ISlot

IPropertyChanged

Constructor & Destructor Documentation

~ISignal()

template<typename... Args>

virtual HydroCouple::ISignal< Args >::~ISignal ( )

virtualdefault

ISignal::~ISignal is a virtual destructor.

Member Function Documentation

blockSignals()

template<typename... Args>

virtual void HydroCouple::ISignal< Args >::blockSignals ( bool  block )

pure virtual

blockSignals is used to block signals from being emitted.

Parameters

[in]

block

is a boolean value that is used to specify if signals should be blocked or not.

connect()

template<typename... Args>

virtual void HydroCouple::ISignal< Args >::connect ( const shared_ptr< ISlot< Args... > > &  slot )

pure virtual

connect is used to connect a slot to the signal.

Parameters

[in]

slot

is the slot that will listen to the signal.

disconnect()

template<typename... Args>

virtual void HydroCouple::ISignal< Args >::disconnect ( const shared_ptr< ISlot< Args... > > &  slot )

pure virtual

disconnect is used to disconnect a slot from the signal.

Parameters

[in]

slot

is the slot that will be disconnected from the signal.

emit()

template<typename... Args>

virtual void HydroCouple::ISignal< Args >::emit ( Args...  args )

protectedpure virtual

emit is used to emit the signal.

Parameters

[in]

args

are the arguments that will be passed by the signal.

---

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

• /home/runner/work/HydroCouple/HydroCouple/HydroCouple/include/hydrocouple.h