libsigc++ 2.6.2

- Main Page
- Related Pages
- Modules
- Namespaces
- Classes

- Class List
- Class Index
- Class Hierarchy
- Class Members

Public Types | Public Member Functions | List of all members
sigc::signal2< T_return, T_arg1, T_arg2, T_accumulator > Class Template Reference
Signals

Signal declaration. More...

`#include <sigc++/signal.h>`

Inheritance diagram for sigc::signal2< T_return, T_arg1, T_arg2, T_accumulator >:
[legend]

## Public Types
typedef slot_list_type::const_iterator | const_iterator
typedef slot_list_type::const_reverse_iterator | const_reverse_iterator
typedef internal::signal_emit2< T_return, T_arg1, T_arg2, T_accumulator > | emitter_type
typedef slot_list_type::iterator | iterator
typedef emitter_type::result_type | result_type
typedef slot_list_type::reverse_iterator | reverse_iterator
typedef slot_list< slot_type > | slot_list_type
typedef slot< T_return, T_arg1, T_arg2 > | slot_type
Public Types inherited from sigc::signal_base
typedef std::size_t | size_type
Public Types inherited from sigc::trackable
typedef internal::func_destroy_notify | func_destroy_notify

## Public Member Functions
| signal2 ()
| signal2 (const signal2& src)
| signal2 (signal2&& src)
iterator | connect (const slot_type& slot_)
| Add a slot to the list of slots. More...
result_type | emit (type_trait_take_t< T_arg1 > _A_a1, type_trait_take_t< T_arg2 > _A_a2) const
| Triggers the emission of the signal. More...
result_type | emit_reverse (type_trait_take_t< T_arg1 > _A_a1, type_trait_take_t< T_arg2 > _A_a2) const
| Triggers the emission of the signal in reverse order (see emit()). More...
bound_const_mem_functor2< result_type, signal2, type_trait_take_t< T_arg1 >, type_trait_take_t< T_arg2 > > | make_slot () const
| Creates a functor that calls emit() on this signal. More...
result_type | operator() (type_trait_take_t< T_arg1 > _A_a1, type_trait_take_t< T_arg2 > _A_a2) const
| Triggers the emission of the signal (see emit()). More...
signal2& | operator= (const signal2& src)
signal2& | operator= (signal2&& src)
slot_list_type | slots ()
| Creates an STL-style interface for the signal's list of slots. More...
const slot_list_type | slots () const
| Creates an STL-style interface for the signal's list of slots. More...
Public Member Functions inherited from sigc::signal_base
| signal_base () noexcept
| signal_base (const signal_base& src) noexcept
| signal_base (signal_base&& src)
| ~signal_base ()
void | block (bool should_block=true) noexcept
| Sets the blocking state of all slots in the list. More...
bool | blocked () const noexcept
| Returns whether all slots in the list are blocked. More...
void | clear ()
| Empties the list of slots. More...
bool | empty () const noexcept
| Returns whether the list of slots is empty. More...
signal_base& | operator= (const signal_base& src)
signal_base& | operator= (signal_base&& src)
size_type | size () const noexcept
| Returns the number of slots in the list. More...
void | unblock () noexcept
| Unsets the blocking state of all slots in the list. More...
Public Member Functions inherited from sigc::trackable
| trackable () noexcept
| trackable (const trackable& src) noexcept
| trackable (trackable&& src)
| ~trackable ()
void | add_destroy_notify_callback (void* data, func_destroy_notify func) const
| Add a callback that is executed (notified) when the trackable object is detroyed. More...
void | notify_callbacks ()
| Execute and remove all previously installed callbacks. More...
trackable& | operator= (const trackable& src)
trackable& | operator= (trackable&& src)
void | remove_destroy_notify_callback (void* data) const
| Remove a callback previously installed with add_destroy_notify_callback(). More...

## Additional Inherited Members
Protected Types inherited from sigc::signal_base
typedef internal::signal_impl::iterator_type | iterator_type
Protected Member Functions inherited from sigc::signal_base
iterator_type | connect (const slot_base& slot_)
| Adds a slot at the end of the list of slots. More...
iterator_type | erase (iterator_type i)
| Removes the slot at the given position from the list of slots. More...
internal::signal_impl* | impl () const
| Returns the signal_impl object encapsulating the list of slots. More...
iterator_type | insert (iterator_type i, const slot_base& slot_)
| Adds a slot at the given position into the list of slots. More...
Protected Attributes inherited from sigc::signal_base
internal::signal_impl* | impl_
| The signal_impl object encapsulating the slot list. More...

## Detailed Description

### template<class T_return, class T_arg1, class T_arg2, class T_accumulator = nil>
class sigc::signal2< T_return, T_arg1, T_arg2, T_accumulator >

Signal declaration.

signal2 can be used to connect() slots that are invoked during subsequent calls to emit(). Any functor or slot can be passed into connect(). It is converted into a slot implicitly.

If you want to connect one signal to another, use make_slot() to retrieve a functor that emits the signal when invoked.

Be careful if you directly pass one signal into the connect() method of another: a shallow copy of the signal is made and the signal's slots are not disconnected until both the signal and its clone are destroyed, which is probably not what you want!

An STL-style list interface for the signal's list of slots can be retrieved with slots(). This interface supports iteration, insertion and removal of slots.

The following template arguments are used:

- T_return The desired return type for the emit() function (may be overridden by the accumulator).
- T_arg1 Argument type used in the definition of emit().
- T_arg2 Argument type used in the definition of emit().
- T_accumulator The accumulator type used for emission. The default `nil` means that no accumulator should be used, for example if signal emission returns the return value of the last slot invoked.

You should use the more convenient unnumbered sigc::signal template.

## Member Typedef Documentation

template <class T_return, class T_arg1, class T_arg2, class T_accumulator = nil>

typedef slot_list_type::const_iterator sigc::signal2< T_return, T_arg1, T_arg2, T_accumulator >::const_iterator

template <class T_return, class T_arg1, class T_arg2, class T_accumulator = nil>

typedef slot_list_type::const_reverse_iterator sigc::signal2< T_return, T_arg1, T_arg2, T_accumulator >::const_reverse_iterator

template <class T_return, class T_arg1, class T_arg2, class T_accumulator = nil>

typedef internal::signal_emit2<T_return, T_arg1, T_arg2, T_accumulator> sigc::signal2< T_return, T_arg1, T_arg2, T_accumulator >::emitter_type

template <class T_return, class T_arg1, class T_arg2, class T_accumulator = nil>

typedef slot_list_type::iterator sigc::signal2< T_return, T_arg1, T_arg2, T_accumulator >::iterator

template <class T_return, class T_arg1, class T_arg2, class T_accumulator = nil>

typedef emitter_type::result_type sigc::signal2< T_return, T_arg1, T_arg2, T_accumulator >::result_type

template <class T_return, class T_arg1, class T_arg2, class T_accumulator = nil>

typedef slot_list_type::reverse_iterator sigc::signal2< T_return, T_arg1, T_arg2, T_accumulator >::reverse_iterator

template <class T_return, class T_arg1, class T_arg2, class T_accumulator = nil>

typedef slot_list<slot_type> sigc::signal2< T_return, T_arg1, T_arg2, T_accumulator >::slot_list_type

template <class T_return, class T_arg1, class T_arg2, class T_accumulator = nil>

typedef slot<T_return, T_arg1, T_arg2> sigc::signal2< T_return, T_arg1, T_arg2, T_accumulator >::slot_type

## Constructor & Destructor Documentation

template <class T_return, class T_arg1, class T_arg2, class T_accumulator = nil>

sigc::signal2< T_return, T_arg1, T_arg2, T_accumulator >::signal2 | ( |  | ) |
| inline

template <class T_return, class T_arg1, class T_arg2, class T_accumulator = nil>

sigc::signal2< T_return, T_arg1, T_arg2, T_accumulator >::signal2 | ( | const signal2< T_return, T_arg1, T_arg2, T_accumulator >& | src | ) |
| inline

template <class T_return, class T_arg1, class T_arg2, class T_accumulator = nil>

sigc::signal2< T_return, T_arg1, T_arg2, T_accumulator >::signal2 | ( | signal2< T_return, T_arg1, T_arg2, T_accumulator >&& | src | ) |
| inline

## Member Function Documentation

template <class T_return, class T_arg1, class T_arg2, class T_accumulator = nil>

iterator sigc::signal2< T_return, T_arg1, T_arg2, T_accumulator >::connect | ( | const slot_type& | slot_ | ) |
| inline

Add a slot to the list of slots.

Any functor or slot may be passed into connect(). It will be converted into a slot implicitly. The returned iterator may be stored for disconnection of the slot at some later point. It stays valid until the slot is removed from the list of slots. The iterator can also be implicitly converted into a sigc::connection object that may be used safely beyond the life time of the slot.

std::function<> and C++11 lambda expressions are functors. These are examples of functors that can be connected to a signal.

std::bind() creates a functor, but this functor typically has an operator()() which is a variadic template. Our functor_trait can't deduce the result type of such a functor. If you first assign the return value of std::bind() to a std::function, you can connect the std::function to a signal.

Parameters

  slot_ | The slot to add to the list of slots.

Returns
  An iterator pointing to the new slot in the list.

template <class T_return, class T_arg1, class T_arg2, class T_accumulator = nil>

result_type sigc::signal2< T_return, T_arg1, T_arg2, T_accumulator >::emit | ( | type_trait_take_t< T_arg1 > | _A_a1,
|  | type_trait_take_t< T_arg2 > | _A_a2
| ) |  | const
| inline

Triggers the emission of the signal.

During signal emission all slots that have been connected to the signal are invoked unless they are manually set into a blocking state. The parameters are passed on to the slots. If T_accumulated is not `nil`, an accumulator of this type is used to process the return values of the slot invocations. Otherwise, the return value of the last slot invoked is returned.

Parameters

  _A_a1 | Argument to be passed on to the slots.
  _A_a2 | Argument to be passed on to the slots.

Returns
  The accumulated return values of the slot invocations.

template <class T_return, class T_arg1, class T_arg2, class T_accumulator = nil>

result_type sigc::signal2< T_return, T_arg1, T_arg2, T_accumulator >::emit_reverse | ( | type_trait_take_t< T_arg1 > | _A_a1,
|  | type_trait_take_t< T_arg2 > | _A_a2
| ) |  | const
| inline

Triggers the emission of the signal in reverse order (see emit()).

template <class T_return, class T_arg1, class T_arg2, class T_accumulator = nil>

bound_const_mem_functor2<result_type, signal2, type_trait_take_t<T_arg1>, type_trait_take_t<T_arg2> > sigc::signal2< T_return, T_arg1, T_arg2, T_accumulator >::make_slot | ( |  | ) | const
| inline

Creates a functor that calls emit() on this signal.

sigc::mem_fun(mysignal, &sigc::signal2::emit)

yields the same result.

Returns
  A functor that calls emit() on this signal.

template <class T_return, class T_arg1, class T_arg2, class T_accumulator = nil>

result_type sigc::signal2< T_return, T_arg1, T_arg2, T_accumulator >::operator() | ( | type_trait_take_t< T_arg1 > | _A_a1,
|  | type_trait_take_t< T_arg2 > | _A_a2
| ) |  | const
| inline

Triggers the emission of the signal (see emit()).

template <class T_return, class T_arg1, class T_arg2, class T_accumulator = nil>

signal2& sigc::signal2< T_return, T_arg1, T_arg2, T_accumulator >::operator= | ( | const signal2< T_return, T_arg1, T_arg2, T_accumulator >& | src | ) |
| inline

template <class T_return, class T_arg1, class T_arg2, class T_accumulator = nil>

signal2& sigc::signal2< T_return, T_arg1, T_arg2, T_accumulator >::operator= | ( | signal2< T_return, T_arg1, T_arg2, T_accumulator >&& | src | ) |
| inline

template <class T_return, class T_arg1, class T_arg2, class T_accumulator = nil>

slot_list_type sigc::signal2< T_return, T_arg1, T_arg2, T_accumulator >::slots | ( |  | ) |
| inline

Creates an STL-style interface for the signal's list of slots.

This interface supports iteration, insertion and removal of slots.

Returns
  An STL-style interface for the signal's list of slots.

template <class T_return, class T_arg1, class T_arg2, class T_accumulator = nil>

const slot_list_type sigc::signal2< T_return, T_arg1, T_arg2, T_accumulator >::slots | ( |  | ) | const
| inline

Creates an STL-style interface for the signal's list of slots.

This interface supports iteration, insertion and removal of slots.

Returns
  An STL-style interface for the signal's list of slots.