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

#include <TGUI/Signal.hpp>

Inheritance diagram for tgui::SignalPanelListBoxItem:

Public Member Functions
	SignalPanelListBoxItem (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, 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, std::enable_if_t< std::is_convertible< Func, std::function< void(const BoundArgs &..., int)> >::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, std::enable_if_t< std::is_convertible< Func, std::function< void(const BoundArgs &..., const std::shared_ptr< Panel > &)> >::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, std::enable_if_t< std::is_convertible< Func, std::function< void(const BoundArgs &..., const String &)> >::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, std::enable_if_t< std::is_convertible< Func, std::function< void(const BoundArgs &..., int, const std::shared_ptr< Panel > &)> >::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, std::enable_if_t< std::is_convertible< Func, std::function< void(const BoundArgs &..., const std::shared_ptr< Panel > &, const String &)> >::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, std::enable_if_t< std::is_convertible< Func, std::function< void(const BoundArgs &..., int, const std::shared_ptr< Panel > &, const String &)> >::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, int index, const std::shared_ptr< Panel > &panel, const String &id)
	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.

TGUI_NODISCARD String	getName () const
	Returns the name given to the signal.

void	setEnabled (bool enabled)
	Changes whether this signal calls the connected functions when triggered.

TGUI_NODISCARD 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 TGUI_NODISCARD 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:

int (item index)
std::shared_ptr<Panel> (item ptr)
String (item id)
int, std::shared_ptr<Panel> (item index and item ptr)
std::shared_ptr<Panel>, String (item ptr and item id)
int, std::shared_ptr<Panel>, String (item index, item ptr and item id)

Member Function Documentation

◆ connect() [1/7]

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

unsigned int tgui::SignalPanelListBoxItem::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/7]

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

unsigned int tgui::SignalPanelListBoxItem::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 integer (for the item index) as last parameter
args	Additional arguments to pass to the function

Returns: Unique id of the connection

◆ connect() [3/7]

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

unsigned int tgui::SignalPanelListBoxItem::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 std::shared_ptr<Panel> (for the item ptr) as last parameter
args	Additional arguments to pass to the function

Returns: Unique id of the connection

◆ connect() [4/7]

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

unsigned int tgui::SignalPanelListBoxItem::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 String (for the item id) as last parameter
args	Additional arguments to pass to the function

Returns: Unique id of the connection

◆ connect() [5/7]

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

unsigned int tgui::SignalPanelListBoxItem::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 unbound integer and std::shared_ptr<Panel> (for the item index and ptr) as last parameters
args	Additional arguments to pass to the function

Returns: Unique id of the connection

◆ connect() [6/7]

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

unsigned int tgui::SignalPanelListBoxItem::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 unbound std::shared_ptr<Panel> and String (for the item ptr and id) as last parameters
args	Additional arguments to pass to the function

Returns: Unique id of the connection

◆ connect() [7/7]

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

unsigned int tgui::SignalPanelListBoxItem::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 unbound integer, std::shared_ptr<Panel> and String (for the item index, ptr and id) as last parameters
args	Additional arguments to pass to the function

Returns: Unique id of the connection

◆ emit()

bool tgui::SignalPanelListBoxItem::emit	(	const Widget *	widget,
		int	index,
		const std::shared_ptr< Panel > &	panel,
		const String &	id )

Call all connected signal handlers.

Parameters

widget	Widget that is triggering the signal
index	Index of the item, or -1 if there is no item
panel	Pointer of the item, or an nullptr if there is no item
id	Id of the item, or an empty string if there is no item

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::SignalPanelListBoxItem::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

TGUI

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ connect() [1/7]

◆ connect() [2/7]

◆ connect() [3/7]

◆ connect() [4/7]

◆ connect() [5/7]

◆ connect() [6/7]

◆ connect() [7/7]

◆ emit()

◆ operator()()