<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>libsigc++: Adaptors</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.7.2 --> <div class="navigation" id="top"> <div class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="namespaces.html"><span>Namespaces</span></a></li> <li><a href="annotated.html"><span>Classes</span></a></li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#nested-classes">Classes</a> | <a href="#groups">Modules</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <h1>Adaptors</h1> </div> </div> <div class="contents"> <p>Adaptors are functors that alter the signature of a functor's operator()(). <a href="#_details">More...</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="nested-classes"></a> Classes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1adaptor__base.html">sigc::adaptor_base</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">A hint to the compiler. <a href="structsigc_1_1adaptor__base.html#_details">More...</a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1deduce__result__type.html">sigc::deduce_result_type< T_functor, T_arg1, T_arg2, T_arg3, T_arg4, T_arg5, T_arg6, T_arg7, I_derives_adaptor_base ></a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Deduce the return type of a functor. <a href="structsigc_1_1deduce__result__type.html#_details">More...</a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1adaptor__functor.html">sigc::adaptor_functor< T_functor ></a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Converts an arbitrary functor into an adaptor type. <a href="structsigc_1_1adaptor__functor.html#_details">More...</a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1adapts.html">sigc::adapts< T_functor ></a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Base type for adaptors. <a href="structsigc_1_1adapts.html#_details">More...</a><br/></td></tr> <tr><td colspan="2"><h2><a name="groups"></a> Modules</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__bind.html">bind(), bind_return()</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>sigc::bind() alters an arbitrary functor by fixing arguments to certain values. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__hide.html">hide(), hide_return()</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>sigc::hide() alters an arbitrary functor in that it adds a parameter whose value is ignored on invocation of the returned functor. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__retype.html">retype(), retype_return()</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>sigc::retype() alters a sigc::pointer_functor, a sigc::mem_functor or a <a class="el" href="classsigc_1_1slot.html" title="Convenience wrapper for the numbered sigc::slot# templates.">sigc::slot</a> in that it makes C-style casts to the functor's parameter types of all parameters passed through operator()(). </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__compose.html">compose()</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>sigc::compose() combines two or three arbitrary functors. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__exception__catch.html">exception_catch()</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>sigc::exception_catch() catches an exception thrown from within the wrapped functor and directs it to a catcher functor. </p> <br/></td></tr> </p> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__group__.html">group()</a></td></tr> <p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>sigc::group() alters an arbitrary functor by rebuilding its arguments from one or more lambda expressions. </p> <br/></td></tr> </p> <tr><td colspan="2"><h2><a name="func-members"></a> Functions</h2></td></tr> <tr><td class="memTemplParams" colspan="2">template<class T_action , class T_functor > </td></tr> <tr><td class="memTemplItemLeft" align="right" valign="top">void </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="group__adaptors.html#gafb822cac23e9bf97c164793a36246d5c">sigc::visit_each</a> (const T_action& _A_action, const adaptor_functor< T_functor >& _A_target)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Performs a functor on each of the targets of a functor. <a href="#gafb822cac23e9bf97c164793a36246d5c"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Adaptors are functors that alter the signature of a functor's operator()(). </p> <p>The adaptor types libsigc++ provides are created with <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a01178.html#ga14c36eec6e128c2003e69170f5804a2e">bind()</a>, <a class="el" href="group__bind.html#ga8a001b0bb588d2ac1af712781b89dc8a" title="Creates an adaptor of type sigc::bind_return_functor which fixes the return value of the passed funct...">bind_return()</a>, <a class="el" href="group__hide.html#gaf28d43958b26c67e314f726540463c44" title="Creates an adaptor of type sigc::hide_functor which adds a dummy parameter to the passed functor...">hide()</a>, <a class="el" href="group__hide.html#gad7e18e1edbbefe13216eb344bd522f0a" title="Creates an adaptor of type sigc::retype_return_functor which drops the return value of the passed fun...">hide_return()</a>, <a class="el" href="group__retype.html#ga263b14f3b0e5616cd3b870d78a2627fa" title="Creates an adaptor of type sigc::retype_return_functor which performs a C-style cast on the return va...">retype_return()</a>, <a class="el" href="group__retype.html#gafd118b8e28ec60f260d8182c0552f9b2" title="Creates an adaptor of type sigc::retype_functor which performs C-style casts on the parameters passed...">retype()</a>, <a class="el" href="group__compose.html#ga57692495ec80dd855d4653adde4c8f49" title="Creates an adaptor of type sigc::compose1_functor which combines two functors.">compose()</a>, exception_catch() and group().</p> <p>You can easily derive your own adaptor type from <a class="el" href="structsigc_1_1adapts.html" title="Base type for adaptors.">sigc::adapts</a>. </p> <hr/><h2>Function Documentation</h2> <a class="anchor" id="gafb822cac23e9bf97c164793a36246d5c"></a><!-- doxytag: member="sigc::visit_each" ref="gafb822cac23e9bf97c164793a36246d5c" args="(const T_action &_A_action, const adaptor_functor< T_functor > &_A_target)" --> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template <class T_action , class T_functor > </div> <table class="memname"> <tr> <td class="memname">void sigc::visit_each </td> <td>(</td> <td class="paramtype">const T_action & </td> <td class="paramname"> <em>_A_action</em>, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const adaptor_functor< T_functor > & </td> <td class="paramname"> <em>_A_target</em> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Performs a functor on each of the targets of a functor. </p> <p>The function overload for <a class="el" href="structsigc_1_1adaptor__functor.html" title="Converts an arbitrary functor into an adaptor type.">sigc::adaptor_functor</a> performs a functor on the functor stored in the <a class="el" href="structsigc_1_1adaptor__functor.html" title="Converts an arbitrary functor into an adaptor type.">sigc::adaptor_functor</a> object. </p> </div> </div> </div> <hr class="footer"/><address class="footer"><small>Generated on Tue Mar 8 2011 11:44:40 for libsigc++ by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address> </body> </html>