untracked/docs/reference/html/classsigc_1_1limit__reference_3_01T__type_00_01true_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::limit_reference&lt; T_type, true &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_1limit__reference_3_01T__type_00_01true_01_4.html">limit_reference&lt; T_type, true &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_1limit__reference_3_01T__type_00_01true_01_4-members.html">List of all members</a>  </div>
  50   <div class="headertitle">
  51 <div class="title">sigc::limit_reference&lt; T_type, true &gt; Class Template Reference</div>  </div>
  52 </div><!--header-->
  53 <div class="contents">
  54
  55 <p><a class="el" href="classsigc_1_1limit__reference.html" title="A limit_reference&lt;Foo&gt; object stores a reference (Foo&amp;), but make sure that, if Foo inherits from sig...">limit_reference</a> object for a class that derives from trackable.
  56  <a href="classsigc_1_1limit__reference_3_01T__type_00_01true_01_4.html#details">More...</a></p>
  57
  58 <p><code>#include &lt;sigc++/limit_reference.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:a26ef98ef1f11a4b5891d426e9722c2c8"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1limit__reference_3_01T__type_00_01true_01_4.html#a26ef98ef1f11a4b5891d426e9722c2c8">limit_reference</a> (T_type &amp; _A_target)</td></tr>
  63 <tr class="memdesc:a26ef98ef1f11a4b5891d426e9722c2c8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="classsigc_1_1limit__reference_3_01T__type_00_01true_01_4.html#a26ef98ef1f11a4b5891d426e9722c2c8">More...</a><br /></td></tr>
  64 <tr class="separator:a26ef98ef1f11a4b5891d426e9722c2c8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  65 <tr class="memitem:a6c8067da8b8c15361127ad25efab6903"><td class="memItemLeft" align="right" valign="top">T_type &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1limit__reference_3_01T__type_00_01true_01_4.html#a6c8067da8b8c15361127ad25efab6903">invoke</a> () const</td></tr>
  66 <tr class="memdesc:a6c8067da8b8c15361127ad25efab6903"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the reference.  <a href="classsigc_1_1limit__reference_3_01T__type_00_01true_01_4.html#a6c8067da8b8c15361127ad25efab6903">More...</a><br /></td></tr>
  67 <tr class="separator:a6c8067da8b8c15361127ad25efab6903"><td class="memSeparator" colspan="2">&#160;</td></tr>
  68 <tr class="memitem:a85e56a8140929d71b2bdbd091e348c3a"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structsigc_1_1trackable.html">trackable</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classsigc_1_1limit__reference_3_01T__type_00_01true_01_4.html#a85e56a8140929d71b2bdbd091e348c3a">visit</a> () const</td></tr>
  69 <tr class="memdesc:a85e56a8140929d71b2bdbd091e348c3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieve the entity to visit for <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_1limit__reference_3_01T__type_00_01true_01_4.html#a85e56a8140929d71b2bdbd091e348c3a">More...</a><br /></td></tr>
  70 <tr class="separator:a85e56a8140929d71b2bdbd091e348c3a"><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_type&gt;<br />
  74 class sigc::limit_reference&lt; T_type, true &gt;</h3>
  75
  76 <p><a class="el" href="classsigc_1_1limit__reference.html" title="A limit_reference&lt;Foo&gt; object stores a reference (Foo&amp;), but make sure that, if Foo inherits from sig...">limit_reference</a> object for a class that derives from trackable. </p>
  77 <ul>
  78 <li><em>T_type</em> The type of the reference. </li>
  79 </ul>
  80 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
  81 <a id="a26ef98ef1f11a4b5891d426e9722c2c8"></a>
  82 <h2 class="memtitle"><span class="permalink"><a href="#a26ef98ef1f11a4b5891d426e9722c2c8">&#9670;&#160;</a></span>limit_reference()</h2>
  83
  84 <div class="memitem">
  85 <div class="memproto">
  86 <div class="memtemplate">
  87 template &lt;class T_type &gt; </div>
  88 <table class="mlabels">
  89   <tr>
  90   <td class="mlabels-left">
  91       <table class="memname">
  92         <tr>
  93           <td class="memname"><a class="el" href="classsigc_1_1limit__reference.html">sigc::limit_reference</a>&lt; T_type, true &gt;::<a class="el" href="classsigc_1_1limit__reference.html">limit_reference</a> </td>
  94           <td>(</td>
  95           <td class="paramtype">T_type &amp;&#160;</td>
  96           <td class="paramname"><em>_A_target</em></td><td>)</td>
  97           <td></td>
  98         </tr>
  99       </table>
 100   </td>
 101   <td class="mlabels-right">
 102 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 103   </tr>
 104 </table>
 105 </div><div class="memdoc">
 106
 107 <p>Constructor. </p>
 108 <dl class="params"><dt>Parameters</dt><dd>
 109   <table class="params">
 110     <tr><td class="paramname">_A_target</td><td>The reference to limit. </td></tr>
 111   </table>
 112   </dd>
 113 </dl>
 114
 115 </div>
 116 </div>
 117 <h2 class="groupheader">Member Function Documentation</h2>
 118 <a id="a6c8067da8b8c15361127ad25efab6903"></a>
 119 <h2 class="memtitle"><span class="permalink"><a href="#a6c8067da8b8c15361127ad25efab6903">&#9670;&#160;</a></span>invoke()</h2>
 120
 121 <div class="memitem">
 122 <div class="memproto">
 123 <div class="memtemplate">
 124 template &lt;class T_type &gt; </div>
 125 <table class="mlabels">
 126   <tr>
 127   <td class="mlabels-left">
 128       <table class="memname">
 129         <tr>
 130           <td class="memname">T_type&amp; <a class="el" href="classsigc_1_1limit__reference.html">sigc::limit_reference</a>&lt; T_type, true &gt;::invoke </td>
 131           <td>(</td>
 132           <td class="paramname"></td><td>)</td>
 133           <td> const</td>
 134         </tr>
 135       </table>
 136   </td>
 137   <td class="mlabels-right">
 138 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 139   </tr>
 140 </table>
 141 </div><div class="memdoc">
 142
 143 <p>Retrieve the reference. </p>
 144 <p>This is always a reference to the derived instance. </p><dl class="section return"><dt>Returns</dt><dd>The reference. </dd></dl>
 145
 146 </div>
 147 </div>
 148 <a id="a85e56a8140929d71b2bdbd091e348c3a"></a>
 149 <h2 class="memtitle"><span class="permalink"><a href="#a85e56a8140929d71b2bdbd091e348c3a">&#9670;&#160;</a></span>visit()</h2>
 150
 151 <div class="memitem">
 152 <div class="memproto">
 153 <div class="memtemplate">
 154 template &lt;class T_type &gt; </div>
 155 <table class="mlabels">
 156   <tr>
 157   <td class="mlabels-left">
 158       <table class="memname">
 159         <tr>
 160           <td class="memname">const <a class="el" href="structsigc_1_1trackable.html">trackable</a>&amp; <a class="el" href="classsigc_1_1limit__reference.html">sigc::limit_reference</a>&lt; T_type, true &gt;::visit </td>
 161           <td>(</td>
 162           <td class="paramname"></td><td>)</td>
 163           <td> const</td>
 164         </tr>
 165       </table>
 166   </td>
 167   <td class="mlabels-right">
 168 <span class="mlabels"><span class="mlabel">inline</span></span>  </td>
 169   </tr>
 170 </table>
 171 </div><div class="memdoc">
 172
 173 <p>Retrieve the entity to visit for <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>
 174 <p>Depending on the template specialization, this is either a derived reference, or <a class="el" href="structsigc_1_1trackable.html" title="Base class for objects with auto-disconnection.">sigc::trackable</a>&amp; if T_type derives from <a class="el" href="structsigc_1_1trackable.html" title="Base class for objects with auto-disconnection.">sigc::trackable</a>. </p><dl class="section return"><dt>Returns</dt><dd>The reference. </dd></dl>
 175
 176 </div>
 177 </div>
 178 </div><!-- contents -->
 179 <!-- start footer part -->
 180 <hr class="footer"/><address class="footer"><small>
 181 Generated on Fri Feb 11 2022 15:40:58 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
 182 </small></address>
 183 </body>
 184 </html>