untracked/docs/reference/html/classsigc_1_1bound__argument_3_01std_1_1reference__wrapper_3_01T__wrapped_01_4_01_4.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++: sigc::bound_argument&lt; std::reference_wrapper&lt; T_wrapped &gt; &gt; Class Template Reference</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 id="nav-path" class="navpath">
  42   <ul>
  43 <li class="navelem"><a class="el" href="namespacesigc.html">sigc</a></li><li class="navelem"><a class="el" href="classsigc_1_1bound__argument_3_01std_1_1reference__wrapper_3_01T__wrapped_01_4_01_4.html">bound_argument&lt; std::reference_wrapper&lt; T_wrapped &gt; &gt;</a></li>  </ul>
  44 </div>
  45 </div><!-- top -->
  46 <div class="header">
  47   <div class="summary">
  48 <a href="#pub-methods">Public Member Functions</a> &#124;
  49 <a href="classsigc_1_1bound__argument_3_01std_1_1reference__wrapper_3_01T__wrapped_01_4_01_4-members.html">List of all members</a>  </div>
  50   <div class="headertitle">
  51 <div class="title">sigc::bound_argument&lt; std::reference_wrapper&lt; T_wrapped &gt; &gt; Class Template Reference</div>  </div>
  52 </div><!--header-->
  53 <div class="contents">
  54
  55 <p><a class="el" href="classsigc_1_1bound__argument.html" title="A bound_argument&lt;Foo&gt; object stores a bound (for instance, with sigc::bind(), or sigc::bind_return())...">bound_argument</a> object for a bound argument that is passed by <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> or returned by <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> by reference, specialized for std::reference_wrapper&lt;&gt; types.
  56  <a href="classsigc_1_1bound__argument_3_01std_1_1reference__wrapper_3_01T__wrapped_01_4_01_4.html#details">More...</a></p>
  57
  58 <p><code>#include &lt;sigc++/adaptors/bound_argument.h&gt;</code></p>
  59 <table class="memberdecls">
  60 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  61 Public Member Functions</h2></td></tr>
  62 <tr class="memitem:a597709183c9a0b753f4674aaab80b4ff"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1bound__argument_3_01std_1_1reference__wrapper_3_01T__wrapped_01_4_01_4.html#a597709183c9a0b753f4674aaab80b4ff">bound_argument</a> (const <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a03225.html">std::reference_wrapper</a>&lt; T_wrapped &gt; &amp; _A_argument)</td></tr>
  63 <tr class="memdesc:a597709183c9a0b753f4674aaab80b4ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="classsigc_1_1bound__argument_3_01std_1_1reference__wrapper_3_01T__wrapped_01_4_01_4.html#a597709183c9a0b753f4674aaab80b4ff">More...</a><br /></td></tr>
  64 <tr class="separator:a597709183c9a0b753f4674aaab80b4ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65 <tr class="memitem:a38950827998907494c25397f01552730"><td class="memItemLeft" align="right" valign="top">T_wrapped &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1bound__argument_3_01std_1_1reference__wrapper_3_01T__wrapped_01_4_01_4.html#a38950827998907494c25397f01552730">invoke</a> ()</td></tr>
  66 <tr class="memdesc:a38950827998907494c25397f01552730"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the entity to pass to the bound functor or return.  <a href="classsigc_1_1bound__argument_3_01std_1_1reference__wrapper_3_01T__wrapped_01_4_01_4.html#a38950827998907494c25397f01552730">More...</a><br /></td></tr>
  67 <tr class="separator:a38950827998907494c25397f01552730"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68 <tr class="memitem:a3d34b13540ac33e677024727ffd3a36e"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classsigc_1_1limit__reference.html">limit_reference</a>&lt; T_wrapped &gt; &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1bound__argument_3_01std_1_1reference__wrapper_3_01T__wrapped_01_4_01_4.html#a3d34b13540ac33e677024727ffd3a36e">visit</a> () const</td></tr>
  69 <tr class="memdesc:a3d34b13540ac33e677024727ffd3a36e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the entity to visit in <a class="el" href="group__sigcfunctors.html#ga64cb7832acc1e58efb5ffe0b4f5e9404" title="This function performs a functor on each of the targets of a functor.">visit_each()</a>.  <a href="classsigc_1_1bound__argument_3_01std_1_1reference__wrapper_3_01T__wrapped_01_4_01_4.html#a3d34b13540ac33e677024727ffd3a36e">More...</a><br /></td></tr>
  70 <tr class="separator:a3d34b13540ac33e677024727ffd3a36e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  71 </table>
  72 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  73 <div class="textblock"><h3>template&lt;class T_wrapped&gt;<br />
  74 class sigc::bound_argument&lt; std::reference_wrapper&lt; T_wrapped &gt; &gt;</h3>
  75
  76 <p><a class="el" href="classsigc_1_1bound__argument.html" title="A bound_argument&lt;Foo&gt; object stores a bound (for instance, with sigc::bind(), or sigc::bind_return())...">bound_argument</a> object for a bound argument that is passed by <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> or returned by <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> by reference, specialized for std::reference_wrapper&lt;&gt; types. </p>
  77 <p><em>T_wrapped</em> The type of the bound argument. </p>
  78 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  79 <a id="a597709183c9a0b753f4674aaab80b4ff"></a>
  80 <h2 class="memtitle"><span class="permalink"><a href="#a597709183c9a0b753f4674aaab80b4ff">&#9670;&#160;</a></span>bound_argument()</h2>
  81
  82 <div class="memitem">
  83 <div class="memproto">
  84 <div class="memtemplate">
  85 template &lt;class T_wrapped &gt; </div>
  86 <table class="mlabels">
  87   <tr>
  88   <td class="mlabels-left">
  89       <table class="memname">
  90         <tr>
  91           <td class="memname"><a class="el" href="classsigc_1_1bound__argument.html">sigc::bound_argument</a>&lt; <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a03225.html">std::reference_wrapper</a>&lt; T_wrapped &gt; &gt;::<a class="el" href="classsigc_1_1bound__argument.html">bound_argument</a> </td>
  92           <td>(</td>
  93           <td class="paramtype">const <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a03225.html">std::reference_wrapper</a>&lt; T_wrapped &gt; &amp;&#160;</td>
  94           <td class="paramname"><em>_A_argument</em></td><td>)</td>
  95           <td></td>
  96         </tr>
  97       </table>
  98   </td>
  99   <td class="mlabels-right">
 100 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 101   </tr>
 102 </table>
 103 </div><div class="memdoc">
 104
 105 <p>Constructor. </p>
 106 <dl class="params"><dt>Parameters</dt><dd>
 107   <table class="params">
 108     <tr><td class="paramname">_A_argument</td><td>The argument to bind. </td></tr>
 109   </table>
 110   </dd>
 111 </dl>
 112
 113 </div>
 114 </div>
 115 <h2 class="groupheader">Member Function Documentation</h2>
 116 <a id="a38950827998907494c25397f01552730"></a>
 117 <h2 class="memtitle"><span class="permalink"><a href="#a38950827998907494c25397f01552730">&#9670;&#160;</a></span>invoke()</h2>
 118
 119 <div class="memitem">
 120 <div class="memproto">
 121 <div class="memtemplate">
 122 template &lt;class T_wrapped &gt; </div>
 123 <table class="mlabels">
 124   <tr>
 125   <td class="mlabels-left">
 126       <table class="memname">
 127         <tr>
 128           <td class="memname">T_wrapped&amp; <a class="el" href="classsigc_1_1bound__argument.html">sigc::bound_argument</a>&lt; <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a03225.html">std::reference_wrapper</a>&lt; T_wrapped &gt; &gt;::invoke </td>
 129           <td>(</td>
 130           <td class="paramname"></td><td>)</td>
 131           <td></td>
 132         </tr>
 133       </table>
 134   </td>
 135   <td class="mlabels-right">
 136 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 137   </tr>
 138 </table>
 139 </div><div class="memdoc">
 140
 141 <p>Retrieve the entity to pass to the bound functor or return. </p>
 142 <dl class="section return"><dt>Returns</dt><dd>The bound argument. </dd></dl>
 143
 144 </div>
 145 </div>
 146 <a id="a3d34b13540ac33e677024727ffd3a36e"></a>
 147 <h2 class="memtitle"><span class="permalink"><a href="#a3d34b13540ac33e677024727ffd3a36e">&#9670;&#160;</a></span>visit()</h2>
 148
 149 <div class="memitem">
 150 <div class="memproto">
 151 <div class="memtemplate">
 152 template &lt;class T_wrapped &gt; </div>
 153 <table class="mlabels">
 154   <tr>
 155   <td class="mlabels-left">
 156       <table class="memname">
 157         <tr>
 158           <td class="memname">const <a class="el" href="classsigc_1_1limit__reference.html">limit_reference</a>&lt;T_wrapped&gt;&amp; <a class="el" href="classsigc_1_1bound__argument.html">sigc::bound_argument</a>&lt; <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a03225.html">std::reference_wrapper</a>&lt; T_wrapped &gt; &gt;::visit </td>
 159           <td>(</td>
 160           <td class="paramname"></td><td>)</td>
 161           <td> const</td>
 162         </tr>
 163       </table>
 164   </td>
 165   <td class="mlabels-right">
 166 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 167   </tr>
 168 </table>
 169 </div><div class="memdoc">
 170
 171 <p>Retrieve the entity to visit in <a class="el" href="group__sigcfunctors.html#ga64cb7832acc1e58efb5ffe0b4f5e9404" title="This function performs a functor on each of the targets of a functor.">visit_each()</a>. </p>
 172 <dl class="section return"><dt>Returns</dt><dd>The limited_reference to the bound argument. </dd></dl>
 173
 174 </div>
 175 </div>
 176 </div><!-- contents -->
 177 <!-- start footer part -->
 178 <hr class="footer"/><address class="footer"><small>
 179 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
 180 </small></address>
 181 </body>
 182 </html>