Main Page
Groups
Namespaces
sigc::slot3< T_return, T_arg1, T_arg2, T_arg3 > Class Template Reference
[Slots]
Converts an arbitrary functor to a unified type which is opaque.
More...
Inheritance diagram for sigc::slot3< T_return, T_arg1, T_arg2, T_arg3 >:
[legend]List of all members.
Detailed Description
template <class T_return, class T_arg1, class T_arg2, class T_arg3>
class sigc::slot3< T_return, T_arg1, T_arg2, T_arg3 >
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. - T_arg2 Argument type used in the definition of operator()(). The default
nil
means no argument. - T_arg3 Argument type used in the definition of operator()(). The default
nil
means no argument.
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, class T_arg2, class T_arg3> |
typedef type_trait<T_arg1>::take sigc::slot3<T_return, T_arg1, T_arg2, T_arg3>::arg1_type_ |
|
template <class T_return, class T_arg1, class T_arg2, class T_arg3> |
typedef type_trait<T_arg2>::take sigc::slot3<T_return, T_arg1, T_arg2, T_arg3>::arg2_type_ |
|
template <class T_return, class T_arg1, class T_arg2, class T_arg3> |
typedef type_trait<T_arg3>::take sigc::slot3<T_return, T_arg1, T_arg2, T_arg3>::arg3_type_ |
|
template <class T_return, class T_arg1, class T_arg2, class T_arg3> |
typedef T_return sigc::slot3<T_return, T_arg1, T_arg2, T_arg3>::result_type |
|
Constructor & Destructor Documentation
template <class T_return, class T_arg1, class T_arg2, class T_arg3> |
sigc::slot3<T_return, T_arg1, T_arg2, T_arg3>::slot3 |
( |
|
) |
[inline] |
|
template <class T_return, class T_arg1, class T_arg2, class T_arg3> |
template <class T_functor> |
sigc::slot3<T_return, T_arg1, T_arg2, T_arg3>::slot3 |
( |
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, class T_arg2, class T_arg3> |
sigc::slot3<T_return, T_arg1, T_arg2, T_arg3>::slot3 |
( |
const slot3<T_return, T_arg1, T_arg2, T_arg3>& |
src |
) |
[inline] |
|
Member Function Documentation
template <class T_return, class T_arg1, class T_arg2, class T_arg3> |
T_return sigc::slot3<T_return, T_arg1, T_arg2, T_arg3>::operator() |
( |
arg1_type_ |
_A_a1, |
|
|
arg2_type_ |
_A_a2, |
|
|
arg3_type_ |
_A_a3 |
|
) |
const [inline] |
|
|
Invoke the contained functor unless slot is in blocking state.
- Parameters:
-
| _A_a1 | Argument to be passed on to the functor. |
| _A_a2 | Argument to be passed on to the functor. |
| _A_a3 | Argument 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> |
slot3& sigc::slot3<T_return, T_arg1, T_arg2, T_arg3>::operator= |
( |
const slot3<T_return, T_arg1, T_arg2, T_arg3>& |
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.4.5 © 1997-2001