"Fossies" - the Fresh Open Source Software Archive

Member "libsigc++-2.10.2/docs/reference/html/classsigc_1_1slot4.html" (12 Jun 2019, 44596 Bytes) of package /linux/misc/libsigc++-2.10.2.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 libsigc++-2.10.2.tar.xz project site itself.

libsigc++  2.10.2
Public Types | Public Member Functions | List of all members
sigc::slot4< T_return, T_arg1, T_arg2, T_arg3, T_arg4 > Class Template Reference

Converts an arbitrary functor to a unified type which is opaque. More...

#include <sigc++/functors/slot.h>

Inheritance diagram for sigc::slot4< T_return, T_arg1, T_arg2, T_arg3, T_arg4 >:
Inheritance graph
[legend]

Public Types

typedef type_trait_take_t< T_arg1 > arg1_type_
 
typedef type_trait_take_t< T_arg2 > arg2_type_
 
typedef type_trait_take_t< T_arg3 > arg3_type_
 
typedef type_trait_take_t< T_arg4 > arg4_type_
 
typedef T_return result_type
 
- Public Types inherited from sigc::slot_base
typedef trackable::func_destroy_notify func_destroy_notify
 

Public Member Functions

 slot4 ()
 
template<class T_functor >
 slot4 (const T_functor& _A_func)
 Constructs a slot from an arbitrary functor. More...
 
 slot4 (const slot4& src)
 Constructs a slot, copying an existing one. More...
 
 slot4 (slot4&& src)
 Constructs a slot, moving an existing one. More...
 
T_return operator() (arg1_type_ _A_a1, arg2_type_ _A_a2, arg3_type_ _A_a3, arg4_type_ _A_a4) const
 Invoke the contained functor unless slot is in blocking state. More...
 
slot4operator= (const slot4& src)
 Overrides this slot, making a copy from another slot. More...
 
slot4operator= (slot4&& src)
 Overrides this slot, making a move from another slot. More...
 
- Public Member Functions inherited from sigc::slot_base
 slot_base () noexcept
 Constructs an empty slot. More...
 
 slot_base (rep_type* rep) noexcept
 Constructs a slot from an existing slot_rep object. More...
 
 slot_base (const slot_base& src)
 Constructs a slot, copying an existing one. More...
 
 slot_base (slot_base&& src)
 Constructs a slot, moving an existing one. More...
 
 ~slot_base ()
 
void add_destroy_notify_callback (void* data, func_destroy_notify func) const
 Add a callback that is executed (notified) when the slot is detroyed. More...
 
bool block (bool should_block=true) noexcept
 Sets the blocking state. More...
 
bool blocked () const noexcept
 Returns whether the slot is blocked. More...
 
void disconnect ()
 Disconnects the slot. More...
 
bool empty () const noexcept
 Returns whether the slot is invalid. More...
 
 operator bool () const noexcept
 Tests whether a slot is null, because the default constructor was used. More...
 
slot_baseoperator= (const slot_base& src)
 Overrides this slot, making a copy from another slot. More...
 
slot_baseoperator= (slot_base&& src)
 Overrides this slot, making a move from another slot. More...
 
void remove_destroy_notify_callback (void* data) const
 Remove a callback previously installed with add_destroy_notify_callback(). More...
 
void set_parent (void* parent, void*(* cleanup)(void*)) const noexcept
 Sets the parent of this slot. More...
 
bool unblock () noexcept
 Unsets the blocking state. More...
 

Additional Inherited Members

- Public Attributes inherited from sigc::slot_base
bool blocked_
 Indicates whether the slot is blocked. More...
 
rep_type* rep_
 Typed slot_rep object that contains a functor. More...
 

Detailed Description

template<class T_return, class T_arg1, class T_arg2, class T_arg3, class T_arg4>
class sigc::slot4< T_return, T_arg1, T_arg2, T_arg3, T_arg4 >

Converts an arbitrary functor to a unified type which is opaque.

sigc::slot itself is a functor or to be more precise a closure. It contains a single, arbitrary functor (or closure) that is executed in operator()().

The template arguments determine the function signature of operator()():

To use simply assign the desired functor to the slot. If the functor is not compatible with the parameter list defined with the template arguments compiler errors are triggered. When called the slot will invoke the functor with minimal copies. block() and unblock() can be used to block the functor's invocation from operator()() temporarily.

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

Member Typedef Documentation

template <class T_return , class T_arg1 , class T_arg2 , class T_arg3 , class T_arg4 >
typedef type_trait_take_t<T_arg1> sigc::slot4< T_return, T_arg1, T_arg2, T_arg3, T_arg4 >::arg1_type_
template <class T_return , class T_arg1 , class T_arg2 , class T_arg3 , class T_arg4 >
typedef type_trait_take_t<T_arg2> sigc::slot4< T_return, T_arg1, T_arg2, T_arg3, T_arg4 >::arg2_type_
template <class T_return , class T_arg1 , class T_arg2 , class T_arg3 , class T_arg4 >
typedef type_trait_take_t<T_arg3> sigc::slot4< T_return, T_arg1, T_arg2, T_arg3, T_arg4 >::arg3_type_
template <class T_return , class T_arg1 , class T_arg2 , class T_arg3 , class T_arg4 >
typedef type_trait_take_t<T_arg4> sigc::slot4< T_return, T_arg1, T_arg2, T_arg3, T_arg4 >::arg4_type_
template <class T_return , class T_arg1 , class T_arg2 , class T_arg3 , class T_arg4 >
typedef T_return sigc::slot4< T_return, T_arg1, T_arg2, T_arg3, T_arg4 >::result_type

Constructor & Destructor Documentation

template <class T_return , class T_arg1 , class T_arg2 , class T_arg3 , class T_arg4 >
sigc::slot4< T_return, T_arg1, T_arg2, T_arg3, T_arg4 >::slot4 ( )
inline
template <class T_return , class T_arg1 , class T_arg2 , class T_arg3 , class T_arg4 >
template <class T_functor >
sigc::slot4< T_return, T_arg1, T_arg2, T_arg3, T_arg4 >::slot4 ( const T_functor &  _A_func)
inline

Constructs a slot from an arbitrary functor.

Parameters
_A_funcThe desired functor the new slot should be assigned to.
template <class T_return , class T_arg1 , class T_arg2 , class T_arg3 , class T_arg4 >
sigc::slot4< T_return, T_arg1, T_arg2, T_arg3, T_arg4 >::slot4 ( const slot4< T_return, T_arg1, T_arg2, T_arg3, T_arg4 >&  src)
inline

Constructs a slot, copying an existing one.

Parameters
srcThe existing slot to copy.
template <class T_return , class T_arg1 , class T_arg2 , class T_arg3 , class T_arg4 >
sigc::slot4< T_return, T_arg1, T_arg2, T_arg3, T_arg4 >::slot4 ( slot4< T_return, T_arg1, T_arg2, T_arg3, T_arg4 >&&  src)
inline

Constructs a slot, moving an existing one.

If src is connected to a parent (e.g. a signal), it is copied, not moved.

Parameters
srcThe existing slot to move or copy.

Member Function Documentation

template <class T_return , class T_arg1 , class T_arg2 , class T_arg3 , class T_arg4 >
T_return sigc::slot4< T_return, T_arg1, T_arg2, T_arg3, T_arg4 >::operator() ( arg1_type_  _A_a1,
arg2_type_  _A_a2,
arg3_type_  _A_a3,
arg4_type_  _A_a4 
) const
inline

Invoke the contained functor unless slot is in blocking state.

Parameters
_A_a1Argument to be passed on to the functor.
_A_a2Argument to be passed on to the functor.
_A_a3Argument to be passed on to the functor.
_A_a4Argument to be passed on to the functor.
Returns
The return value of the functor invocation.
template <class T_return , class T_arg1 , class T_arg2 , class T_arg3 , class T_arg4 >
slot4& sigc::slot4< T_return, T_arg1, T_arg2, T_arg3, T_arg4 >::operator= ( const slot4< T_return, T_arg1, T_arg2, T_arg3, T_arg4 >&  src)
inline

Overrides this slot, making a copy from another slot.

Parameters
srcThe slot from which to make a copy.
Returns
this.
template <class T_return , class T_arg1 , class T_arg2 , class T_arg3 , class T_arg4 >
slot4& sigc::slot4< T_return, T_arg1, T_arg2, T_arg3, T_arg4 >::operator= ( slot4< T_return, T_arg1, T_arg2, T_arg3, T_arg4 >&&  src)
inline

Overrides this slot, making a move from another slot.

If src is connected to a parent (e.g. a signal), it is copied, not moved.

Parameters
srcThe slot from which to move or copy.
Returns
this.