untracked/docs/reference/html/group__adaptors.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>libsigc++: Adaptors</title>
   9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  10 <script type="text/javascript" src="jquery.js"></script>
  11 <script type="text/javascript" src="dynsections.js"></script>
  12 <link href="doxygen.css" rel="stylesheet" type="text/css" />
  13 <link href="doxygen-extra.css" rel="stylesheet" type="text/css"/>
  14 </head>
  15 <body>
  16 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  17 <div id="titlearea">
  18 <table cellspacing="0" cellpadding="0">
  19  <tbody>
  20  <tr style="height: 56px;">
  21   <td id="projectalign" style="padding-left: 0.5em;">
  22    <div id="projectname">libsigc++
  23    &#160;<span id="projectnumber">2.10.8</span>
  24    </div>
  25   </td>
  26  </tr>
  27  </tbody>
  28 </table>
  29 </div>
  30 <!-- end header part -->
  31 <!-- Generated by Doxygen 1.9.1 -->
  32 <script type="text/javascript" src="menudata.js"></script>
  33 <script type="text/javascript" src="menu.js"></script>
  34 <script type="text/javascript">
  35 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  36 $(function() {
  37   initMenu('',false,false,'search.php','Search');
  38 });
  39 /* @license-end */</script>
  40 <div id="main-nav"></div>
  41 </div><!-- top -->
  42 <div class="header">
  43   <div class="summary">
  44 <a href="#groups">Modules</a> &#124;
  45 <a href="#nested-classes">Classes</a>  </div>
  46   <div class="headertitle">
  47 <div class="title">Adaptors</div>  </div>
  48 </div><!--header-->
  49 <div class="contents">
  50
  51 <p>Adaptors are functors that alter the signature of a functor's operator()().
  52 <a href="#details">More...</a></p>
  53 <table class="memberdecls">
  54 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
  55 Modules</h2></td></tr>
  56 <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>
  57 <tr class="memdesc:group__bind"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="group__bind.html#ga2f099bc6056b32f2a58134ba8537c6f4" 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>
  58 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  59 <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>
  60 <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>
  61 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  62 <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>
  63 <tr class="memdesc:group__exception__catch"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="namespacesigc.html#a0ae3b8a1ba26920cee4d7d9df2c39ed9">sigc::exception_catch()</a> catches an exception thrown from within the wrapped functor and directs it to a catcher functor. <br /></td></tr>
  64 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65 <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>
  66 <tr class="memdesc:group__hide"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="group__hide.html#gaf2cefea3a99acd44f68121424103172d" 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>
  67 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68 <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>
  69 <tr class="memdesc:group__retype"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="group__retype.html#ga8b98eeb2a61b5b1f84dcd1d20fe666f1" title="Creates an adaptor of type sigc::retype_functor which performs C-style casts on the parameters passed...">sigc::retype()</a> 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()(). <br /></td></tr>
  70 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71 <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>
  72 <tr class="memdesc:group__track__obj"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="group__track__obj.html#ga8fd1ab36d123ff83dd4cd8dc58bb28e2" title="Creates an adaptor of type sigc::track_obj_functor1 which wraps a functor.">sigc::track_obj()</a> tracks trackable objects, referenced from a functor. <br /></td></tr>
  73 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  74 </table><table class="memberdecls">
  75 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
  76 Classes</h2></td></tr>
  77 <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>
  78 <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>
  79 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  80 <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>
  81 <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>
  82 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  83 <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>
  84 <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>
  85 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  86 <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>
  87 <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>
  88 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  89 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsigc_1_1deduce__result__type.html">sigc::deduce_result_type&lt; T_functor, T_args &gt;</a></td></tr>
  90 <tr class="memdesc:"><td class="mdescLeft">&#160;</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>
  91 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
  92 </table>
  93 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  94 <p>Adaptors are functors that alter the signature of a functor's operator()(). </p>
  95 <p>The adaptor types libsigc++ provides are created with <a class="el" href="group__bind.html#ga2f099bc6056b32f2a58134ba8537c6f4" 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#gaf2cefea3a99acd44f68121424103172d" 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#ga8b98eeb2a61b5b1f84dcd1d20fe666f1" 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#a0ae3b8a1ba26920cee4d7d9df2c39ed9">exception_catch()</a>, <a class="el" href="group__track__obj.html#ga8fd1ab36d123ff83dd4cd8dc58bb28e2" title="Creates an adaptor of type sigc::track_obj_functor1 which wraps a functor.">track_obj()</a> and group().</p>
  96 <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>
  97 </div><!-- contents -->
  98 <!-- start footer part -->
  99 <hr class="footer"/><address class="footer"><small>
 100 Generated on Fri Feb 11 2022 15:40:57 for libsigc++ by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
 101 </small></address>
 102 </body>
 103 </html>