Read Me

SignalSlot 1.0 README

How to use this library:

To create a signal, declare it like so:
    // a signal with no parameters
    SigSlot::Signal0<> MySignal;
    
    // a signal with a single parameter of type int
    SigSlot::Signal1<int> IntSignal;
    
    // a signal with two parameters of type int and const char*
    SigSlot::Signal2<int, const char*> ErrorSignal;

To create a slot, subclass SigSlot::Container and create a member function to 
use as the slot:
    class MyContainer: public SigSlot::Coontainer       {
        public:
            void MySlot();
            void IntSlot(int);
            void ErrorSlot(int, const char*);
    };
    
    void MyContainer::MySlot()  {
        ...

To connect a signal to a slot, do this:
    MyContainer myc_instance;
    MySignal.connect(myc_instance, &MyContainer::MySlot);
    IntSignal.connect(myc_instance, &MyContainer::IntSlot);
    ErrorSignal.connect(myc_instance, &MyContainer::ErrorSlot);

To emit a signal and thereby call whatever slots are connected to it, do this:
    MySignal();
    IntSignal(5);
    ErrorSignal(42, "Question unknown");

or this:
    MySignal.emit();
    IntSignal.emit(5);
    ErrorSignal.emit(42, "Question unknown");

To connect a signal to a signal, so that the second signal is emitted whenever 
the first is, do this:
    Signal0<> AnotherSignal;
    AnotherSignal.connect(MySignal);

To disconnect a signal from all slots in a container, do this:
    IntSignal.disconnect(myc_instance);

Due to technical limitations of the C++ language it is not possible to 
disconnect an individual slot at this time.

The types of signals and slots must match in order to be connected.  For 
example, you cannot connect a signal with 0 parameters to a slot with 1 
parameter or vice versa, nor can you connect a signal with an int parameter to a
slot with a paramter of type const char*.

Slots must not return a value (return type void).  There is no way to pass the
return value back to the calling function anyway since a signal may trigger more
than one slot.

emit() is not a const member function.  This is because the signal has no 
knowledge of what a slot connected to it might do.  A slot might conceivably 
modify the signal that calls it or whatever object the signal is a member of.
With this in mind, don't be surprised if you can't emit a signal from a const 
member function.