libsigc++ 2.12.1
sigc::bind_return_functor< T_return, T_functor > Struct Template Reference

Adaptor that fixes the return value of the wrapped functor. More...

#include <sigc++/adaptors/bind_return.h>

Inheritance diagram for sigc::bind_return_functor< T_return, T_functor >:

Public Types

typedef unwrap_reference< T_return >::type result_type
 
- Public Types inherited from sigc::adapts< T_functor >
typedef adaptor_trait< T_functor >::adaptor_type adaptor_type
 
typedef adaptor_trait< T_functor >::result_type result_type
 

Public Member Functions

 bind_return_functor (type_trait_take_t< T_functor > _A_functor, type_trait_take_t< T_return > _A_ret_value)
 Constructs a bind_return_functor object that fixes the return value to _A_ret_value.
 
unwrap_reference< T_return >::type operator() ()
 Invokes the wrapped functor dropping its return value.
 
template<class T_arg1>
unwrap_reference< T_return >::type operator() (T_arg1 _A_a1)
 Invokes the wrapped functor passing on the arguments.
 
template<class T_arg1, class T_arg2>
unwrap_reference< T_return >::type operator() (T_arg1 _A_a1, T_arg2 _A_a2)
 Invokes the wrapped functor passing on the arguments.
 
template<class T_arg1, class T_arg2, class T_arg3>
unwrap_reference< T_return >::type operator() (T_arg1 _A_a1, T_arg2 _A_a2, T_arg3 _A_a3)
 Invokes the wrapped functor passing on the arguments.
 
template<class T_arg1, class T_arg2, class T_arg3, class T_arg4>
unwrap_reference< T_return >::type operator() (T_arg1 _A_a1, T_arg2 _A_a2, T_arg3 _A_a3, T_arg4 _A_a4)
 Invokes the wrapped functor passing on the arguments.
 
template<class T_arg1, class T_arg2, class T_arg3, class T_arg4, class T_arg5>
unwrap_reference< T_return >::type operator() (T_arg1 _A_a1, T_arg2 _A_a2, T_arg3 _A_a3, T_arg4 _A_a4, T_arg5 _A_a5)
 Invokes the wrapped functor passing on the arguments.
 
template<class T_arg1, class T_arg2, class T_arg3, class T_arg4, class T_arg5, class T_arg6>
unwrap_reference< T_return >::type operator() (T_arg1 _A_a1, T_arg2 _A_a2, T_arg3 _A_a3, T_arg4 _A_a4, T_arg5 _A_a5, T_arg6 _A_a6)
 Invokes the wrapped functor passing on the arguments.
 
template<class T_arg1, class T_arg2, class T_arg3, class T_arg4, class T_arg5, class T_arg6, class T_arg7>
unwrap_reference< T_return >::type operator() (T_arg1 _A_a1, T_arg2 _A_a2, T_arg3 _A_a3, T_arg4 _A_a4, T_arg5 _A_a5, T_arg6 _A_a6, T_arg7 _A_a7)
 Invokes the wrapped functor passing on the arguments.
 
- Public Member Functions inherited from sigc::adapts< T_functor >
 adapts (const T_functor & _A_functor)
 Constructs an adaptor that wraps the passed functor.
 

Public Attributes

bound_argument< T_returnret_value_
 The fixed return value.
 
- Public Attributes inherited from sigc::adapts< T_functor >
adaptor_type functor_
 Adaptor that is invoked from operator()().
 

Detailed Description

template <class T_return, class T_functor>
struct sigc::bind_return_functor< T_return, T_functor >

Adaptor that fixes the return value of the wrapped functor.

Use the convenience function sigc::bind_return() to create an instance of sigc::bind_return_functor.

The following template arguments are used:

  • T_return Type of the fixed return value.
  • T_functor Type of the functor to wrap.

Member Typedef Documentation

◆ result_type

template <class T_return, class T_functor>
typedef unwrap_reference<T_return>::type sigc::bind_return_functor< T_return, T_functor >::result_type

Constructor & Destructor Documentation

◆ bind_return_functor()

template <class T_return, class T_functor>
sigc::bind_return_functor< T_return, T_functor >::bind_return_functor ( type_trait_take_t< T_functor > _A_functor,
type_trait_take_t< T_return > _A_ret_value )
inline

Constructs a bind_return_functor object that fixes the return value to _A_ret_value.

Parameters
_A_functorFunctor to invoke from operator()().
_A_ret_valueValue to return from operator()().

Member Function Documentation

◆ operator()() [1/8]

template <class T_return, class T_functor>
unwrap_reference< T_return >::type sigc::bind_return_functor< T_return, T_functor >::operator() ( )

Invokes the wrapped functor dropping its return value.

Returns
The fixed return value.

◆ operator()() [2/8]

template <class T_return, class T_functor>
template <class T_arg1>
unwrap_reference< T_return >::type sigc::bind_return_functor< T_return, T_functor >::operator() ( T_arg1 _A_a1)
inline

Invokes the wrapped functor passing on the arguments.

Parameters
_A_a1Argument to be passed on to the functor.
Returns
The fixed return value.

◆ operator()() [3/8]

template <class T_return, class T_functor>
template <class T_arg1, class T_arg2>
unwrap_reference< T_return >::type sigc::bind_return_functor< T_return, T_functor >::operator() ( T_arg1 _A_a1,
T_arg2 _A_a2 )
inline

Invokes the wrapped functor passing on the arguments.

Parameters
_A_a1Argument to be passed on to the functor.
_A_a2Argument to be passed on to the functor.
Returns
The fixed return value.

◆ operator()() [4/8]

template <class T_return, class T_functor>
template <class T_arg1, class T_arg2, class T_arg3>
unwrap_reference< T_return >::type sigc::bind_return_functor< T_return, T_functor >::operator() ( T_arg1 _A_a1,
T_arg2 _A_a2,
T_arg3 _A_a3 )
inline

Invokes the wrapped functor passing on the arguments.

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.
Returns
The fixed return value.

◆ operator()() [5/8]

template <class T_return, class T_functor>
template <class T_arg1, class T_arg2, class T_arg3, class T_arg4>
unwrap_reference< T_return >::type sigc::bind_return_functor< T_return, T_functor >::operator() ( T_arg1 _A_a1,
T_arg2 _A_a2,
T_arg3 _A_a3,
T_arg4 _A_a4 )
inline

Invokes the wrapped functor passing on the arguments.

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 fixed return value.

◆ operator()() [6/8]

template <class T_return, class T_functor>
template <class T_arg1, class T_arg2, class T_arg3, class T_arg4, class T_arg5>
unwrap_reference< T_return >::type sigc::bind_return_functor< T_return, T_functor >::operator() ( T_arg1 _A_a1,
T_arg2 _A_a2,
T_arg3 _A_a3,
T_arg4 _A_a4,
T_arg5 _A_a5 )
inline

Invokes the wrapped functor passing on the arguments.

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.
_A_a5Argument to be passed on to the functor.
Returns
The fixed return value.

◆ operator()() [7/8]

template <class T_return, class T_functor>
template <class T_arg1, class T_arg2, class T_arg3, class T_arg4, class T_arg5, class T_arg6>
unwrap_reference< T_return >::type sigc::bind_return_functor< T_return, T_functor >::operator() ( T_arg1 _A_a1,
T_arg2 _A_a2,
T_arg3 _A_a3,
T_arg4 _A_a4,
T_arg5 _A_a5,
T_arg6 _A_a6 )
inline

Invokes the wrapped functor passing on the arguments.

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.
_A_a5Argument to be passed on to the functor.
_A_a6Argument to be passed on to the functor.
Returns
The fixed return value.

◆ operator()() [8/8]

template <class T_return, class T_functor>
template <class T_arg1, class T_arg2, class T_arg3, class T_arg4, class T_arg5, class T_arg6, class T_arg7>
unwrap_reference< T_return >::type sigc::bind_return_functor< T_return, T_functor >::operator() ( T_arg1 _A_a1,
T_arg2 _A_a2,
T_arg3 _A_a3,
T_arg4 _A_a4,
T_arg5 _A_a5,
T_arg6 _A_a6,
T_arg7 _A_a7 )
inline

Invokes the wrapped functor passing on the arguments.

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.
_A_a5Argument to be passed on to the functor.
_A_a6Argument to be passed on to the functor.
_A_a7Argument to be passed on to the functor.
Returns
The fixed return value.

Member Data Documentation

◆ ret_value_

template <class T_return, class T_functor>
bound_argument<T_return> sigc::bind_return_functor< T_return, T_functor >::ret_value_

The fixed return value.