TGUI  0.8-dev
tgui::SignalItem Class Reference

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

#include <Signal.hpp>

Inheritance diagram for tgui::SignalItem:
tgui::Signal

Public Member Functions

 SignalItem (std::string &&name)
 Constructor.
 
unsigned int connect (const DelegateItem &handler)
 Connects a signal handler that will be called when this signal is emitted. More...
 
unsigned int connect (const DelegateItemEx &handler)
 Connects a signal handler that will be called when this signal is emitted. More...
 
unsigned int connect (const DelegateItemAndId &handler)
 Connects a signal handler that will be called when this signal is emitted. More...
 
unsigned int connect (const DelegateItemAndIdEx &handler)
 Connects a signal handler that will be called when this signal is emitted. More...
 
- Public Member Functions inherited from tgui::Signal
 Signal (std::string &&name, std::size_t extraParameters=0)
 Constructor. More...
 
unsigned int connect (const Delegate &handler)
 Connects a signal handler that will be called when this signal is emitted. More...
 
unsigned int connect (const DelegateEx &handler)
 Connects a signal handler that will be called when this signal is emitted. More...
 
bool disconnect (unsigned int id)
 Disconnect a signal handler from this signal. More...
 
void disconnectAll ()
 Disconnect all signal handler from this signal.
 
bool emit (const Widget *widget)
 Call all connected signal handlers. More...
 
std::string getName () const
 Returns the name given to the signal. More...
 

Detailed Description

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

Member Function Documentation

◆ connect() [1/4]

unsigned int tgui::SignalItem::connect ( const DelegateItem &  handler)

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

Parameters
handlerCallback function that is given a string as argument
Returns
Unique id of the connection

◆ connect() [2/4]

unsigned int tgui::SignalItem::connect ( const DelegateItemEx &  handler)

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

Parameters
handlerCallback function that is given a pointer to the widget, the name of the signal and a string as arguments
Returns
Unique id of the connection

◆ connect() [3/4]

unsigned int tgui::SignalItem::connect ( const DelegateItemAndId &  handler)

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

Parameters
handlerCallback function that is given two strings as argument
Returns
Unique id of the connection

◆ connect() [4/4]

unsigned int tgui::SignalItem::connect ( const DelegateItemAndIdEx &  handler)

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

Parameters
handlerCallback function that is given a pointer to the widget, the name of the signal and two strings as arguments
Returns
Unique id of the connection

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