logo top
Main Page   Groups   Namespaces  

sigc::slot1< T_return, T_arg1 > Class Template Reference
[Slots]

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

Inheritance diagram for sigc::slot1< T_return, T_arg1 >:

Inheritance graph
[legend]
List of all members.

Public Types

typedef T_return result_type
typedef type_trait< T_arg1
>::take 
arg1_type_

Public Member Functions

T_return operator() (arg1_type_ _A_a1) const
 Invoke the contained functor unless slot is in blocking state.
 slot1 ()
template<class T_functor>
 slot1 (const T_functor& _A_func)
 Constructs a slot from an arbitrary functor.
 slot1 (const slot1& src)
slot1operator= (const slot1& src)
 Overrides this slot making a copy from another slot.

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

To use simply assign the slot to the desired functor. 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 T_return sigc::slot1<T_return, T_arg1>::result_type

template <class T_return, class T_arg1>
typedef type_trait<T_arg1>::take sigc::slot1<T_return, T_arg1>::arg1_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 desirer 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.


The documentation for this class was generated from the following file:
Generated for libsigc++ 2.0 by Doxygen 1.5.1 © 1997-2001