libsigc++ 2.12.1
sigc::slot< T_return, nil, nil, nil, nil, nil, nil, nil > Class Template Reference

Convenience wrapper for the numbered sigc::slot0 template. More...

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

Inheritance diagram for sigc::slot< T_return, nil, nil, nil, nil, nil, nil, nil >:

Public Types

typedef slot0< T_returnparent_type
Public Types inherited from sigc::slot7< T_return, nil, nil, nil, nil, nil, nil, nil >
typedef type_trait_take_t< nilarg1_type_
typedef type_trait_take_t< nilarg2_type_
typedef type_trait_take_t< nilarg3_type_
typedef type_trait_take_t< nilarg4_type_
typedef type_trait_take_t< nilarg5_type_
typedef type_trait_take_t< nilarg6_type_
typedef type_trait_take_t< nilarg7_type_
typedef T_return result_type
Public Types inherited from sigc::slot_base
typedef trackable::func_destroy_notify func_destroy_notify
Public Types inherited from sigc::slot0< T_return >
typedef T_return result_type

Public Member Functions

 slot ()
 slot (const slot & src)
 Constructs a slot, copying an existing one.
template<class T_functor>
 slot (const T_functor & _A_func)
 Constructs a slot from an arbitrary functor.
 slot (slot && src)
 Constructs a slot, moving an existing one.
slotoperator= (const slot & src)
 Overrides this slot, making a copy from another slot.
slotoperator= (slot && src)
 Overrides this slot, making a move from another slot.
Public Member Functions inherited from sigc::slot7< T_return, nil, nil, nil, nil, nil, nil, nil >
 slot7 ()
T_return operator() (arg1_type_ _A_a1, arg2_type_ _A_a2, arg3_type_ _A_a3, arg4_type_ _A_a4, arg5_type_ _A_a5, arg6_type_ _A_a6, arg7_type_ _A_a7) const
 Invoke the contained functor unless slot is in blocking state.
slot7operator= (const slot7 & src)
 Overrides this slot, making a copy from another slot.
Public Member Functions inherited from sigc::slot_base
 slot_base () noexcept
 Constructs an empty slot.
 slot_base (const slot_base & src)
 Constructs a slot, copying an existing one.
 slot_base (rep_type * rep) noexcept
 Constructs a slot from an existing slot_rep object.
 slot_base (slot_base && src)
 Constructs a slot, moving an existing one.
 ~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.
bool block (bool should_block=true) noexcept
 Sets the blocking state.
bool blocked () const noexcept
 Returns whether the slot is blocked.
void disconnect ()
 Disconnects the slot.
bool empty () const noexcept
 Returns whether the slot is invalid.
 operator bool () const noexcept
 Tests whether a slot is null, because the default constructor was used.
slot_baseoperator= (const slot_base & src)
 Overrides this slot, making a copy from another slot.
slot_baseoperator= (slot_base && src)
 Overrides this slot, making a move from another slot.
void remove_destroy_notify_callback (void * data) const
 Remove a callback previously installed with add_destroy_notify_callback().
void set_parent (void * parent, void *(* cleanup)(void *)) const noexcept
 Sets the parent of this slot.
bool unblock () noexcept
 Unsets the blocking state.
Public Member Functions inherited from sigc::slot0< T_return >
 slot0 ()
 slot0 (const slot0 & src)
 Constructs a slot, copying an existing one.
template<class T_functor>
 slot0 (const T_functor & _A_func)
 Constructs a slot from an arbitrary functor.
 slot0 (slot0 && src)
 Constructs a slot, moving an existing one.
T_return operator() () const
 Invoke the contained functor unless slot is in blocking state.
slot0operator= (const slot0 & src)
 Overrides this slot, making a copy from another slot.
slot0operator= (slot0 && src)
 Overrides this slot, making a move from another slot.

Additional Inherited Members

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

Detailed Description

template <class T_return>
class sigc::slot< T_return, nil, nil, nil, nil, nil, nil, nil >

Convenience wrapper for the numbered sigc::slot0 template.

See the base class for useful methods. This is the template specialization of the unnumbered sigc::slot template for 0 argument(s), specialized for different numbers of arguments This is possible because the template has default (nil) template types.

Deprecated
Please use the syntax similar to that used by std::function<>:
sigc::slot<void(bool, int)> some_slot;
Convenience wrapper for the numbered sigc::slot# templates.
Definition slot.h:1685

Member Typedef Documentation

◆ parent_type

template <class T_return>
typedef slot0<T_return> sigc::slot< T_return, nil, nil, nil, nil, nil, nil, nil >::parent_type

Constructor & Destructor Documentation

◆ slot() [1/4]

template <class T_return>
sigc::slot< T_return, nil, nil, nil, nil, nil, nil, nil >::slot ( )
inline

◆ slot() [2/4]

template <class T_return>
template <class T_functor>
sigc::slot< T_return, nil, nil, nil, nil, nil, nil, nil >::slot ( 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.

◆ slot() [3/4]

template <class T_return>
sigc::slot< T_return, nil, nil, nil, nil, nil, nil, nil >::slot ( const slot< T_return, nil, nil, nil, nil, nil, nil, nil > & src)
inline

Constructs a slot, copying an existing one.

Parameters
srcThe existing slot to copy.

◆ slot() [4/4]

template <class T_return>
sigc::slot< T_return, nil, nil, nil, nil, nil, nil, nil >::slot ( slot< T_return, nil, nil, nil, nil, nil, nil, nil > && 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

◆ operator=() [1/2]

template <class T_return>
slot & sigc::slot< T_return, nil, nil, nil, nil, nil, nil, nil >::operator= ( const slot< T_return, nil, nil, nil, nil, nil, nil, nil > & src)
inline

Overrides this slot, making a copy from another slot.

Parameters
srcThe slot from which to make a copy.
Returns
this.

◆ operator=() [2/2]

template <class T_return>
slot & sigc::slot< T_return, nil, nil, nil, nil, nil, nil, nil >::operator= ( slot< T_return, nil, nil, nil, nil, nil, nil, nil > && 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.