libsigc++: sigc::slot1< T_return, T_arg1 > Class Template Reference

libsigc++ 2.4.1

- 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::slot1< T_return, T_arg1 > Class Template Reference
Functors » Slots

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

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

Inheritance diagram for sigc::slot1< T_return, T_arg1 >:
[legend]

## Public Types
typedef type_trait< T_arg1 >::take | arg1_type_
typedef T_return | result_type
Public Types inherited from sigc::slot_base
typedef trackable::func_destroy_notify | func_destroy_notify

## Public Member Functions
| slot1 ()
template<class T_functor >
| slot1 (const T_functor& _A_func)
| Constructs a slot from an arbitrary functor. More...
| slot1 (const slot1& src)
T_return | operator() (arg1_type_ _A_a1) const
| Invoke the contained functor unless slot is in blocking state. More...
slot1& | operator= (const slot1& src)
| Overrides this slot making a copy from another slot. More...
Public Member Functions inherited from sigc::slot_base
| slot_base ()
| Constructs an empty slot. More...
| slot_base (rep_type* rep)
| 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 ()
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)
| Sets the blocking state. More...
bool | blocked () const
| Returns whether the slot is blocked. More...
void | disconnect ()
| Disconnects the slot. More...
bool | empty () const
| Returns whether the slot is invalid. More...
| operator bool () const
| Tests whether a slot is null, because the default constructor was used. More...
slot_base& | operator= (const slot_base& src)
| Overrides this slot making a copy 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
| Sets the parent of this slot. More...
bool | unblock ()
| 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 sigc::slot1< T_return, T_arg1 >

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()():

- T_return The return type of operator()().
- T_arg1 Argument type used in the definition of operator()(). The default `nil` means no argument.

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 >

typedef type_trait<T_arg1>::take sigc::slot1< T_return, T_arg1 >::arg1_type_

template <class T_return , class T_arg1 >

typedef T_return sigc::slot1< T_return, T_arg1 >::result_type

## Constructor & Destructor Documentation

template <class T_return , class T_arg1 >

sigc::slot1< T_return, T_arg1 >::slot1 | ( |  | ) |
| inline

template <class T_return , class T_arg1 >
template <class T_functor >

sigc::slot1< T_return, T_arg1 >::slot1 | ( | const T_functor & | _A_func | ) |
| inline

Constructs a slot from an arbitrary functor.

Parameters

  _A_func | The desired functor the new slot should be assigned to.

template <class T_return , class T_arg1 >

sigc::slot1< T_return, T_arg1 >::slot1 | ( | const slot1< T_return, T_arg1 >& | src | ) |
| inline

## Member Function Documentation

template <class T_return , class T_arg1 >

T_return sigc::slot1< T_return, T_arg1 >::operator() | ( | arg1_type_ | _A_a1 | ) | const
| inline

Invoke the contained functor unless slot is in blocking state.

Parameters

  _A_a1 | Argument to be passed on to the functor.

Returns
  The return value of the functor invocation.

template <class T_return , class T_arg1 >

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

Overrides this slot making a copy from another slot.

Parameters

  src | The slot from which to make a copy.

Returns
  `this`.