libsigc++  2.99.13
Classes
Signals

Use sigc::signal::connect() with sigc::mem_fun() and sigc::ptr_fun() to connect a method or function with a signal. More...

Classes

struct  sigc::connection
 This may be used to disconnect the referred slot at any time (disconnect()). More...
 
class  sigc::signal< T_return(T_arg...)>
 signal can be used to connect() slots that are invoked during subsequent calls to emit(). More...
 
class  sigc::signal< T_return(T_arg...)>::accumulated< T_accumulator >
 Like sigc::signal but the additional template parameter T_accumulator defines the accumulator type that should be used. More...
 
struct  sigc::signal_base
 Base class for the sigc::signal# templates. More...
 
class  sigc::signal_with_accumulator< T_return, T_accumulator, T_arg >
 Signal declaration. More...
 
struct  sigc::trackable
 Base class for objects with auto-disconnection. More...
 

Detailed Description

Use sigc::signal::connect() with sigc::mem_fun() and sigc::ptr_fun() to connect a method or function with a signal.

signal_clicked.connect( sigc::mem_fun(*this, &MyWindow::on_clicked) );

When the signal is emitted your method will be called.

signal::connect() returns a connection, which you can later use to disconnect your method. If the type of your object inherits from sigc::trackable the method is disconnected automatically when your object is destroyed.

When signals are copied they share the underlying information, so you can have a protected/private sigc::signal member and a public accessor method. A sigc::signal is a kind of reference-counting pointer. It's similar to std::shared_ptr<>, although sigc::signal is restricted to holding a pointer to a sigc::internal::signal_impl object that contains the implementation of the signal.

class MyClass
{
public:
using MySignalType = sigc::signal<void()>;
MySignalType get_my_signal() { return m_my_signal; }
private:
MySignalType m_my_signal;
};

signal and slot objects provide the core functionality of this library. A slot is a container for an arbitrary functor. A signal is a list of slots that are executed on emission. For compile time type safety a list of template arguments must be provided for the signal template that determines the parameter list for emission. Functors and closures are converted into slots implicitly on connection, triggering compiler errors if the given functor or closure cannot be invoked with the parameter list of the signal to connect to.

Almost any functor with the correct signature can be converted to a sigc::slot and connected to a signal. See Slots and sigc::signal::connect().