docs/reference/html/group__adaptors.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
   6 <meta name="generator" content="Doxygen 1.8.9.1"/>
   7 <title>libsigc++: Adaptors</title>
   8 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   9 <script type="text/javascript" src="jquery.js"></script>
  10 <script type="text/javascript" src="dynsections.js"></script>
  11 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12 <link href="doxygen-extra.css" rel="stylesheet" type="text/css"/>
  13 </head>
  14 <body>
  15 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16 <div id="titlearea">
  17 <table cellspacing="0" cellpadding="0">
  18  <tbody>
  19  <tr style="height: 56px;">
  20   <td style="padding-left: 0.5em;">
  21    <div id="projectname">libsigc++
  22    &#160;<span id="projectnumber">2.99.2</span>
  23    </div>
  24   </td>
  25  </tr>
  26  </tbody>
  27 </table>
  28 </div>
  29 <!-- end header part -->
  30 <!-- Generated by Doxygen 1.8.9.1 -->
  31   <div id="navrow1" class="tabs">
  32     <ul class="tablist">
  33       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  34       <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  35       <li><a href="modules.html"><span>Modules</span></a></li>
  36       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  37       <li><a href="annotated.html"><span>Classes</span></a></li>
  38     </ul>
  39   </div>
  40 </div><!-- top -->
  41 <div class="header">
  42   <div class="summary">
  43 <a href="#groups">Modules</a> &#124;
  44 <a href="#nested-classes">Classes</a>  </div>
  45   <div class="headertitle">
  46 <div class="title">Adaptors</div>  </div>
  47 </div><!--header-->
  48 <div class="contents">
  49
  50 <p>Adaptors are functors that alter the signature of a functor's operator()().
  51 <a href="#details">More...</a></p>
  52 <table class="memberdecls">
  53 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
  54 Modules</h2></td></tr>
  55 <tr class="memitem:group__bind"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__bind.html">bind(), bind_return()</a></td></tr>
  56 <tr class="memdesc:group__bind"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="group__bind.html#ga9ce84730439c5e1c688bc18c102e81ca" title="Creates an adaptor of type sigc::bind_functor which binds the passed argument to the passed functor...">sigc::bind()</a> alters an arbitrary functor by fixing arguments to certain values. <br /></td></tr>
  57 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  58 <tr class="memitem:group__compose"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__compose.html">compose()</a></td></tr>
  59 <tr class="memdesc:group__compose"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="group__compose.html#ga34cf5da8f6323bfdc41bc7113d6ad20a" title="Creates an adaptor of type sigc::compose1_functor which combines two functors. ">sigc::compose()</a> combines two or three arbitrary functors. <br /></td></tr>
  60 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  61 <tr class="memitem:group__exception__catch"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__exception__catch.html">exception_catch()</a></td></tr>
  62 <tr class="memdesc:group__exception__catch"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="namespacesigc.html#adc5264be500bc695232d72de44eb34e6">sigc::exception_catch()</a> catches an exception thrown from within the wrapped functor and directs it to a catcher functor. <br /></td></tr>
  63 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  64 <tr class="memitem:group__hide"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__hide.html">hide(), hide_return()</a></td></tr>
  65 <tr class="memdesc:group__hide"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="group__hide.html#gaba7e613a3b4fc1a6c6188194c5c54849" title="Creates an adaptor of type sigc::hide_functor which adds a dummy parameter to the passed functor...">sigc::hide()</a> alters an arbitrary functor in that it adds a parameter whose value is ignored on invocation of the returned functor. <br /></td></tr>
  66 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  67 <tr class="memitem:group__retype"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__retype.html">retype(), retype_return()</a></td></tr>
  68 <tr class="memdesc:group__retype"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="group__retype.html#gab267b6108e8c758965d6d6e367549478" title="Creates an adaptor of type sigc::retype_functor which performs C-style casts on the parameters passed...">sigc::retype()</a> alters a <a class="el" href="classsigc_1_1pointer__functor.html" title="pointer_functor wraps existing non-member functions with, or without, arguments. ">sigc::pointer_functor</a>, a <a class="el" href="classsigc_1_1mem__functor.html">sigc::mem_functor</a> or a <a class="el" href="classsigc_1_1slot.html" title="Converts an arbitrary functor to a unified type which is opaque. ">sigc::slot</a> in that it makes C-style casts to the functor's parameter types of all parameters passed through operator()(). <br /></td></tr>
  69 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  70 <tr class="memitem:group__track__obj"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__track__obj.html">track_obj()</a></td></tr>
  71 <tr class="memdesc:group__track__obj"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="group__track__obj.html#ga2d8c46509a25df9c7ad37b8712d16ab1" title="Creates an adaptor of type sigc::track_obj_functor which wraps a functor. ">sigc::track_obj()</a> tracks trackable objects, referenced from a functor. <br /></td></tr>
  72 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73 </table><table class="memberdecls">
  74 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  75 Classes</h2></td></tr>
  76 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1adaptor__base.html">sigc::adaptor_base</a></td></tr>
  77 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">A hint to the compiler.  <a href="structsigc_1_1adaptor__base.html#details">More...</a><br /></td></tr>
  78 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  79 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1adaptor__functor.html">sigc::adaptor_functor&lt; T_functor &gt;</a></td></tr>
  80 <tr class="memdesc:"><td class="mdescLeft">&#160;</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>
  81 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  82 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1adaptor__trait.html">sigc::adaptor_trait&lt; T_functor, I_isadaptor &gt;</a></td></tr>
  83 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Trait that specifies what is the adaptor version of a functor type.  <a href="structsigc_1_1adaptor__trait.html#details">More...</a><br /></td></tr>
  84 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  85 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1adapts.html">sigc::adapts&lt; T_functor &gt;</a></td></tr>
  86 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Base type for adaptors.  <a href="structsigc_1_1adapts.html#details">More...</a><br /></td></tr>
  87 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  88 </table>
  89 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  90 <p>Adaptors are functors that alter the signature of a functor's operator()(). </p>
  91 <p>The adaptor types libsigc++ provides are created with <a class="el" href="group__bind.html#ga9ce84730439c5e1c688bc18c102e81ca" title="Creates an adaptor of type sigc::bind_functor which binds the passed argument to the passed functor...">bind()</a>, <a class="el" href="group__bind.html#gaca1ae2466988d67d00a5f2cd16c8d90a" 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#gaba7e613a3b4fc1a6c6188194c5c54849" 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#gae4e6f5491471c12440f1c5d480726b98" 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#ga23a8cdbc12c57fbef0866b5c51d71588" 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#gab267b6108e8c758965d6d6e367549478" 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#ga34cf5da8f6323bfdc41bc7113d6ad20a" title="Creates an adaptor of type sigc::compose1_functor which combines two functors. ">compose()</a>, <a class="el" href="namespacesigc.html#adc5264be500bc695232d72de44eb34e6">exception_catch()</a>, <a class="el" href="group__track__obj.html#ga2d8c46509a25df9c7ad37b8712d16ab1" title="Creates an adaptor of type sigc::track_obj_functor which wraps a functor. ">track_obj()</a> and group().</p>
  92 <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>
  93 </div><!-- contents -->
  94 <!-- start footer part -->
  95 <hr class="footer"/><address class="footer"><small>
  96 Generated on Wed Mar 16 2016 20:53:27 for libsigc++ by &#160;<a href="http://www.doxygen.org/index.html">
  97 <img class="footer" src="doxygen.png" alt="doxygen"/>
  98 </a> 1.8.9.1
  99 </small></address>
 100 </body>
 101 </html>