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" "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++: sigc::bound_argument&lt; std::reference_wrapper&lt; T_wrapped &gt; &gt; Class Template Reference</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 class="current"><a href="annotated.html"><span>Classes</span></a></li>
  38     </ul>
  39   </div>
  40   <div id="navrow2" class="tabs2">
  41     <ul class="tablist">
  42       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  43       <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  44       <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
  45       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  46     </ul>
  47   </div>
  48 <div id="nav-path" class="navpath">
  49   <ul>
  50 <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>
  51 </div>
  52 </div><!-- top -->
  53 <div class="header">
  54   <div class="summary">
  55 <a href="#pub-methods">Public Member Functions</a> &#124;
  56 <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>
  57   <div class="headertitle">
  58 <div class="title">sigc::bound_argument&lt; std::reference_wrapper&lt; T_wrapped &gt; &gt; Class Template Reference</div>  </div>
  59 </div><!--header-->
  60 <div class="contents">
  61
  62 <p><a class="el" href="classsigc_1_1bound__argument.html" title="A bound_argument<Foo> 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#ga9ce84730439c5e1c688bc18c102e81ca" 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.
  63  <a href="classsigc_1_1bound__argument_3_01std_1_1reference__wrapper_3_01T__wrapped_01_4_01_4.html#details">More...</a></p>
  64
  65 <p><code>#include &lt;sigc++/adaptors/bound_argument.h&gt;</code></p>
  66 <table class="memberdecls">
  67 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  68 Public Member Functions</h2></td></tr>
  69 <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" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00906.html">std::reference_wrapper</a>&lt; T_wrapped &gt;&amp; _A_argument)</td></tr>
  70 <tr class="memdesc:a597709183c9a0b753f4674aaab80b4ff"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a597709183c9a0b753f4674aaab80b4ff">More...</a><br /></td></tr>
  71 <tr class="separator:a597709183c9a0b753f4674aaab80b4ff"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72 <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>
  73 <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="#a38950827998907494c25397f01552730">More...</a><br /></td></tr>
  74 <tr class="separator:a38950827998907494c25397f01552730"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75 <tr class="memitem:ae6a4426ca39736a475bbcc81d7fcd9b2"><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#ae6a4426ca39736a475bbcc81d7fcd9b2">visit</a> () const </td></tr>
  76 <tr class="memdesc:ae6a4426ca39736a475bbcc81d7fcd9b2"><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="#ae6a4426ca39736a475bbcc81d7fcd9b2">More...</a><br /></td></tr>
  77 <tr class="separator:ae6a4426ca39736a475bbcc81d7fcd9b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78 </table>
  79 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  80 <div class="textblock"><h3>template&lt;class T_wrapped&gt;<br />
  81 class sigc::bound_argument&lt; std::reference_wrapper&lt; T_wrapped &gt; &gt;</h3>
  82
  83 <p><a class="el" href="classsigc_1_1bound__argument.html" title="A bound_argument<Foo> 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#ga9ce84730439c5e1c688bc18c102e81ca" 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>
  84 <p><em>T_wrapped</em> The type of the bound argument. </p>
  85 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  86 <a class="anchor" id="a597709183c9a0b753f4674aaab80b4ff"></a>
  87 <div class="memitem">
  88 <div class="memproto">
  89 <div class="memtemplate">
  90 template &lt;class T_wrapped &gt; </div>
  91 <table class="mlabels">
  92   <tr>
  93   <td class="mlabels-left">
  94       <table class="memname">
  95         <tr>
  96           <td class="memname"><a class="el" href="classsigc_1_1bound__argument.html">sigc::bound_argument</a>&lt; <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00906.html">std::reference_wrapper</a>&lt; T_wrapped &gt; &gt;::<a class="el" href="classsigc_1_1bound__argument.html">bound_argument</a> </td>
  97           <td>(</td>
  98           <td class="paramtype">const <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00906.html">std::reference_wrapper</a>&lt; T_wrapped &gt; &amp;&#160;</td>
  99           <td class="paramname"><em>_A_argument</em></td><td>)</td>
 100           <td></td>
 101         </tr>
 102       </table>
 103   </td>
 104   <td class="mlabels-right">
 105 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 106   </tr>
 107 </table>
 108 </div><div class="memdoc">
 109
 110 <p>Constructor. </p>
 111 <dl class="params"><dt>Parameters</dt><dd>
 112   <table class="params">
 113     <tr><td class="paramname">_A_argument</td><td>The argument to bind. </td></tr>
 114   </table>
 115   </dd>
 116 </dl>
 117
 118 </div>
 119 </div>
 120 <h2 class="groupheader">Member Function Documentation</h2>
 121 <a class="anchor" id="a38950827998907494c25397f01552730"></a>
 122 <div class="memitem">
 123 <div class="memproto">
 124 <div class="memtemplate">
 125 template &lt;class T_wrapped &gt; </div>
 126 <table class="mlabels">
 127   <tr>
 128   <td class="mlabels-left">
 129       <table class="memname">
 130         <tr>
 131           <td class="memname">T_wrapped&amp; <a class="el" href="classsigc_1_1bound__argument.html">sigc::bound_argument</a>&lt; <a class="elRef" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00906.html">std::reference_wrapper</a>&lt; T_wrapped &gt; &gt;::invoke </td>
 132           <td>(</td>
 133           <td class="paramname"></td><td>)</td>
 134           <td></td>
 135         </tr>
 136       </table>
 137   </td>
 138   <td class="mlabels-right">
 139 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 140   </tr>
 141 </table>
 142 </div><div class="memdoc">
 143
 144 <p>Retrieve the entity to pass to the bound functor or return. </p>
 145 <dl class="section return"><dt>Returns</dt><dd>The bound argument. </dd></dl>
 146
 147 </div>
 148 </div>
 149 <a class="anchor" id="ae6a4426ca39736a475bbcc81d7fcd9b2"></a>
 150 <div class="memitem">
 151 <div class="memproto">
 152 <div class="memtemplate">
 153 template &lt;class T_wrapped &gt; </div>
 154 <table class="mlabels">
 155   <tr>
 156   <td class="mlabels-left">
 157       <table class="memname">
 158         <tr>
 159           <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" doxygen="libstdc++.tag:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00906.html">std::reference_wrapper</a>&lt; T_wrapped &gt; &gt;::visit </td>
 160           <td>(</td>
 161           <td class="paramname"></td><td>)</td>
 162           <td> const</td>
 163         </tr>
 164       </table>
 165   </td>
 166   <td class="mlabels-right">
 167 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 168   </tr>
 169 </table>
 170 </div><div class="memdoc">
 171
 172 <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>
 173 <dl class="section return"><dt>Returns</dt><dd>The limited_reference to the bound argument. </dd></dl>
 174
 175 </div>
 176 </div>
 177 </div><!-- contents -->
 178 <!-- start footer part -->
 179 <hr class="footer"/><address class="footer"><small>
 180 Generated on Wed Mar 16 2016 20:53:28 for libsigc++ by &#160;<a href="http://www.doxygen.org/index.html">
 181 <img class="footer" src="doxygen.png" alt="doxygen"/>
 182 </a> 1.8.9.1
 183 </small></address>
 184 </body>
 185 </html>