docs/reference/html/classsigc_1_1bound__argument.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; T_type &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.html">bound_argument</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-members.html">List of all members</a>  </div>
  57   <div class="headertitle">
  58 <div class="title">sigc::bound_argument&lt; T_type &gt; Class Template Reference</div>  </div>
  59 </div><!--header-->
  60 <div class="contents">
  61
  62 <p>A bound_argument&lt;Foo&gt; object stores a bound (for instance, 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...">sigc::bind()</a>, or <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...">sigc::bind_return()</a>) argument.
  63  <a href="classsigc_1_1bound__argument.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:a495bb69a41b38eda5d6ace5a36807a37"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1bound__argument.html#a495bb69a41b38eda5d6ace5a36807a37">bound_argument</a> (const T_type&amp; _A_argument)</td></tr>
  70 <tr class="memdesc:a495bb69a41b38eda5d6ace5a36807a37"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a495bb69a41b38eda5d6ace5a36807a37">More...</a><br /></td></tr>
  71 <tr class="separator:a495bb69a41b38eda5d6ace5a36807a37"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72 <tr class="memitem:af1cf20526bade89328a1ed398055bbba"><td class="memItemLeft" align="right" valign="top">T_type&amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1bound__argument.html#af1cf20526bade89328a1ed398055bbba">invoke</a> ()</td></tr>
  73 <tr class="memdesc:af1cf20526bade89328a1ed398055bbba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the entity to pass to the bound functor or return.  <a href="#af1cf20526bade89328a1ed398055bbba">More...</a><br /></td></tr>
  74 <tr class="separator:af1cf20526bade89328a1ed398055bbba"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75 <tr class="memitem:ae4816ddf9275c55962542dc7bba20397"><td class="memItemLeft" align="right" valign="top">const T_type&amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1bound__argument.html#ae4816ddf9275c55962542dc7bba20397">visit</a> () const </td></tr>
  76 <tr class="memdesc:ae4816ddf9275c55962542dc7bba20397"><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="#ae4816ddf9275c55962542dc7bba20397">More...</a><br /></td></tr>
  77 <tr class="separator:ae4816ddf9275c55962542dc7bba20397"><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_type&gt;<br />
  81 class sigc::bound_argument&lt; T_type &gt;</h3>
  82
  83 <p>A bound_argument&lt;Foo&gt; object stores a bound (for instance, 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...">sigc::bind()</a>, or <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...">sigc::bind_return()</a>) argument. </p>
  84 <p>If Foo is a wrapped reference to a class Bar (std::reference_wrapper&lt;Bar&gt;) then this object is implemented on top of a <a class="el" href="classsigc_1_1limit__reference.html" title="A limit_reference<Foo> object stores a reference (Foo&), but makes sure that, if Foo inherits from si...">limit_reference</a>. When the slot is invoked, the <a class="el" href="classsigc_1_1limit__reference.html#a951ae1d15397406945d4a6b67f30936f" title="Retrieve the reference. ">limit_reference::invoke()</a> method provides the argument (a Bar&amp;). When the slot is visited (e.g. <a class="el" href="group__sigcfunctors.html#ga64cb7832acc1e58efb5ffe0b4f5e9404" title="This function performs a functor on each of the targets of a functor. ">visit_each&lt;&gt;()</a>), we simply visit the <a class="el" href="classsigc_1_1limit__reference.html" title="A limit_reference<Foo> object stores a reference (Foo&), but makes sure that, if Foo inherits from si...">limit_reference</a>, which will visit the derived type, or a <a class="el" href="structsigc_1_1trackable.html" title="Base class for objects with auto-disconnection. ">sigc::trackable</a> base if necessary.</p>
  85 <p>Likewise, If Foo is a wrapped const reference to a class Bar (std::reference_wrapper&lt;const Bar&gt;) then this object is implemented on top of a const_limit_reference.</p>
  86 <p>If Foo is something else (such as an argument that is bound by value) <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> just stores a cop of that value, and both <a class="el" href="classsigc_1_1bound__argument.html#af1cf20526bade89328a1ed398055bbba" title="Retrieve the entity to pass to the bound functor or return. ">invoke()</a> and <a class="el" href="classsigc_1_1bound__argument.html#ae4816ddf9275c55962542dc7bba20397" title="Retrieve the entity to visit in visit_each(). ">visit()</a> simply return it.</p>
  87 <p>This object is used by the bind_functor&lt;&gt; and bind_return_functor&lt;&gt; objects, depending on whether the argument is bound as a parameter or as a return value.</p>
  88 <p>The general template implementation is used for parameters that are passed by value. <em>T_type</em> The type of the bound argument. </p>
  89 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  90 <a class="anchor" id="a495bb69a41b38eda5d6ace5a36807a37"></a>
  91 <div class="memitem">
  92 <div class="memproto">
  93 <div class="memtemplate">
  94 template &lt;class T_type&gt; </div>
  95 <table class="mlabels">
  96   <tr>
  97   <td class="mlabels-left">
  98       <table class="memname">
  99         <tr>
 100           <td class="memname"><a class="el" href="classsigc_1_1bound__argument.html">sigc::bound_argument</a>&lt; T_type &gt;::<a class="el" href="classsigc_1_1bound__argument.html">bound_argument</a> </td>
 101           <td>(</td>
 102           <td class="paramtype">const T_type &amp;&#160;</td>
 103           <td class="paramname"><em>_A_argument</em></td><td>)</td>
 104           <td></td>
 105         </tr>
 106       </table>
 107   </td>
 108   <td class="mlabels-right">
 109 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 110   </tr>
 111 </table>
 112 </div><div class="memdoc">
 113
 114 <p>Constructor. </p>
 115 <dl class="params"><dt>Parameters</dt><dd>
 116   <table class="params">
 117     <tr><td class="paramname">_A_argument</td><td>The argument to bind. </td></tr>
 118   </table>
 119   </dd>
 120 </dl>
 121
 122 </div>
 123 </div>
 124 <h2 class="groupheader">Member Function Documentation</h2>
 125 <a class="anchor" id="af1cf20526bade89328a1ed398055bbba"></a>
 126 <div class="memitem">
 127 <div class="memproto">
 128 <div class="memtemplate">
 129 template &lt;class T_type&gt; </div>
 130 <table class="mlabels">
 131   <tr>
 132   <td class="mlabels-left">
 133       <table class="memname">
 134         <tr>
 135           <td class="memname">T_type&amp; <a class="el" href="classsigc_1_1bound__argument.html">sigc::bound_argument</a>&lt; T_type &gt;::invoke </td>
 136           <td>(</td>
 137           <td class="paramname"></td><td>)</td>
 138           <td></td>
 139         </tr>
 140       </table>
 141   </td>
 142   <td class="mlabels-right">
 143 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 144   </tr>
 145 </table>
 146 </div><div class="memdoc">
 147
 148 <p>Retrieve the entity to pass to the bound functor or return. </p>
 149 <dl class="section return"><dt>Returns</dt><dd>The bound argument. </dd></dl>
 150
 151 </div>
 152 </div>
 153 <a class="anchor" id="ae4816ddf9275c55962542dc7bba20397"></a>
 154 <div class="memitem">
 155 <div class="memproto">
 156 <div class="memtemplate">
 157 template &lt;class T_type&gt; </div>
 158 <table class="mlabels">
 159   <tr>
 160   <td class="mlabels-left">
 161       <table class="memname">
 162         <tr>
 163           <td class="memname">const T_type&amp; <a class="el" href="classsigc_1_1bound__argument.html">sigc::bound_argument</a>&lt; T_type &gt;::visit </td>
 164           <td>(</td>
 165           <td class="paramname"></td><td>)</td>
 166           <td> const</td>
 167         </tr>
 168       </table>
 169   </td>
 170   <td class="mlabels-right">
 171 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 172   </tr>
 173 </table>
 174 </div><div class="memdoc">
 175
 176 <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>
 177 <dl class="section return"><dt>Returns</dt><dd>The bound argument. </dd></dl>
 178
 179 </div>
 180 </div>
 181 </div><!-- contents -->
 182 <!-- start footer part -->
 183 <hr class="footer"/><address class="footer"><small>
 184 Generated on Wed Mar 16 2016 20:53:28 for libsigc++ by &#160;<a href="http://www.doxygen.org/index.html">
 185 <img class="footer" src="doxygen.png" alt="doxygen"/>
 186 </a> 1.8.9.1
 187 </small></address>
 188 </body>
 189 </html>