libsigc++: sigc::const_volatile_mem_functor2< T_return, T_obj, T_arg1, T_arg2 > Class Template Reference

const_volatile_mem_functor2 wraps const volatile methods with 2 argument(s). More...

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

Inheritance diagram for sigc::const_volatile_mem_functor2< T_return, T_obj, T_arg1, T_arg2 >:

Public Types

typedef T_return(T_obj::* function_type) (T_arg1, T_arg2) const volatile
 
typedef T_return result_type
 

Public Member Functions

 const_volatile_mem_functor2 ()
 Constructs an invalid functor. More...

 
 const_volatile_mem_functor2 (function_type _A_func)
 Constructs a const_volatile_mem_functor2 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) 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) const
 Execute the wrapped method operating on the passed instance. More...

 

Protected Attributes

function_type func_ptr_
 

Detailed Description

template<class T_return, class T_obj, class T_arg1, class T_arg2>

class sigc::const_volatile_mem_functor2< T_return, T_obj, T_arg1, T_arg2 >

const_volatile_mem_functor2 wraps const volatile methods with 2 argument(s).

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

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_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 >
typedef T_return(T_obj::* sigc::const_volatile_mem_functor2< T_return, T_obj, T_arg1, T_arg2 >::function_type) (T_arg1, T_arg2) const volatile
template <class T_return , class T_obj , class T_arg1 , class T_arg2 >
typedef T_return sigc::const_volatile_mem_functor2< T_return, T_obj, T_arg1, T_arg2 >::result_type

Constructor & Destructor Documentation

template <class T_return , class T_obj , class T_arg1 , class T_arg2 >
sigc::const_volatile_mem_functor2< T_return, T_obj, T_arg1, T_arg2 >::const_volatile_mem_functor2 ( )
inline

Constructs an invalid functor.

template <class T_return , class T_obj , class T_arg1 , class T_arg2 >
sigc::const_volatile_mem_functor2< T_return, T_obj, T_arg1, T_arg2 >::const_volatile_mem_functor2 ( function_type  _A_func)
inlineexplicit

Constructs a const_volatile_mem_functor2 object that wraps the passed method.

Parameters
_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 >
T_return sigc::const_volatile_mem_functor2< T_return, T_obj, T_arg1, T_arg2 >::operator() ( const T_obj *  _A_obj,
type_trait_take_t< T_arg1 >  _A_a1,
type_trait_take_t< T_arg2 >  _A_a2 
) const
inline

Execute the wrapped method operating on the passed instance.

Deprecated:
Please use the constructor that takes the object by reference instead.
Parameters
_A_objPointer to instance the method should operate on.
_A_a1Argument to be passed on to the method.
_A_a2Argument to be passed on to the method.
Returns
The return value of the method invocation.
template <class T_return , class T_obj , class T_arg1 , class T_arg2 >
T_return sigc::const_volatile_mem_functor2< T_return, T_obj, T_arg1, T_arg2 >::operator() ( const T_obj &  _A_obj,
type_trait_take_t< T_arg1 >  _A_a1,
type_trait_take_t< T_arg2 >  _A_a2 
) const
inline

Execute the wrapped method operating on the passed instance.

Parameters
_A_objReference to instance the method should operate on.
_A_a1Argument to be passed on to the method.
_A_a2Argument 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 >
function_type sigc::const_volatile_mem_functor2< T_return, T_obj, T_arg1, T_arg2 >::func_ptr_
protected