tgui::SignalAnimationType Class Reference

Signal to which the user can subscribe to get callbacks from. More...

#include <TGUI/Signal.hpp>

Inheritance diagram for tgui::SignalAnimationType:

Public Member Functions
	SignalAnimationType (String &&name)
	Constructor.
template<typename Func, typename... BoundArgs>
unsigned int	operator() (const Func &func, const BoundArgs &... args)
	Connects a signal handler that will be called when this signal is emitted.
template<typename Func, typename... BoundArgs, typename std::enable_if_t< std::is_convertible< Func, std::function< void(const BoundArgs &...)> >::value > * = nullptr>
unsigned int	connect (const Func &func, const BoundArgs &... args)
	Connects a signal handler that will be called when this signal is emitted.
template<typename Func, typename... BoundArgs, typename std::enable_if_t< std::is_convertible< Func, std::function< void(const BoundArgs &..., AnimationType)> >::value > * = nullptr>
unsigned int	connect (const Func &func, const BoundArgs &... args)
	Connects a signal handler that will be called when this signal is emitted.
bool	emit (const Widget *widget, AnimationType type)
	Call all connected signal handlers.
Public Member Functions inherited from tgui::Signal
virtual	~Signal ()=default
	Default destructor.
	Signal (String &&name, std::size_t extraParameters=0)
	Constructor.
	Signal (const Signal &other)
	Copy constructor which will not copy the signal handlers.
	Signal (Signal &&other) noexcept=default
	Default move constructor.
Signal &	operator= (const Signal &other)
	Copy assignment operator which will not copy the signal handlers.
Signal &	operator= (Signal &&other) noexcept=default
	Default move assignment operator.
template<typename Func, typename... BoundArgs>
unsigned int	operator() (const Func &func, const BoundArgs &... args)
	Connects a signal handler that will be called when this signal is emitted.
template<typename Func, typename... BoundArgs, typename std::enable_if_t< std::is_convertible< Func, std::function< void(const BoundArgs &...)> >::value > * = nullptr>
unsigned int	connect (const Func &func, const BoundArgs &... args)
	Connects a signal handler that will be called when this signal is emitted.
template<typename Func, typename... BoundArgs, typename std::enable_if_t< std::is_convertible< Func, std::function< void(const BoundArgs &..., const std::shared_ptr< Widget > &, const String &)> >::value, * = nullptr>
unsigned int	connectEx (const Func &func, const BoundArgs &... args)
	Connects a signal handler that will be called when this signal is emitted.
bool	disconnect (unsigned int id)
	Disconnect a signal handler from this signal.
void	disconnectAll ()
	Disconnect all signal handler from this signal.
bool	emit (const Widget *widget)
	Call all connected signal handlers.
String	getName () const
	Returns the name given to the signal.
void	setEnabled (bool enabled)
	Changes whether this signal calls the connected functions when triggered.
bool	isEnabled () const
	Returns whether this signal calls the connected functions when triggered.

Additional Inherited Members
Static Protected Member Functions inherited from tgui::Signal
static std::shared_ptr< Widget >	getWidget ()
	Extracts the widget stored in the first parameter.
template<typename Type>
static const std::decay_t< Type > &	dereferenceParam (std::size_t paramIndex)
	Turns the void* parameters back into its original type right before calling the callback function.
template<typename Func, typename... Args, typename std::enable_if_t< std::is_member_pointer< std::decay_t< Func > >::value > * = nullptr>
static void	invokeFunc (Func &&func, Args &&... args)
template<typename Func, typename... Args, typename std::enable_if_t<!std::is_member_pointer< std::decay_t< Func > >::value > * = nullptr>
static void	invokeFunc (Func &&func, Args &&... args)
Protected Attributes inherited from tgui::Signal
bool	m_enabled = true
String	m_name
std::unordered_map< unsigned int, std::function< void()> >	m_handlers
Static Protected Attributes inherited from tgui::Signal
static unsigned int	m_lastSignalId
static std::deque< const void * >	m_parameters

Detailed Description

Signal to which the user can subscribe to get callbacks from.

Optional unbound parameters:

• AnimationType

Member Function Documentation

connect() [1/2]

template<typename Func, typename... BoundArgs, typename std::enable_if_t< std::is_convertible< Func, std::function< void(const BoundArgs &...)> >::value > * = nullptr>

unsigned int tgui::SignalAnimationType::connect ( const Func & func, const BoundArgs &... args )

inline

Connects a signal handler that will be called when this signal is emitted.

Parameters

func	Callback function without unbound parameters
args	Additional arguments to pass to the function

Returns

Unique id of the connection

connect() [2/2]

template<typename Func, typename... BoundArgs, typename std::enable_if_t< std::is_convertible< Func, std::function< void(const BoundArgs &..., AnimationType)> >::value > * = nullptr>

unsigned int tgui::SignalAnimationType::connect ( const Func & func, const BoundArgs &... args )

inline

Connects a signal handler that will be called when this signal is emitted.

Parameters

func	Callback function that has an unbound AnimationType as last parameter
args	Additional arguments to pass to the function

Returns

Unique id of the connection

emit()

bool tgui::SignalAnimationType::emit	(	const Widget *	widget,
		AnimationType	type )

Call all connected signal handlers.

Parameters

widget	Widget that is triggering the signal
type	Type of the animation

Returns

True when a callback function was executed, false when there weren't any connected callback functions

operator()()

template<typename Func, typename... BoundArgs>

unsigned int tgui::SignalAnimationType::operator() ( const Func & func, const BoundArgs &... args )

inline

Connects a signal handler that will be called when this signal is emitted.

Parameters

func	Callback function that can be passed to the connect function
args	Additional arguments to pass to the function

Returns

Unique id of the connection

---

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

• include/TGUI/Signal.hpp