libsigc++: sigc::bound_const_mem_functor5< T_return, T_obj, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5 > Class Template Reference

bound_const_mem_functor5 encapsulates a const method with 5 arguments and an object instance. More...

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

Inheritance diagram for sigc::bound_const_mem_functor5< T_return, T_obj, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5 >:

Public Types

typedef base_type_::function_type function_type
 
- Public Types inherited from sigc::const_mem_functor5< T_return, T_obj, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5 >
typedef T_return(T_obj::* function_type) (T_arg1, T_arg2, T_arg3, T_arg4, T_arg5) const
 
typedef T_return result_type
 

Public Member Functions

 bound_const_mem_functor5 (const T_obj* _A_obj, function_type _A_func)
 Constructs a bound_const_mem_functor5 object that wraps the passed method. More...

 
 bound_const_mem_functor5 (const T_obj& _A_obj, function_type _A_func)
 Constructs a bound_const_mem_functor5 object that wraps the passed method. More...

 
T_return operator() (type_trait_take_t< T_arg1 > _A_a1, type_trait_take_t< T_arg2 > _A_a2, type_trait_take_t< T_arg3 > _A_a3, type_trait_take_t< T_arg4 > _A_a4, type_trait_take_t< T_arg5 > _A_a5) const
 Execute the wrapped method operating on the stored instance. More...

 
- Public Member Functions inherited from sigc::const_mem_functor5< T_return, T_obj, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5 >
 const_mem_functor5 ()
 Constructs an invalid functor. More...

 
 const_mem_functor5 (function_type _A_func)
 Constructs a const_mem_functor5 object that wraps the passed method. More...

 
T_return operator() (const T_obj* _A_obj, type_trait_take_t< T_arg1 > _A_a1, type_trait_take_t< T_arg2 > _A_a2, type_trait_take_t< T_arg3 > _A_a3, type_trait_take_t< T_arg4 > _A_a4, type_trait_take_t< T_arg5 > _A_a5) const
 Execute the wrapped method operating on the passed instance. More...

 
T_return operator() (const T_obj& _A_obj, type_trait_take_t< T_arg1 > _A_a1, type_trait_take_t< T_arg2 > _A_a2, type_trait_take_t< T_arg3 > _A_a3, type_trait_take_t< T_arg4 > _A_a4, type_trait_take_t< T_arg5 > _A_a5) const
 Execute the wrapped method operating on the passed instance. More...

 

Public Attributes

const_limit_reference< T_obj > obj_
 

Additional Inherited Members

- Protected Attributes inherited from sigc::const_mem_functor5< T_return, T_obj, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5 >
function_type func_ptr_
 

Detailed Description

template<class T_return, class T_obj, class T_arg1, class T_arg2, class T_arg3, class T_arg4, class T_arg5>

class sigc::bound_const_mem_functor5< T_return, T_obj, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5 >

bound_const_mem_functor5 encapsulates a const method with 5 arguments and an object instance.

Use the convenience function mem_fun() to create an instance of bound_const_mem_functor5.

The following template arguments are used:

  • T_arg1 Argument type used in the definition of operator()().
  • T_arg2 Argument type used in the definition of operator()().
  • T_arg3 Argument type used in the definition of operator()().
  • T_arg4 Argument type used in the definition of operator()().
  • T_arg5 Argument type used in the definition of operator()().
  • T_return The return type of operator()().
  • T_obj The object type.

Member Typedef Documentation

template <class T_return , class T_obj , class T_arg1 , class T_arg2 , class T_arg3 , class T_arg4 , class T_arg5 >
typedef base_type_::function_type sigc::bound_const_mem_functor5< T_return, T_obj, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5 >::function_type

Constructor & Destructor Documentation

template <class T_return , class T_obj , class T_arg1 , class T_arg2 , class T_arg3 , class T_arg4 , class T_arg5 >
sigc::bound_const_mem_functor5< T_return, T_obj, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5 >::bound_const_mem_functor5 ( const T_obj *  _A_obj,
function_type  _A_func 
)
inline

Constructs a bound_const_mem_functor5 object that wraps the passed method.

Deprecated:
Please use the constructor that takes the object by reference instead.
Parameters
_A_objPointer to instance the method will operate on.
_A_funcPointer to method will be invoked from operator()().
template <class T_return , class T_obj , class T_arg1 , class T_arg2 , class T_arg3 , class T_arg4 , class T_arg5 >
sigc::bound_const_mem_functor5< T_return, T_obj, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5 >::bound_const_mem_functor5 ( const T_obj &  _A_obj,
function_type  _A_func 
)
inline

Constructs a bound_const_mem_functor5 object that wraps the passed method.

Parameters
_A_objReference to instance the method will operate on.
_A_funcPointer to method will be invoked from operator()().

Member Function Documentation

template <class T_return , class T_obj , class T_arg1 , class T_arg2 , class T_arg3 , class T_arg4 , class T_arg5 >
T_return sigc::bound_const_mem_functor5< T_return, T_obj, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5 >::operator() ( type_trait_take_t< T_arg1 >  _A_a1,
type_trait_take_t< T_arg2 >  _A_a2,
type_trait_take_t< T_arg3 >  _A_a3,
type_trait_take_t< T_arg4 >  _A_a4,
type_trait_take_t< T_arg5 >  _A_a5 
) const
inline

Execute the wrapped method operating on the stored instance.

Parameters
_A_a1Argument to be passed on to the method.
_A_a2Argument to be passed on to the method.
_A_a3Argument to be passed on to the method.
_A_a4Argument to be passed on to the method.
_A_a5Argument to be passed on to the method.
Returns
The return value of the method invocation.

Member Data Documentation

template <class T_return , class T_obj , class T_arg1 , class T_arg2 , class T_arg3 , class T_arg4 , class T_arg5 >
const_limit_reference<T_obj> sigc::bound_const_mem_functor5< T_return, T_obj, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5 >::obj_