"Fossies" - the Fresh Open Source Software Archive

Member "libsigc++-3.0.0/docs/docs/reference/html/classsigc_1_1signal__with__accumulator.html" (5 Sep 2019, 45109 Bytes) of package /linux/misc/libsigc++-3.0.0.tar.xz:


Caution: In this restricted "Fossies" environment the current HTML page may not be correctly presentated and may have some non-functional links. You can here alternatively try to browse the pure source code or just view or download the uninterpreted raw source code. If the rendering is insufficient you may try to find and view the page on the project site itself.

libsigc++  3.0.0
Public Types | Public Member Functions | List of all members
sigc::signal_with_accumulator< T_return, T_accumulator, T_arg > Class Template Reference

Signal declaration. More...

#include <sigc++/signal.h>

Inheritance diagram for sigc::signal_with_accumulator< T_return, T_accumulator, T_arg >:
Inheritance graph
[legend]

Public Types

using slot_type = slot< T_return(T_arg...)>
 
- Public Types inherited from sigc::signal_base
using size_type = std::size_t
 

Public Member Functions

 signal_with_accumulator ()=default
 
 signal_with_accumulator (const signal_with_accumulator& src)
 
 signal_with_accumulator (signal_with_accumulator&& src)
 
connection connect (const slot_type& slot_)
 Add a slot to the list of slots. More...
 
connection connect (slot_type&& slot_)
 Add a slot to the list of slots. More...
 
decltype(auto) emit (type_trait_take_t< T_arg >...a) const
 Triggers the emission of the signal. More...
 
decltype(auto) make_slot () const
 Creates a functor that calls emit() on this signal. More...
 
decltype(auto) operator() (type_trait_take_t< T_arg >...a) const
 Triggers the emission of the signal (see emit()). More...
 
signal_with_accumulatoroperator= (const signal_with_accumulator& src)
 
signal_with_accumulatoroperator= (signal_with_accumulator&& src)
 
- 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_baseoperator= (const signal_base& src)
 
signal_baseoperator= (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...
 

Additional Inherited Members

- Protected Types inherited from sigc::signal_base
using iterator_type = internal::signal_impl::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 connect (slot_base&& slot_)
 Adds a slot at the end of the list of slots. More...
 
std::shared_ptr< 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...
 
iterator_type insert (iterator_type i, slot_base&& slot_)
 Adds a slot at the given position into the list of slots. More...
 
- Protected Attributes inherited from sigc::signal_base
std::shared_ptr< internal::signal_impl > impl_
 The signal_impl object encapsulating the slot list. More...
 

Detailed Description

template<typename T_return, typename T_accumulator, typename... T_arg>
class sigc::signal_with_accumulator< T_return, T_accumulator, T_arg >

Signal declaration.

signal_with_accumulator 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!

The following template arguments are used:

Member Typedef Documentation

template <typename T_return, typename T_accumulator, typename... T_arg>
using sigc::signal_with_accumulator< T_return, T_accumulator, T_arg >::slot_type = slot<T_return(T_arg...)>

Constructor & Destructor Documentation

template <typename T_return, typename T_accumulator, typename... T_arg>
sigc::signal_with_accumulator< T_return, T_accumulator, T_arg >::signal_with_accumulator ( )
default
template <typename T_return, typename T_accumulator, typename... T_arg>
sigc::signal_with_accumulator< T_return, T_accumulator, T_arg >::signal_with_accumulator ( const signal_with_accumulator< T_return, T_accumulator, T_arg >&  src)
inline
template <typename T_return, typename T_accumulator, typename... T_arg>
sigc::signal_with_accumulator< T_return, T_accumulator, T_arg >::signal_with_accumulator ( signal_with_accumulator< T_return, T_accumulator, T_arg >&&  src)
inline

Member Function Documentation

template <typename T_return, typename T_accumulator, typename... T_arg>
connection sigc::signal_with_accumulator< T_return, T_accumulator, T_arg >::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 connection may be stored for disconnection of the slot at some later point. It stays valid until the slot is disconnected from the signal. 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
A connection.
template <typename T_return, typename T_accumulator, typename... T_arg>
connection sigc::signal_with_accumulator< T_return, T_accumulator, T_arg >::connect ( slot_type&&  slot_)
inline

Add a slot to the list of slots.

See also
connect(const slot_type& slot_).
Since libsigc++ 2.8:
template <typename T_return, typename T_accumulator, typename... T_arg>
decltype(auto) sigc::signal_with_accumulator< T_return, T_accumulator, T_arg >::emit ( type_trait_take_t< T_arg >...  a) 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 void, 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
aArguments to be passed on to the slots.
Returns
The accumulated return values of the slot invocations.
template <typename T_return, typename T_accumulator, typename... T_arg>
decltype(auto) sigc::signal_with_accumulator< T_return, T_accumulator, T_arg >::make_slot ( ) const
inline

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

yields the same result.

Returns
A functor that calls emit() on this signal.
template <typename T_return, typename T_accumulator, typename... T_arg>
decltype(auto) sigc::signal_with_accumulator< T_return, T_accumulator, T_arg >::operator() ( type_trait_take_t< T_arg >...  a) const
inline

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

template <typename T_return, typename T_accumulator, typename... T_arg>
signal_with_accumulator& sigc::signal_with_accumulator< T_return, T_accumulator, T_arg >::operator= ( const signal_with_accumulator< T_return, T_accumulator, T_arg >&  src)
inline
template <typename T_return, typename T_accumulator, typename... T_arg>
signal_with_accumulator& sigc::signal_with_accumulator< T_return, T_accumulator, T_arg >::operator= ( signal_with_accumulator< T_return, T_accumulator, T_arg >&&  src)
inline